Context stamp (#3157)

* Issue #3082: Add and use ContextStamp.

* Issue #3082: Add tests.

* Issue #3157: Correct passing of context.

* Issue #3157: Minor corrections.

Author: Sergii Pavlenko

src/Bridge/Symfony/Messenger/ContextStamp.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Bridge\Symfony\Messenger;
+
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+/**
+ * An envelope stamp with context which related to a message.
+ *
+ * @experimental
+ *
+ * @author Sergii Pavlenko <[email protected]>
+ */
+final class ContextStamp implements StampInterface
+{
+    private $context;
+
+    public function __construct(array $context = [])
+    {
+        $this->context = $context;
+    }
+
+    /**
+     * Get the context related to a message.
+     */
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+}

src/Bridge/Symfony/Messenger/DataPersister.php

@@ -75,7 +75,10 @@ public function supports($data, array $context = []): bool
      */
     public function persist($data, array $context = [])
     {
-        $envelope = $this->dispatch($data);
+        $envelope = $this->dispatch(
+            (new Envelope($data))
+                ->with(new ContextStamp($context))
+        );
 
         $handledStamp = $envelope->last(HandledStamp::class);
         if (!$handledStamp instanceof HandledStamp) {

tests/Bridge/Symfony/Messenger/ContextStampTest.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Bridge\Symfony\Messenger;
+
+use ApiPlatform\Core\Bridge\Symfony\Messenger\ContextStamp;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+/**
+ * @author Sergii Pavlenko <[email protected]>
+ */
+class ContextStampTest extends TestCase
+{
+    public function testConstruct()
+    {
+        $this->assertInstanceOf(StampInterface::class, new ContextStamp());
+    }
+
+    public function testGetContext()
+    {
+        $contextStamp = new ContextStamp();
+        $this->assertIsArray($contextStamp->getContext());
+    }
+}

tests/Bridge/Symfony/Messenger/DataPersisterTest.php

@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\Tests\Bridge\Symfony\Messenger;
 
+use ApiPlatform\Core\Bridge\Symfony\Messenger\ContextStamp;
 use ApiPlatform\Core\Bridge\Symfony\Messenger\DataPersister;
 use ApiPlatform\Core\Bridge\Symfony\Messenger\RemoveStamp;
 use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
@@ -56,7 +57,9 @@ public function testPersist()
         $dummy = new Dummy();
 
         $messageBus = $this->prophesize(MessageBusInterface::class);
-        $messageBus->dispatch($dummy)->willReturn(new Envelope($dummy))->shouldBeCalled();
+        $messageBus->dispatch(Argument::that(function (Envelope $envelope) use ($dummy) {
+            return $dummy === $envelope->getMessage() && null !== $envelope->last(ContextStamp::class);
+        }))->willReturn(new Envelope($dummy))->shouldBeCalled();
 
         $dataPersister = new DataPersister($this->prophesize(ResourceMetadataFactoryInterface::class)->reveal(), $messageBus->reveal());
         $this->assertSame($dummy, $dataPersister->persist($dummy));
@@ -67,6 +70,7 @@ public function testRemove()
         $dummy = new Dummy();
 
         $messageBus = $this->prophesize(MessageBusInterface::class);
+
         $messageBus->dispatch(Argument::that(function (Envelope $envelope) use ($dummy) {
             return $dummy === $envelope->getMessage() && null !== $envelope->last(RemoveStamp::class);
         }))->willReturn(new Envelope($dummy))->shouldBeCalled();
@@ -80,7 +84,9 @@ public function testHandle()
         $dummy = new Dummy();
 
         $messageBus = $this->prophesize(MessageBusInterface::class);
-        $messageBus->dispatch($dummy)->willReturn((new Envelope($dummy))->with(new HandledStamp($dummy, 'DummyHandler::__invoke')))->shouldBeCalled();
+        $messageBus->dispatch(Argument::that(function (Envelope $envelope) use ($dummy) {
+            return $dummy === $envelope->getMessage() && null !== $envelope->last(ContextStamp::class);
+        }))->willReturn((new Envelope($dummy))->with(new HandledStamp($dummy, 'DummyHandler::__invoke')))->shouldBeCalled();
 
         $dataPersister = new DataPersister($this->prophesize(ResourceMetadataFactoryInterface::class)->reveal(), $messageBus->reveal());
         $this->assertSame($dummy, $dataPersister->persist($dummy));