refactor: more type hinting (still wip)

Author: Niktux

README.md

@@ -131,6 +131,7 @@ BC Breaks changelog
 
  - Drop support for php 5.6 & 7.0
  - Worker now catch Throwable, not only Exceptions
+ - WritableMessage::packAttributes now only accept timestamp or null (not false anymore)
 
 **3.x -> 4.x**
 

features/bootstrap/ConsumeContext.php

@@ -78,7 +78,7 @@ function() {
         $consumer->consume($processor, $this->client, $workerContext);
     }
 
-    public function process(ReadableMessage $message)
+    public function process(ReadableMessage $message): void
     {
         $this->consumedMessages[] = $message;
     }

src/Consumer.php

@@ -8,7 +8,7 @@
 
 interface Consumer extends LoggerAwareInterface
 {
-    const
+    public const
         DEFAULT_MAX_EXECUTION_TIME = 3600; //in seconds
 
     public function consume(ProcessorInterface $processor, Client $client, WorkerContext $workerContext);

src/MessageMetadata.php

@@ -4,27 +4,18 @@
 
 interface MessageMetadata
 {
-    const
+    public const
         TRANSIENT = 1,
         PERSISTENT = 2;
 
-    /**
-     * @return string
-     */
-    public function getRoutingKey();
+    public function getRoutingKey(): string;
 
-    /**
-     * @return string
-     */
-    public function getContentType();
+    public function getContentType(): string;
 
-    /**
-     * @return array
-     */
-    public function getHeaders();
+    public function getHeaders(): array;
 
     /**
      * @return mixed
      */
-    public function getAttribute($attributeName);
+    public function getAttribute(string $attributeName);
 }

src/Messages/BodySetter.php

@@ -8,6 +8,7 @@
 use Puzzle\AMQP\Messages\Chunks\ChunkSize;
 use Puzzle\AMQP\Messages\Bodies\StreamedFile;
 use Puzzle\AMQP\Messages\Bodies\StreamedBinary;
+use Puzzle\AMQP\WritableMessage;
 
 trait BodySetter
 {
@@ -53,5 +54,5 @@ public function setStreamedBinary($content, ChunkSize $size)
         return $this;
     }
 
-    abstract public function setBody(Body $body);
+    abstract public function setBody(Body $body): WritableMessage;
 }

src/Messages/Message.php

@@ -6,10 +6,12 @@
 use Puzzle\AMQP\WritableMessage;
 use Puzzle\AMQP\Messages\Bodies\NullBody;
 use Puzzle\Pieces\ConvertibleToString;
