[Messenger] collect all stamps added on Envelope as collections

symfony · Nov 9, 2018 · e75340b · e75340b
1 parent 99856a9
commit e75340b
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 35 deletions.
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -33,6 +33,7 @@ CHANGELOG
  * `ActivationMiddlewareDecorator` has been renamed `ActivationMiddleware`
  * `AllowNoHandlerMiddleware` has been removed in favor of a new constructor argument on `HandleMessageMiddleware`
  * The `ContainerHandlerLocator`, `AbstractHandlerLocator`, `SenderLocator` and `AbstractSenderLocator` classes have been removed
+ * `Envelope::all()` takes a new optional `$stampFqcn` argument and returns the stamps for the specified FQCN, or all stamps by their class name
 
 4.1.0
 -----

diff --git a/src/Symfony/Component/Messenger/Envelope.php b/src/Symfony/Component/Messenger/Envelope.php
@@ -36,7 +36,7 @@ public function __construct($message, StampInterface ...$stamps)
         $this->message = $message;
 
         foreach ($stamps as $stamp) {
-            $this->stamps[\get_class($stamp)] = $stamp;
+            $this->stamps[\get_class($stamp)][] = $stamp;
         }
     }
 
@@ -48,22 +48,26 @@ public function with(StampInterface ...$stamps): self
         $cloned = clone $this;
 
         foreach ($stamps as $stamp) {
-            $cloned->stamps[\get_class($stamp)] = $stamp;
+            $cloned->stamps[\get_class($stamp)][] = $stamp;
         }
 
         return $cloned;
     }
 
     public function get(string $stampFqcn): ?StampInterface
     {
-        return $this->stamps[$stampFqcn] ?? null;
+        return isset($this->stamps[$stampFqcn]) ? end($this->stamps[$stampFqcn]) : null;
     }
 
     /**
-     * @return StampInterface[] indexed by fqcn
+     * @return StampInterface[]|StampInterface[][] The stamps for the specified FQCN, or all stamps by their class name
      */
-    public function all(): array
+    public function all(string $stampFqcn = null): array
     {
+        if (null !== $stampFqcn) {
+            return $this->stamps[$stampFqcn] ?? array();
+        }
+
         return $this->stamps;
     }
 

diff --git a/src/Symfony/Component/Messenger/Tests/EnvelopeTest.php b/src/Symfony/Component/Messenger/Tests/EnvelopeTest.php
@@ -29,7 +29,7 @@ public function testConstruct()
 
         $this->assertSame($dummy, $envelope->getMessage());
         $this->assertArrayHasKey(ReceivedStamp::class, $stamps = $envelope->all());
-        $this->assertSame($receivedStamp, $stamps[ReceivedStamp::class]);
+        $this->assertSame($receivedStamp, $stamps[ReceivedStamp::class][0]);
     }
 
     public function testWithReturnsNewInstance()
@@ -57,8 +57,8 @@ public function testAll()
 
         $stamps = $envelope->all();
         $this->assertArrayHasKey(ReceivedStamp::class, $stamps);
-        $this->assertSame($receivedStamp, $stamps[ReceivedStamp::class]);
+        $this->assertSame($receivedStamp, $stamps[ReceivedStamp::class][0]);
         $this->assertArrayHasKey(ValidationStamp::class, $stamps);
-        $this->assertSame($validationStamp, $stamps[ValidationStamp::class]);
+        $this->assertSame($validationStamp, $stamps[ValidationStamp::class][0]);
     }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php b/src/Symfony/Component/Messenger/Tests/TraceableMessageBusTest.php
