Merge pull request #31 from daniellienert/task/set-types

!!! TASK: Add (return) type hints to all public methods

Author: daniellienert

Classes/Job/JobInterface.php

@@ -11,7 +11,6 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
 use Flowpack\JobQueue\Common\Queue\Message;
 use Flowpack\JobQueue\Common\Queue\QueueInterface;
 
@@ -27,14 +26,14 @@ interface JobInterface
      *
      * @param QueueInterface $queue
      * @param Message $message The original message
-     * @return boolean TRUE if the job was executed successfully and the message should be finished
+     * @return bool TRUE if the job was executed successfully and the message should be finished
      */
-    public function execute(QueueInterface $queue, Message $message);
+    public function execute(QueueInterface $queue, Message $message): bool;
 
     /**
      * Get a readable label for the job
      *
      * @return string A label for the job
      */
-    public function getLabel();
+    public function getLabel(): string;
 }

Classes/Job/JobManager.php

@@ -66,7 +66,7 @@ class JobManager
      * @return void
      * @api
      */
-    public function queue($queueName, JobInterface $job, array $options = [])
+    public function queue(string $queueName, JobInterface $job, array $options = []): void
     {
         $queue = $this->queueManager->getQueue($queueName);
 
@@ -85,7 +85,7 @@ public function queue($queueName, JobInterface $job, array $options = [])
      * @throws \Exception
      * @api
      */
-    public function waitAndExecute($queueName, $timeout = null)
+    public function waitAndExecute(string $queueName, $timeout = null): ?Message
     {
         $queue = $this->queueManager->getQueue($queueName);
         $message = $queue->waitAndReserve($timeout);
@@ -133,7 +133,7 @@ public function waitAndExecute($queueName, $timeout = null)
      * @throws JobQueueException
      * @internal This method has to be public so that it can be run from the command handler (when "executeIsolated" is set). It is not meant to be called from "user land"
      */
-    public function executeJobForMessage(QueueInterface $queue, Message $message)
+    public function executeJobForMessage(QueueInterface $queue, Message $message): void
     {
         // TODO stabilize unserialize() call (maybe using PHPs unserialize_callback_func directive)
         $job = unserialize($message->getPayload());
@@ -153,7 +153,7 @@ public function executeJobForMessage(QueueInterface $queue, Message $message)
      * @return JobInterface[]
      * @api
      */
-    public function peek($queueName, $limit = 1)
+    public function peek(string $queueName, int $limit = 1): array
     {
         $queue = $this->queueManager->getQueue($queueName);
         $messages = $queue->peek($limit);
@@ -174,7 +174,7 @@ public function peek($queueName, $limit = 1)
      * @Flow\Signal
      * @api
      */
-    protected function emitMessageSubmitted(QueueInterface $queue, $messageId, $payload, array $options = [])
+    protected function emitMessageSubmitted(QueueInterface $queue, $messageId, $payload, array $options = []): void
     {
     }
 
@@ -186,7 +186,7 @@ protected function emitMessageSubmitted(QueueInterface $queue, $messageId, $payl
      * @Flow\Signal
      * @api
      */
-    protected function emitMessageTimeout(QueueInterface $queue)
+    protected function emitMessageTimeout(QueueInterface $queue): void
     {
     }
 
@@ -199,7 +199,7 @@ protected function emitMessageTimeout(QueueInterface $queue)
      * @Flow\Signal
      * @api
      */
-    protected function emitMessageReserved(QueueInterface $queue, Message $message)
+    protected function emitMessageReserved(QueueInterface $queue, Message $message): void
     {
     }
 
@@ -212,7 +212,7 @@ protected function emitMessageReserved(QueueInterface $queue, Message $message)
      * @Flow\Signal
      * @api
      */
-    protected function emitMessageFinished(QueueInterface $queue, Message $message)
+    protected function emitMessageFinished(QueueInterface $queue, Message $message): void
     {
     }
 
@@ -227,7 +227,7 @@ protected function emitMessageFinished(QueueInterface $queue, Message $message)
      * @Flow\Signal
      * @api
      */
-    protected function emitMessageReleased(QueueInterface $queue, Message $message, array $releaseOptions, \Exception $jobExecutionException = null)
+    protected function emitMessageReleased(QueueInterface $queue, Message $message, array $releaseOptions, \Exception $jobExecutionException = null): void
     {
     }
 
@@ -241,7 +241,7 @@ protected function emitMessageReleased(QueueInterface $queue, Message $message,
      * @Flow\Signal
      * @api
      */
-    protected function emitMessageFailed(QueueInterface $queue, Message $message, \Exception $jobExecutionException = null)
+    protected function emitMessageFailed(QueueInterface $queue, Message $message, \Exception $jobExecutionException = null): void
     {
     }
 

Classes/Job/StaticMethodCallJob.php

@@ -16,7 +16,6 @@
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Flowpack\JobQueue\Common\Queue\Message;
 use Flowpack\JobQueue\Common\Queue\QueueInterface;
-use Neos\Utility\TypeHandling;
 
 /**
  * Static method call job
@@ -73,7 +72,7 @@ public function __construct($className, $methodName, array $arguments)
      * @return boolean TRUE If the execution was successful
      * @throws \Exception
      */
-    public function execute(QueueInterface $queue, Message $message)
+    public function execute(QueueInterface $queue, Message $message): bool
     {
         $service = $this->objectManager->get($this->className);
         $this->deferMethodCallAspect->setProcessingJob(true);
@@ -91,7 +90,7 @@ public function execute(QueueInterface $queue, Message $message)
     /**
      * @return string
      */
-    public function getLabel()
+    public function getLabel(): string
     {
         $arguments = array_map([VariableDumper::class, 'dumpValue'], $this->arguments);
         return sprintf('%s::%s(%s)', $this->className, $this->methodName, implode(', ', $arguments));

Classes/Queue/FakeQueue.php

@@ -49,7 +49,7 @@ class FakeQueue implements QueueInterface
      * @param string $name
      * @param array $options
      */
-    public function __construct($name, array $options = [])
+    public function __construct(string $name, array $options = [])
     {
         $this->name = $name;
         if (isset($options['async']) && $options['async'] === true) {
@@ -60,7 +60,7 @@ public function __construct($name, array $options = [])
     /**
      * @inheritdoc
      */
-    public function setUp()
+    public function setUp(): void
     {
         // The FakeQueue does not require any setup but we use it to verify the options
         if ($this->async && !method_exists(Scripts::class, 'executeCommandAsync')) {
@@ -71,15 +71,15 @@ public function setUp()
     /**
      * @inheritdoc
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
     /**
      * @inheritdoc
      */
-    public function submit($payload, array $options = [])
+    public function submit($payload, array $options = []): string
     {
         $messageId = Algorithms::generateUUID();
         $message = new Message($messageId, $payload);
@@ -98,47 +98,48 @@ public function submit($payload, array $options = [])
     /**
      * @inheritdoc
      */
-    public function waitAndTake($timeout = null)
+    public function waitAndTake(int $timeout = null): Message
     {
         throw new \BadMethodCallException('The FakeQueue does not support reserving of messages.' . chr(10) . 'It is not required to use a worker for this queue as messages are handled immediately upon submission.', 1468425275);
     }
 
     /**
      * @inheritdoc
      */
-    public function waitAndReserve($timeout = null)
+    public function waitAndReserve(int $timeout = null): Message
     {
         throw new \BadMethodCallException('The FakeQueue does not support reserving of messages.' . chr(10) . 'It is not required to use a worker for this queue as messages are handled immediately upon submission.', 1468425280);
     }
 
     /**
      * @inheritdoc
      */
-    public function release($messageId, array $options = [])
+    public function release(string $messageId, array $options = []): void
     {
         throw new \BadMethodCallException('The FakeQueue does not support releasing of failed messages.' . chr(10) . 'The "maximumNumberOfReleases" setting should be removed or set to 0 for this queue!', 1468425285);
     }
 
     /**
      * @inheritdoc
      */
-    public function abort($messageId)
+    public function abort(string $messageId): void
     {
         // The FakeQueue does not support message abortion
     }
 
     /**
      * @inheritdoc
      */
-    public function finish($messageId)
+    public function finish(string $messageId): bool
     {
         // The FakeQueue does not support message finishing
+        return false;
     }
 
     /**
      * @inheritdoc
      */
-    public function peek($limit = 1)
+    public function peek(int $limit = 1): array
     {
         return [];
     }
@@ -170,7 +171,7 @@ public function countFailed(): int
     /**
      * @inheritdoc
      */
-    public function flush()
+    public function flush(): void
     {
         // The FakeQueue does not support message flushing
     }

Classes/Queue/Message.php

@@ -11,8 +11,6 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
-
 /**
  * A DTO that wraps arbitrary payload with an identifier and a counter for failures.
  */
@@ -45,7 +43,7 @@ class Message
      * @param mixed $payload
      * @param integer $numberOfReleases
      */
-    public function __construct($identifier, $payload, $numberOfReleases = 0)
+    public function __construct(string $identifier, $payload, int $numberOfReleases = 0)
     {
         $this->identifier = $identifier;
         $this->payload = $payload;
@@ -55,7 +53,7 @@ public function __construct($identifier, $payload, $numberOfReleases = 0)
     /**
      * @return string
      */
-    public function getIdentifier()
+    public function getIdentifier(): string
     {
         return $this->identifier;
     }
@@ -69,10 +67,10 @@ public function getPayload()
     }
 
     /**
-     * @return integer
+     * @return int
      */
-    public function getNumberOfReleases()
+    public function getNumberOfReleases(): int
     {
         return $this->numberOfReleases;
     }
-}
+}

Classes/Queue/QueueInterface.php

@@ -11,8 +11,6 @@
  * source code.
  */
 
-use Neos\Flow\Annotations as Flow;
-
 /**
  * Message queue interface
  */
@@ -21,14 +19,14 @@ interface QueueInterface
     /**
      * @return void
      */
-    public function setUp();
+    public function setUp(): void;
 
     /**
      * The unique name of this queue
      *
      * @return string
      */
-    public function getName();
+    public function getName(): string;
 
     /**
      * Submit a message to the queue
@@ -37,17 +35,17 @@ public function getName();
      * @param array $options Simple key/value array with options, supported options depend on the queue implementation
      * @return string The identifier of the message under which it was queued
      */
-    public function submit($payload, array $options = []);
+    public function submit($payload, array $options = []): string;
 
     /**
      * Wait for a message in the queue and remove the message from the queue for processing
      * If a non-null value was returned, the message was not queued. Otherwise a timeout
      * occurred and no message was available or received.
      *
-     * @param integer $timeout
+     * @param int $timeout
      * @return Message The received message or NULL if a timeout occurred
      */
-    public function waitAndTake($timeout = null);
+    public function waitAndTake(?int $timeout = null): ?Message;
 
     /**
      * Wait for a message in the queue and reserve the message for processing
@@ -57,10 +55,10 @@ public function waitAndTake($timeout = null);
      * If a non-null value was returned, the message was reserved. Otherwise a timeout
      * occurred and no message was available or received.
      *
-     * @param integer $timeout
+     * @param int $timeout
      * @return Message The received message or NULL if a timeout occurred
      */
-    public function waitAndReserve($timeout = null);
+    public function waitAndReserve(?int $timeout = null): ?Message;
 
     /**
      * Puts a reserved message back to the queue
@@ -69,15 +67,15 @@ public function waitAndReserve($timeout = null);
      * @param array $options Simple key/value array with options that can be interpreted by the concrete implementation (optional)
      * @return void
      */
-    public function release($messageId, array $options = []);
+    public function release(string $messageId, array $options = []): void;
 
     /**
      * Removes a message from the active queue and marks it failed (bury)
      *
      * @param string $messageId
      * @return void
      */
-    public function abort($messageId);
+    public function abort(string $messageId): void;
 
     /**
      * Mark a message as done
@@ -86,9 +84,9 @@ public function abort($messageId);
      * processed successfully.
      *
      * @param string $messageId
-     * @return boolean TRUE if the message could be removed
+     * @return bool TRUE if the message could be removed
      */
-    public function finish($messageId);
+    public function finish(string $messageId): bool;
 
     /**
      * Peek for messages
@@ -99,7 +97,7 @@ public function finish($messageId);
      * @param integer $limit
      * @return Message[] The messages up to the length of limit or an empty array if no messages are present currently
      */
-    public function peek($limit = 1);
+    public function peek(int $limit = 1): array;
 
     /**
      * Get a count of ready messages currently in the queue.
@@ -130,5 +128,5 @@ public function countFailed(): int;
      *
      * @return void
      */
-    public function flush();
+    public function flush(): void;
 }