Dispatching two events when a message is sent & handled

weaverryan · weaverryan · commit 49d3c468c84e · 2019-03-22T12:30:44.000-04:00
diff --git a/src/Symfony/Component/Messenger/Event/SendMessageToTransportsEvent.php b/src/Symfony/Component/Messenger/Event/SendMessageToTransportsEvent.php
@@ -0,0 +1,44 @@
+<?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\Event;
+
+use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\Messenger\Envelope;
+
+/**
+ * Event is dispatched before a message is sent to the transport.
+ *
+ * The event is *only* dispatched if the message will actually
+ * be sent to at least one transport. If the message is sent
+ * to multiple transports, the message is dispatched only one time.
+ *
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ */
+class SendMessageToTransportsEvent extends Event
+{
+    private $envelope;
+
+    public function __construct(Envelope $envelope)
+    {
+        $this->envelope = $envelope;
+    }
+
+    public function getEnvelope(): Envelope
+    {
+        return $this->envelope;
+    }
+
+    public function setEnvelope(Envelope $envelope)
+    {
+        $this->envelope = $envelope;
+    }
+}
diff --git a/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php
@@ -13,7 +13,9 @@
 
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\SendMessageToTransportsEvent;
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Stamp\SentStamp;
 use Symfony\Component\Messenger\Transport\Sender\SendersLocatorInterface;
@@ -29,10 +31,12 @@ class SendMessageMiddleware implements MiddlewareInterface
     use LoggerAwareTrait;
 
     private $sendersLocator;
+    private $eventDispatcher;
 
-    public function __construct(SendersLocatorInterface $sendersLocator)
+    public function __construct(SendersLocatorInterface $sendersLocator, EventDispatcherInterface $eventDispatcher = null)
     {
         $this->sendersLocator = $sendersLocator;
+        $this->eventDispatcher = $eventDispatcher;
         $this->logger = new NullLogger();
     }
 
@@ -54,8 +58,18 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
                 // it's a received message, do not send it back
                 $this->logger->info('Received message "{class}"', $context);
             } else {
+                $messageDispatched = false;
                 foreach ($this->sendersLocator->getSenders($envelope, $handle) as $alias => $sender) {
                     $this->logger->info('Sending message "{class}" with "{sender}"', $context + ['sender' => \get_class($sender)]);
+
+                    if (null !== $this->eventDispatcher && false === $messageDispatched) {
+                        $messageDispatched = true;
+
+                        $event = new SendMessageToTransportsEvent($envelope);
+                        $this->eventDispatcher->dispatch($event);
+                        $envelope = $event->getEnvelope();
+                    }
+
                     $envelope = $sender->send($envelope)->with(new SentStamp(\get_class($sender), \is_string($alias) ? $alias : null));
                 }
             }
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php
@@ -11,7 +11,9 @@
 
 namespace Symfony\Component\Messenger\Tests\Middleware;
 
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Event\SendMessageToTransportsEvent;
 use Symfony\Component\Messenger\Middleware\SendMessageMiddleware;
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Stamp\SentStamp;
@@ -138,4 +140,24 @@ public function testItSkipsReceivedMessages()
 
         $this->assertNull($envelope->last(SentStamp::class), 'it does not add sent stamp for received messages');
     }
+
+    public function testItDispatchesTheEventOnceTime()
+    {
+        $envelope = new Envelope(new DummyMessage('original envelope'));
+
+        $dispatcher = $this->createMock(EventDispatcherInterface::class);
+        $dispatcher->expects($this->once())
+            ->method('dispatch')
+            ->with(new SendMessageToTransportsEvent($envelope));
+
+        $sender1 = $this->getMockBuilder(SenderInterface::class)->getMock();
+        $sender2 = $this->getMockBuilder(SenderInterface::class)->getMock();
+
+        $middleware = new SendMessageMiddleware(new SendersLocator([DummyMessage::class => [$sender1, $sender2]]), $dispatcher);
+
+        $sender1->expects($this->once())->method('send')->willReturn($envelope);
+        $sender2->expects($this->once())->method('send')->willReturn($envelope);
+
+        $middleware->handle($envelope, $this->getStackMock(false));
+    }
 }
diff --git a/src/Symfony/Component/Messenger/composer.json b/src/Symfony/Component/Messenger/composer.json
@@ -22,6 +22,7 @@
     "require-dev": {
         "symfony/console": "~3.4|~4.0",
         "symfony/dependency-injection": "~3.4.19|^4.1.8",
+        "symfony/event-dispatcher": "~4.3",
         "symfony/http-kernel": "~3.4|~4.0",
         "symfony/process": "~3.4|~4.0",
         "symfony/property-access": "~3.4|~4.0",
@@ -30,6 +31,9 @@
         "symfony/validator": "~3.4|~4.0",
         "symfony/var-dumper": "~3.4|~4.0"
     },
+    "conflict": {
+        "symfony/event-dispatcher": "<4.3"
+    },
     "suggest": {
         "enqueue/messenger-adapter": "For using the php-enqueue library as a transport."
     },
