feature #39306 [Messenger] Add TransportNamesStamp to change the transport while dispatching a message (asilelik, fabpot)

fabpot · fabpot · commit 1a4a5d5fcbd1 · 2022-08-05T13:20:29.000+02:00
This PR was merged into the 6.2 branch. Discussion ---------- [Messenger] Add `TransportNamesStamp` to change the transport while dispatching a message | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #38200, Fix #39306 | License | MIT | Doc PR | symfony/symfony-docs#... (Will be added after PR discussion about implementation) This feature will allow developers to choose transport layer while dispatching a message. Normally, we define transport layer in configuration. As a result, developer doesn't have any power to modify it after the deployment. This PR aims to allow overriding already defined transport layer for a message and rerouting it to different transport per dispatch request. If newly added stamp is not used, default configuration will be used for choosing transport. Since I've added a new stamp, there shouldn't be any BC change. Commits ------- f526af0 [Messenger] Rename some classes b501e67 Add functionality for choosing transport while dispatching message
diff --git a/src/Symfony/Component/Messenger/CHANGELOG.md b/src/Symfony/Component/Messenger/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add new `messenger:stats` command that return a list of transports with their "to be processed" message count
+ * Add `TransportNamesStamp` to change the transport while dispatching a message
 
 6.1
 ---
diff --git a/src/Symfony/Component/Messenger/Stamp/TransportNamesStamp.php b/src/Symfony/Component/Messenger/Stamp/TransportNamesStamp.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Stamp;
+
+/**
+ * Stamp used to override the transport names specified in the Messenger routing configuration file.
+ */
+final class TransportNamesStamp implements StampInterface
+{
+    /**
+     * @param string[] $transports Transport names to be used for the message
+     */
+    public function __construct(private array $transports)
+    {
+    }
+
+    public function getTransportNames(): array
+    {
+        return $this->transports;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Stamp/TransportNamesStampTest.php b/src/Symfony/Component/Messenger/Tests/Stamp/TransportNamesStampTest.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Messenger\Tests\Stamp;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
+
+class TransportNamesStampTest extends TestCase
+{
+    public function testGetSenders()
+    {
+        $configuredSenders = ['first_transport', 'second_transport', 'other_transport'];
+        $stamp = new TransportNamesStamp($configuredSenders);
+        $stampSenders = $stamp->getTransportNames();
+        $this->assertEquals(\count($configuredSenders), \count($stampSenders));
+
+        foreach ($configuredSenders as $key => $sender) {
+            $this->assertSame($sender, $stampSenders[$key]);
+        }
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Sender/SendersLocatorTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Sender/SendersLocatorTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Tests\Fixtures\SecondMessage;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
@@ -35,6 +36,22 @@ public function testItReturnsTheSenderBasedOnTheMessageClass()
         $this->assertSame([], iterator_to_array($locator->getSenders(new Envelope(new SecondMessage()))));
     }
 
+    public function testItReturnsTheSenderBasedOnTransportNamesStamp()
+    {
+        $mySender = $this->createMock(SenderInterface::class);
+        $otherSender = $this->createMock(SenderInterface::class);
+        $sendersLocator = $this->createContainer([
+            'my_sender' => $mySender,
+            'other_sender' => $otherSender,
+        ]);
+        $locator = new SendersLocator([
+            DummyMessage::class => ['my_sender'],
+        ], $sendersLocator);
+
+        $this->assertSame(['other_sender' => $otherSender], iterator_to_array($locator->getSenders(new Envelope(new DummyMessage('a'), [new TransportNamesStamp(['other_sender'])]))));
+        $this->assertSame([], iterator_to_array($locator->getSenders(new Envelope(new SecondMessage()))));
+    }
+
     private function createContainer(array $senders): ContainerInterface
     {
         $container = $this->createMock(ContainerInterface::class);
diff --git a/src/Symfony/Component/Messenger/Transport/Sender/SendersLocator.php b/src/Symfony/Component/Messenger/Transport/Sender/SendersLocator.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\RuntimeException;
 use Symfony\Component\Messenger\Handler\HandlersLocator;
+use Symfony\Component\Messenger\Stamp\TransportNamesStamp;
 
 /**
  * Maps a message to a list of senders.
@@ -41,20 +42,33 @@ public function __construct(array $sendersMap, ContainerInterface $sendersLocato
      */
     public function getSenders(Envelope $envelope): iterable
     {
+        if ($envelope->all(TransportNamesStamp::class)) {
+            foreach ($envelope->last(TransportNamesStamp::class)->getTransportNames() as $senderAlias) {
+                yield from $this->getSenderFromAlias($senderAlias);
+            }
+
+            return;
+        }
+
         $seen = [];
 
         foreach (HandlersLocator::listTypes($envelope) as $type) {
             foreach ($this->sendersMap[$type] ?? [] as $senderAlias) {
                 if (!\in_array($senderAlias, $seen, true)) {
-                    if (!$this->sendersLocator->has($senderAlias)) {
-                        throw new RuntimeException(sprintf('Invalid senders configuration: sender "%s" is not in the senders locator.', $senderAlias));
-                    }
-
                     $seen[] = $senderAlias;
-                    $sender = $this->sendersLocator->get($senderAlias);
-                    yield $senderAlias => $sender;
+
+                    yield from $this->getSenderFromAlias($senderAlias);
                 }
             }
         }
     }
+
+    private function getSenderFromAlias(string $senderAlias): iterable
+    {
+        if (!$this->sendersLocator->has($senderAlias)) {
+            throw new RuntimeException(sprintf('Invalid senders configuration: sender "%s" is not in the senders locator.', $senderAlias));
+        }
+
+        yield $senderAlias => $this->sendersLocator->get($senderAlias);
+    }
 }
