Remove Envelope::ENVELOPE_STACK_KEY

Author: vjik

src/Message/Envelope.php

@@ -4,13 +4,8 @@
 
 namespace Yiisoft\Queue\Message;
 
-use function is_array;
-
 abstract class Envelope implements MessageInterface
 {
-    /** @psalm-suppress MissingClassConstType */
-    final public const ENVELOPE_STACK_KEY = 'envelopes';
-
     /**
      * @psalm-var array<string, mixed>
      */
@@ -20,7 +15,7 @@ abstract class Envelope implements MessageInterface
 
     public function __construct(MessageInterface $message, array $metadata)
     {
-        $this->metadata = $this->prepareMetadata($message->getMetadata(), $metadata);
+        $this->metadata = array_merge($message->getMetadata(), $metadata);
 
         while ($message instanceof self) {
             $message = $message->getMessage();
@@ -54,23 +49,4 @@ final public function getMetadata(): array
     {
         return $this->metadata;
     }
-
-    private function prepareMetadata(array $messageMeta, array $metadata): array
-    {
-        $stack = $messageMeta[self::ENVELOPE_STACK_KEY] ?? [];
-        if (!is_array($stack)) {
-            $stack = [];
-        }
-
-        return array_merge(
-            $messageMeta,
-            [
-                self::ENVELOPE_STACK_KEY => array_merge(
-                    $stack,
-                    [static::class],
-                ),
-            ],
-            $metadata,
-        );
-    }
 }

tests/Unit/EnvelopeTest.php

@@ -5,7 +5,6 @@
 namespace Yiisoft\Queue\Tests\Unit;
 
 use PHPUnit\Framework\TestCase;
-use Yiisoft\Queue\Message\Envelope;
 use Yiisoft\Queue\Message\IdEnvelope;
 use Yiisoft\Queue\Message\Message;
 
@@ -17,14 +16,6 @@ public function testEnvelopeStack(): void
         $message = new IdEnvelope($message, 'test-id');
 
         $this->assertEquals('test', $message->getMessage()->getData());
-
-        $stack = $message->getMetadata()[Envelope::ENVELOPE_STACK_KEY];
-        $this->assertIsArray($stack);
-
-        $this->assertEquals([
-            IdEnvelope::class,
-        ], $stack);
-
         $this->assertEquals('test-id', $message->getMetadata()[IdEnvelope::MESSAGE_ID_KEY]);
     }
 
@@ -36,15 +27,6 @@ public function testEnvelopeDuplicates(): void
         $message = new IdEnvelope($message, 'test-id-3');
 
         $this->assertEquals('test', $message->getMessage()->getData());
-
-        $stack = $message->getMetadata()[Envelope::ENVELOPE_STACK_KEY];
-        $this->assertIsArray($stack);
-        $this->assertEquals([
-            IdEnvelope::class,
-            IdEnvelope::class,
-            IdEnvelope::class,
-        ], $stack);
-
         $this->assertEquals('test-id-3', $message->getMetadata()[IdEnvelope::MESSAGE_ID_KEY]);
     }
 }

tests/Unit/Message/EnvelopeTest.php

@@ -5,9 +5,7 @@
 namespace Yiisoft\Queue\Tests\Unit\Message;
 
 use PHPUnit\Framework\TestCase;
-use Yiisoft\Queue\Message\Envelope;
 use Yiisoft\Queue\Tests\App\DummyEnvelope;
-use Yiisoft\Queue\Message\Message;
 
 final class EnvelopeTest extends TestCase
 {
@@ -25,14 +23,4 @@ public function testFromData(): void
         $this->assertArrayHasKey('meta', $envelope->getMetadata());
         $this->assertSame('data', $envelope->getMetadata()['meta']);
     }
-
-    public function testNonArrayStackIsNormalized(): void
-    {
-        $base = new Message('handler', 'data', [Envelope::ENVELOPE_STACK_KEY => 'oops']);
-        $wrapped = new DummyEnvelope($base);
-
-        $meta = $wrapped->getMetadata();
-        self::assertIsArray($meta[Envelope::ENVELOPE_STACK_KEY]);
-        self::assertSame([DummyEnvelope::class], $meta[Envelope::ENVELOPE_STACK_KEY]);
-    }
 }

tests/Unit/Message/JsonMessageSerializerTest.php

@@ -7,7 +7,6 @@
 use InvalidArgumentException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
-use Yiisoft\Queue\Message\Envelope;
 use Yiisoft\Queue\Message\IdEnvelope;
 use Yiisoft\Queue\Message\JsonMessageSerializer;
 use Yiisoft\Queue\Message\Message;
@@ -134,20 +133,14 @@ public function testUnserializeEnvelopeStack(): void
         $payload = [
             'type' => 'handler',
             'data' => 'test',
-            'meta' => [
-                Envelope::ENVELOPE_STACK_KEY => [
-                    IdEnvelope::class,
-                ],
-            ],
+            'meta' => [],
         ];
         $serializer = $this->createSerializer();
 
         /** @var IdEnvelope $message */
         $message = $serializer->unserialize(json_encode($payload, JSON_THROW_ON_ERROR));
 
         $this->assertEquals($payload['data'], $message->getData());
-        $this->assertEquals([IdEnvelope::class], $message->getMetadata()[Envelope::ENVELOPE_STACK_KEY]);
-
         $this->assertInstanceOf(Message::class, $message);
     }
 
@@ -176,8 +169,7 @@ public function testSerializeEnvelopeStack(): void
 
         $this->assertEquals(
             sprintf(
-                '{"type":"handler","data":"test","meta":{"envelopes":["%s"],"%s":"test-id","message-class":"%s"}}',
-                str_replace('\\', '\\\\', IdEnvelope::class),
+                '{"type":"handler","data":"test","meta":{"%s":"test-id","message-class":"%s"}}',
                 IdEnvelope::MESSAGE_ID_KEY,
                 str_replace('\\', '\\\\', Message::class),
             ),
@@ -188,9 +180,6 @@ public function testSerializeEnvelopeStack(): void
 
         $this->assertInstanceOf(Message::class, $message);
         $this->assertEquals([
-            Envelope::ENVELOPE_STACK_KEY => [
-                IdEnvelope::class,
-            ],
             IdEnvelope::MESSAGE_ID_KEY => 'test-id',
             'message-class' => Message::class,
         ], $message->getMetadata());