+use Puzzle\Pieces\Exceptions\JsonEncodeError;
+use Puzzle\Pieces\Json;
 
 class Message implements WritableMessage, ConvertibleToString
 {
-    const
+    public const
         ATTRIBUTE_CONTENT_TYPE = 'content_type';
 
     use BodySetter;
@@ -22,7 +24,7 @@ class Message implements WritableMessage, ConvertibleToString
         $headers,
         $attributes;
 
-    public function __construct($routingKey = '')
+    public function __construct(string $routingKey = '')
     {
         $this->body = new NullBody();
 
@@ -35,38 +37,38 @@ public function __construct($routingKey = '')
         $this->changeRoutingKey($routingKey);
     }
 
-    public function changeRoutingKey($routingKey)
+    public function changeRoutingKey(string $routingKey): void
     {
         $this->setAttribute('routing_key', $routingKey);
     }
 
-    private function initializeAttributes()
+    private function initializeAttributes(): void
     {
         $this->attributes = array(
             'routing_key' => null,
             self::ATTRIBUTE_CONTENT_TYPE=> $this->getContentType(),
             'content_encoding' => 'utf8',
-            'message_id' => function($timestamp) {
+            'message_id' => function(int $timestamp) {
                 return sha1($this->getRoutingKey() . $timestamp . $this->generateBodyId() . mt_rand());
             },
             'user_id' => null,
             'app_id' => null,
             'delivery_mode' => self::PERSISTENT,
             'priority' => null,
-            'timestamp' => function($timestamp) {
+            'timestamp' => function(int $timestamp) {
                 return $timestamp;
             },
             'expiration' => null,
             'type' => null,
             'reply_to' => null,
             'correlation_id' => null,
-            'headers' => function($timestamp) {
+            'headers' => function(int $timestamp) {
                 return $this->packHeaders($timestamp);
             },
         );
     }
 
-    private function generateBodyId()
+    private function generateBodyId(): string
     {
         if($this->body instanceof Footprintable)
         {
@@ -76,19 +78,19 @@ private function generateBodyId()
         return uniqid(true);
     }
 
-    public function canBeDroppedSilently()
+    public function canBeDroppedSilently(): bool
     {
         return $this->canBeDroppedSilently;
     }
 
-    public function disallowSilentDropping()
+    public function disallowSilentDropping(): WritableMessage
     {
         $this->canBeDroppedSilently = false;
 
         return $this;
     }
 
-    public function getContentType()
+    public function getContentType(): string
     {
         if($this->userContentType === null)
         {
@@ -98,37 +100,37 @@ public function getContentType()
         return $this->userContentType;
     }
 
-    public function getRoutingKey()
+    public function getRoutingKey(): string
     {
-        return $this->getAttribute('routing_key');
+        return (string) $this->getAttribute('routing_key');
     }
 
     public function getBodyInTransportFormat()
     {
         return $this->body->asTransported();
     }
 
-    public function setBody(Body $body)
+    public function setBody(Body $body): WritableMessage
     {
         $this->body = $body;
         $this->updateContentType();
 
         return $this;
     }
 
-    private function updateContentType()
+    private function updateContentType(): void
     {
         $this->attributes[self::ATTRIBUTE_CONTENT_TYPE] = $this->getContentType();
     }
 
-    public function addHeader($headerName, $value)
+    public function addHeader(string $headerName, $value): WritableMessage
     {
         $this->headers[$headerName] = $value;
 
         return $this;
     }
 
-    public function addHeaders(array $headers)
+    public function addHeaders(array $headers): WritableMessage
     {
         foreach($headers as $name => $value)
         {
@@ -138,18 +140,18 @@ public function addHeaders(array $headers)
         return $this;
     }
 
-    public function setAuthor($author)
+    public function setAuthor(string $author): WritableMessage
     {
         $this->addHeader('author', $author);
 
         return $this;
     }
 
-    public function packAttributes($timestamp = false)
+    public function packAttributes(?int $timestamp = null): array
     {
         $this->updateContentType();
 
-        if($timestamp === false)
+        if($timestamp === null)
         {
             $timestamp = (new \DateTime("now"))->getTimestamp();
         }
@@ -166,14 +168,14 @@ public function packAttributes($timestamp = false)
         }, $this->attributes);
     }
 
-    private function packHeaders($timestamp)
+    private function packHeaders(int $timestamp): array
     {
         $this->headers['message_datetime'] = date('Y-m-d H:i:s', $timestamp);
 
         return $this->headers;
     }
 
-    public function setAttribute($attributeName, $value)
+    public function setAttribute(string $attributeName, $value): WritableMessage
     {
         if($attributeName !== 'headers')
         {
@@ -191,14 +193,14 @@ public function setAttribute($attributeName, $value)
         return $this;
     }
 
-    public function getHeaders()
+    public function getHeaders(): array
     {
         $attributes = $this->packAttributes();
 
         return $attributes['headers'];
     }
 
-    public function getAttribute($attributeName)
+    public function getAttribute(string $attributeName)
     {
         if(array_key_exists($attributeName, $this->attributes))
         {
@@ -208,17 +210,23 @@ public function getAttribute($attributeName)
         throw new InvalidArgumentException(sprintf('Property "%s" is unknown or is not a message property', $attributeName));
     }
 
-    public function __toString()
+    public function __toString(): string
     {
-        return json_encode(array(
-            'routing_key' => $this->getRoutingKey(),
-            'body' => (string) $this->body,
-            'attributes' => $this->attributes,
-            'can be dropped silently' => $this->canBeDroppedSilently
-        ));
+        try {
+            return (string) Json::encode([
+                'routing_key' => $this->getRoutingKey(),
+                'body' => (string) $this->body,
+                'attributes' => $this->attributes,
+                'can be dropped silently' => $this->canBeDroppedSilently
+            ]);
+        }
+        catch(JsonEncodeError $e)
+        {
+            return sprintf('Can\'t json encode the message. error: "%s"', $e->getMessage());
+        }
     }
 
-    public function setExpiration($expirationInSeconds)
+    public function setExpiration(int $expirationInSeconds): WritableMessage
     {
         $ttlInMs = 1000 * (int) $expirationInSeconds;
 
@@ -227,19 +235,19 @@ public function setExpiration($expirationInSeconds)
         return $this;
     }
 
-    public function isCompressionAllowed()
+    public function isCompressionAllowed(): bool
     {
         return $this->allowCompression;
     }
 
-    public function allowCompression($allow = true)
+    public function allowCompression(bool $allow = true): WritableMessage
     {
         $this->allowCompression = (bool) $allow;
 
         return $this;
     }
 
-    public function isChunked()
+    public function isChunked(): bool
     {
         return $this->body->isChunked();
     }

src/ReadableMessage.php

@@ -2,6 +2,8 @@
 
 namespace Puzzle\AMQP;
 
+use Puzzle\AMQP\Consumers\Retry;
+
 interface ReadableMessage extends MessageMetadata
 {
     /**
@@ -13,29 +15,10 @@ public function getBodyInOriginalFormat();
      * @return mixed
      */
     public function getBodyAsTransported();
+    public function getAppId(): string;
+    public function getAttributes(): array;
+    public function isLastRetry(int $retryOccurence = Retry::DEFAULT_RETRY_OCCURENCE): bool;
+    public function getRoutingKeyFromHeader(): ?string;
 
-    /**
-     * @return string
-     */
-    public function getAppId();
-
-    /**
-     * @return array
-     */
-    public function getAttributes();
-    
-    /**
-     * @return boolean
-     */
-    public function isLastRetry();
-    
-    /**
-     *  @return string
-     */
-    public function getRoutingKeyFromHeader();
-
-    /**
-     * @return \Puzzle\AMQP\WritableMessage
-     */
-    public function cloneIntoWritableMessage(WritableMessage $writable, $copyRoutingKey = false);
+    public function cloneIntoWritableMessage(WritableMessage $writable, bool $copyRoutingKey = false): WritableMessage;
 }