@@ -56,7 +56,7 @@ public function testItTracesDispatchWithEnvelope()
         $this->assertCount(1, $tracedMessages = $traceableBus->getDispatchedMessages());
         $this->assertArraySubset(array(
             'message' => $message,
-            'stamps' => array($stamp),
+            'stamps' => array(array($stamp)),
             'caller' => array(
                 'name' => 'TraceableMessageBusTest.php',
                 'file' => __FILE__,

diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Serialization/SerializerTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Serialization/SerializerTest.php
@@ -18,16 +18,13 @@
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Transport\Serialization\Serializer;
 use Symfony\Component\Serializer as SerializerComponent;
-use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 
 class SerializerTest extends TestCase
 {
     public function testEncodedIsDecodable()
     {
-        $serializer = new Serializer(
-            new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
-        );
+        $serializer = new Serializer();
 
         $envelope = new Envelope(new DummyMessage('Hello'));
 
@@ -36,9 +33,7 @@ public function testEncodedIsDecodable()
 
     public function testEncodedWithStampsIsDecodable()
     {
-        $serializer = new Serializer(
-            new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
-        );
+        $serializer = new Serializer();
 
         $envelope = (new Envelope(new DummyMessage('Hello')))
             ->with(new SerializerStamp(array(ObjectNormalizer::GROUPS => array('foo'))))
@@ -50,9 +45,7 @@ public function testEncodedWithStampsIsDecodable()
 
     public function testEncodedIsHavingTheBodyAndTypeHeader()
     {
-        $serializer = new Serializer(
-            new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder()))
-        );
+        $serializer = new Serializer();
 
         $encoded = $serializer->encode(new Envelope(new DummyMessage('Hello')));
 
@@ -81,11 +74,7 @@ public function testUsesTheCustomFormatAndContext()
 
     public function testEncodedWithSymfonySerializerForStamps()
     {
-        $serializer = new Serializer(
-            new SerializerComponent\Serializer(array(new ObjectNormalizer()), array('json' => new JsonEncoder())),
-            'json',
-            array()
-        );
+        $serializer = new Serializer();
 
         $envelope = (new Envelope(new DummyMessage('Hello')))
             ->with($serializerStamp = new SerializerStamp(array(ObjectNormalizer::GROUPS => array('foo'))))

diff --git a/src/Symfony/Component/Messenger/Tests/WorkerTest.php b/src/Symfony/Component/Messenger/Tests/WorkerTest.php
@@ -42,10 +42,11 @@ public function testWorkerDispatchTheReceivedMessage()
 
     public function testWorkerDoesNotWrapMessagesAlreadyWrappedWithReceivedMessage()
     {
-        $envelope = (new Envelope(new DummyMessage('API')))->with(new ReceivedStamp());
+        $envelope = new Envelope(new DummyMessage('API'));
         $receiver = new CallbackReceiver(function ($handler) use ($envelope) {
             $handler($envelope);
         });
+        $envelope = $envelope->with(new ReceivedStamp());
 
         $bus = $this->getMockBuilder(MessageBusInterface::class)->getMock();
         $bus->expects($this->at(0))->method('dispatch')->with($envelope)->willReturn($envelope);

diff --git a/src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php b/src/Symfony/Component/Messenger/Transport/Serialization/Serializer.php
@@ -17,6 +17,7 @@
 use Symfony\Component\Messenger\Stamp\SerializerStamp;
 use Symfony\Component\Serializer\Encoder\JsonEncoder;
 use Symfony\Component\Serializer\Encoder\XmlEncoder;
+use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Serializer as SymfonySerializer;
 use Symfony\Component\Serializer\SerializerInterface as SymfonySerializerInterface;
@@ -34,9 +35,9 @@ class Serializer implements SerializerInterface
     private $format;
     private $context;
 
-    public function __construct(SymfonySerializerInterface $serializer, string $format = 'json', array $context = array())
+    public function __construct(SymfonySerializerInterface $serializer = null, string $format = 'json', array $context = array())
     {
-        $this->serializer = $serializer;
+        $this->serializer = $serializer ?? self::create()->serializer;
         $this->format = $format;
         $this->context = $context;
     }
@@ -48,7 +49,7 @@ public static function create(): self
         }
 
         $encoders = array(new XmlEncoder(), new JsonEncoder());
-        $normalizers = array(new ObjectNormalizer());
+        $normalizers = array(new ObjectNormalizer(), new ArrayDenormalizer());
         $serializer = new SymfonySerializer($normalizers, $encoders);
 
         return new self($serializer);
@@ -70,9 +71,8 @@ public function decode(array $encodedEnvelope): Envelope
         $stamps = $this->decodeStamps($encodedEnvelope);
 
         $context = $this->context;
-        /** @var SerializerStamp|null $serializerStamp */
-        if ($serializerStamp = $stamps[SerializerStamp::class] ?? null) {
-            $context = $serializerStamp->getContext() + $context;
+        if (isset($stamps[SerializerStamp::class])) {
+            $context = end($stamps[SerializerStamp::class])->getContext() + $context;
         }
 
         $message = $this->serializer->deserialize($encodedEnvelope['body'], $encodedEnvelope['headers']['type'], $this->format, $context);
@@ -107,21 +107,24 @@ private function decodeStamps(array $encodedEnvelope): array
                 continue;
             }
 
-            $stamps[] = $this->serializer->deserialize($value, substr($name, \strlen(self::STAMP_HEADER_PREFIX)), $this->format, $this->context);
+            $stamps[] = $this->serializer->deserialize($value, substr($name, \strlen(self::STAMP_HEADER_PREFIX)).'[]', $this->format, $this->context);
+        }
+        if ($stamps) {
+            $stamps = array_merge(...$stamps);
         }
 
         return $stamps;
     }
 
     private function encodeStamps(Envelope $envelope): array
     {
-        if (!$stamps = $envelope->all()) {
+        if (!$allStamps = $envelope->all()) {
             return array();
         }
 
         $headers = array();
-        foreach ($stamps as $stamp) {
-            $headers[self::STAMP_HEADER_PREFIX.\get_class($stamp)] = $this->serializer->serialize($stamp, $this->format, $this->context);
+        foreach ($allStamps as $class => $stamps) {
+            $headers[self::STAMP_HEADER_PREFIX.$class] = $this->serializer->serialize($stamps, $this->format, $this->context);
         }
 
         return $headers;