Narrow message metadata type to array<string, mixed>

Author: vjik

src/Message/Envelope.php

@@ -8,6 +8,9 @@
 
 abstract class Envelope implements EnvelopeInterface
 {
+    /**
+     * @psalm-var array<string, mixed>|null
+     */
     private ?array $metadata = null;
 
     public function __construct(protected MessageInterface $message) {}

src/Message/IdEnvelope.php

@@ -22,13 +22,11 @@ public function __construct(
 
     public static function fromMessage(MessageInterface $message): static
     {
-        /** @var mixed $rawId */
         $rawId = $message->getMetadata()[self::MESSAGE_ID_KEY] ?? null;
 
-        /** @var int|string|null $id */
         $id = match (true) {
             $rawId === null => null, // don't remove this branch: it's important for compute speed
-            is_string($rawId) => $rawId,
+            is_string($rawId),
             is_int($rawId) => $rawId,
             is_object($rawId) && method_exists($rawId, '__toString') => (string) $rawId,
             default => null,

src/Message/Message.php

@@ -10,6 +10,8 @@ final class Message implements MessageInterface
      * @param string $type A message type used to resolve the handler.
      * @param mixed $data Message data, encodable by a queue adapter
      * @param array $metadata Message metadata, encodable by a queue adapter
+     *
+     * @psalm-param array<string, mixed> $metadata
      */
     public function __construct(
         private readonly string $type,

src/Message/MessageInterface.php

@@ -19,7 +19,9 @@ public function getType(): string;
     public function getData(): mixed;
 
     /**
-     * Returns message metadata: timings, attempts count, metrics, etc.
+     * Returns message metadata: timings, attempts count, metrics, etc. Keys are always strings.
+     *
+     * @return array<string, mixed>
      */
     public function getMetadata(): array;
 }

src/Queue.php

@@ -96,7 +96,6 @@ public function push(MessageInterface $message): MessageInterface
             return $message;
         }
 
-        /** @var string $messageId */
         $messageId = $message->getMetadata()[IdEnvelope::MESSAGE_ID_KEY] ?? 'null';
         $this->logger->info(
             'Pushed message with message type "{messageType}" to the queue. Assigned ID #{id}.',