FEATURE: Extend the QueueInterface with countReserved and countFailed

Also add countReady() and deprecate the count() command
to clearify the interface

Author: daniellienert

Classes/Command/QueueCommandController.php

@@ -11,9 +11,11 @@
  * source code.
  */
 
+use Flowpack\JobQueue\Common\Exception;
 use Flowpack\JobQueue\Common\Queue\QueueManager;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cli\CommandController;
+use Neos\Flow\Mvc\Exception\StopActionException;
 use Neos\Utility\TypeHandling;
 
 /**
@@ -40,14 +42,15 @@ class QueueCommandController extends CommandController
      * Displays all configured queues, their type and the number of messages that are ready to be processed.
      *
      * @return void
+     * @throws Exception
      */
     public function listCommand()
     {
         $rows = [];
         foreach ($this->queueConfigurations as $queueName => $queueConfiguration) {
             $queue = $this->queueManager->getQueue($queueName);
             try {
-                $numberOfMessages = $queue->count();
+                $numberOfMessages = $queue->countReady();
             } catch (\Exception $e) {
                 $numberOfMessages = '-';
             }
@@ -63,6 +66,7 @@ public function listCommand()
      *
      * @param string $queue Name of the queue to describe (e.g. "some-queue")
      * @return void
+     * @throws Exception
      */
     public function describeCommand($queue)
     {
@@ -83,6 +87,8 @@ public function describeCommand($queue)
      *
      * @param string $queue Name of the queue to initialize (e.g. "some-queue")
      * @return void
+     * @throws Exception
+     * @throws StopActionException
      */
     public function setupCommand($queue)
     {
@@ -106,6 +112,8 @@ public function setupCommand($queue)
      * @param string $queue Name of the queue to flush (e.g. "some-queue")
      * @param bool $force This flag is required in order to avoid accidental flushes
      * @return void
+     * @throws Exception
+     * @throws StopActionException
      */
     public function flushCommand($queue, $force = false)
     {
@@ -134,6 +142,7 @@ public function flushCommand($queue, $force = false)
      * @param string $payload Arbitrary payload, for example a serialized instance of a class implementing JobInterface
      * @param string $options JSON encoded, for example '{"some-option": "some-value"}'
      * @return void
+     * @throws Exception
      */
     public function submitCommand($queue, $payload, $options = null)
     {

Classes/Queue/FakeQueue.php

@@ -146,7 +146,31 @@ public function peek($limit = 1)
     /**
      * @inheritdoc
      */
-    public function count()
+    public function count():int
+    {
+        return $this->countReady();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function countReady(): int
+    {
+        return 0;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function countReserved(): int
+    {
+        return 0;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function countFailed(): int
     {
         return 0;
     }

Classes/Queue/QueueInterface.php

@@ -102,13 +102,33 @@ public function finish($messageId);
     public function peek($limit = 1);
 
     /**
-     * Count ready messages in the queue
+     * Get a count of ready messages currently in the queue.
      *
-     * Get a count of messages currently in the queue.
+     * @return int The number of ready messages in the queue
+     * @deprecated Will be removed with the next major. Use countReady instead.
+     */
+    public function count(): int;
+
+    /**
+     * Get a count of ready messages currently in the queue.
+     *
+     * @return int The number of ready messages in the queue
+     */
+    public function countReady(): int;
+
+    /**
+     * Get a count of reserved messages currently in the queue.
+     *
+     * @return int The number of reserved messages in the queue
+     */
+    public function countReserved(): int;
+
+    /**
+     * Get a count of failed messages currently in the queue.
      *
-     * @return integer The number of messages in the queue
+     * @return int The number of failed messages in the queue
      */
-    public function count();
+    public function countFailed(): int;
 
     /**
      * Removes all messages from this queue
@@ -119,4 +139,4 @@ public function count();
      * @return void
      */
     public function flush();
-}
+}

Tests/Functional/AbstractQueueTest.php

@@ -144,10 +144,10 @@ public function releasePutsMessageBackToQueue()
         $messageId = $this->queue->submit('A message');
 
         $this->queue->waitAndReserve(1);
-        $this->assertSame(0, $this->queue->count());
+        $this->assertSame(0, $this->queue->countReady());
 
         $this->queue->release($messageId);
-        $this->assertSame(1, $this->queue->count());
+        $this->assertSame(1, $this->queue->countReady());
     }
 
     /**
@@ -179,16 +179,32 @@ public function abortRemovesMessageFromActiveQueue()
         $this->queue->waitAndReserve(1);
 
         $this->queue->abort($messageId);
-        $this->assertSame(0, $this->queue->count());
+        $this->assertSame(0, $this->queue->countReady());
         $this->assertNull($this->queue->waitAndTake(1));
     }
 
     /**
      * @test
      */
-    public function countReturnsZeroByDefault()
+    public function countReadyReturnsZeroByDefault()
     {
-        $this->assertSame(0, $this->queue->count());
+        $this->assertSame(0, $this->queue->countReady());
+    }
+
+    /**
+     * @test
+     */
+    public function countFailedReturnsZeroByDefault()
+    {
+        $this->assertSame(0, $this->queue->countFailed());
+    }
+
+    /**
+     * @test
+     */
+    public function countReservedReturnsZeroByDefault()
+    {
+        $this->assertSame(0, $this->queue->countReserved());
     }
 
     /**
@@ -199,6 +215,6 @@ public function countReturnsNumberOfReadyJobs()
         $this->queue->submit('First message');
         $this->queue->submit('Second message');
 
-        $this->assertSame(2, $this->queue->count());
+        $this->assertSame(2, $this->queue->countReady());
     }
-}
+}

Tests/Unit/Fixtures/TestQueue.php

@@ -30,13 +30,18 @@ class TestQueue implements QueueInterface
     /**
      * @var string[]
      */
-    protected $processingMessages = [];
+    protected $reservedMessages = [];
 
     /**
      * @var string[]
      */
     protected $failedMessages = [];
 
+    /**
+     * @var string[]
+     */
+    protected $processingMessages = [];
+
     /**
      * @var int[]
      */
@@ -205,11 +210,35 @@ public function peek($limit = 1)
     /**
      * @inheritdoc
      */
-    public function count()
+    public function count(): int
+    {
+        return $this->countReady();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function countReady():int
     {
         return count($this->readyMessages);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function countReserved(): int
+    {
+        return count($this->reservedMessages);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function countFailed(): int
+    {
+        return count($this->failedMessages);
+    }
+
     /**
      * @inheritdoc
      */