[Messenger] Consume a PSR-14 dispatcher for dispatching events

derrabus · derrabus · commit f1169bbeacad · 2022-04-07T23:54:03.000+02:00
diff --git a/src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php b/src/Symfony/Component/Messenger/EventListener/SendFailedMessageForRetryListener.php
@@ -11,8 +11,11 @@
 namespace Symfony\Component\Messenger\EventListener;
 
 use Psr\Container\ContainerInterface;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageRetriedEvent;
@@ -25,7 +28,7 @@
 use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
 use Symfony\Component\Messenger\Stamp\StampInterface;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface as SymfonyEventDispatcherInterface;
 
 /**
  * @author Tobias Schultze <http://tobion.de>
@@ -38,8 +41,19 @@ class SendFailedMessageForRetryListener implements EventSubscriberInterface
     private $eventDispatcher;
     private $historySize;
 
-    public function __construct(ContainerInterface $sendersLocator, ContainerInterface $retryStrategyLocator, LoggerInterface $logger = null, EventDispatcherInterface $eventDispatcher = null, int $historySize = 10)
+    /**
+     * @param EventDispatcherInterface|SymfonyEventDispatcherInterface|null $eventDispatcher
+     */
+    public function __construct(ContainerInterface $sendersLocator, ContainerInterface $retryStrategyLocator, LoggerInterface $logger = null, object $eventDispatcher = null, int $historySize = 10)
     {
+        if ($eventDispatcher instanceof SymfonyEventDispatcherInterface) {
+            if (class_exists(Event::class)) {
+                $eventDispatcher = LegacyEventDispatcherProxy::decorate($eventDispatcher);
+            }
+        } elseif (null !== $eventDispatcher && !$eventDispatcher instanceof EventDispatcherInterface) {
+            throw new \TypeError(__METHOD__.sprintf(': Parameter $eventDispatcher expected to be either null or an instance of "%s" or "%s", "%s" given.', EventDispatcherInterface::class, SymfonyEventDispatcherInterface::class, get_debug_type($eventDispatcher)));
+        }
+
         $this->sendersLocator = $sendersLocator;
         $this->retryStrategyLocator = $retryStrategyLocator;
         $this->logger = $logger;
diff --git a/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger\Middleware;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;
 use Symfony\Component\EventDispatcher\Event;
@@ -20,7 +21,7 @@
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Stamp\SentStamp;
 use Symfony\Component\Messenger\Transport\Sender\SendersLocatorInterface;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface as SymfonyEventDispatcherInterface;
 
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
@@ -33,10 +34,21 @@ class SendMessageMiddleware implements MiddlewareInterface
     private $sendersLocator;
     private $eventDispatcher;
 
-    public function __construct(SendersLocatorInterface $sendersLocator, EventDispatcherInterface $eventDispatcher = null)
+    /**
+     * @param EventDispatcherInterface|SymfonyEventDispatcherInterface|null $eventDispatcher
+     */
+    public function __construct(SendersLocatorInterface $sendersLocator, object $eventDispatcher = null)
     {
+        if ($eventDispatcher instanceof SymfonyEventDispatcherInterface) {
+            if (class_exists(Event::class)) {
+                $eventDispatcher = LegacyEventDispatcherProxy::decorate($eventDispatcher);
+            }
+        } elseif (null !== $eventDispatcher && !$eventDispatcher instanceof EventDispatcherInterface) {
+            throw new \TypeError(__METHOD__.sprintf(': Parameter $eventDispatcher expected to be either null or an instance of "%s" or "%s", "%s" given.', EventDispatcherInterface::class, SymfonyEventDispatcherInterface::class, get_debug_type($eventDispatcher)));
+        }
+
         $this->sendersLocator = $sendersLocator;
-        $this->eventDispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($eventDispatcher) : $eventDispatcher;
+        $this->eventDispatcher = $eventDispatcher;
         $this->logger = new NullLogger();
     }
 
diff --git a/src/Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageForRetryListenerTest.php b/src/Symfony/Component/Messenger/Tests/EventListener/SendFailedMessageForRetryListenerTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\EventListener\SendFailedMessageForRetryListener;
@@ -21,7 +22,6 @@
 use Symfony\Component\Messenger\Stamp\DelayStamp;
 use Symfony\Component\Messenger\Stamp\RedeliveryStamp;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 class SendFailedMessageForRetryListenerTest extends TestCase
 {
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Messenger\Tests\Middleware;
 
 use Psr\Container\ContainerInterface;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\SendMessageToTransportsEvent;
 use Symfony\Component\Messenger\Middleware\SendMessageMiddleware;
@@ -23,7 +24,6 @@
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessageInterface;
 use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
 use Symfony\Component\Messenger\Transport\Sender\SendersLocator;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 class SendMessageMiddlewareTest extends MiddlewareTestCase
 {
diff --git a/src/Symfony/Component/Messenger/Tests/WorkerTest.php b/src/Symfony/Component/Messenger/Tests/WorkerTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Messenger\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Messenger\Envelope;
@@ -39,7 +40,6 @@
 use Symfony\Component\Messenger\Transport\Receiver\QueueReceiverInterface;
 use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
 use Symfony\Component\Messenger\Worker;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\Service\ResetInterface;
 
 /**
@@ -65,8 +65,23 @@ public function testWorkerDispatchTheReceivedMessage()
                 return $envelopes[] = $envelope;
             });
 
-        $dispatcher = new EventDispatcher();
-        $dispatcher->addSubscriber(new StopWorkerOnMessageLimitListener(2));
+        $dispatcher = new class() implements EventDispatcherInterface {
+            private $listener;
+
+            public function __construct()
+            {
+                $this->listener = new StopWorkerOnMessageLimitListener(2);
+            }
+
+            public function dispatch(object $event): object
+            {
+                if ($event instanceof WorkerRunningEvent) {
+                    $this->listener->onWorkerRunning($event);
+                }
+
+                return $event;
+            }
+        };
 
         $worker = new Worker(['transport' => $receiver], $bus, $dispatcher);
         $worker->run();
diff --git a/src/Symfony/Component/Messenger/Worker.php b/src/Symfony/Component/Messenger/Worker.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
@@ -30,7 +31,7 @@
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
 use Symfony\Component\Messenger\Transport\Receiver\QueueReceiverInterface;
 use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
-use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface as SymfonyEventDispatcherInterface;
 use Symfony\Contracts\Service\ResetInterface;
 
 /**
@@ -51,14 +52,23 @@ class Worker
     private $unacks;
 
     /**
-     * @param ReceiverInterface[] $receivers Where the key is the transport name
+     * @param ReceiverInterface[]                                           $receivers       Where the key is the transport name
+     * @param EventDispatcherInterface|SymfonyEventDispatcherInterface|null $eventDispatcher
      */
-    public function __construct(array $receivers, MessageBusInterface $bus, EventDispatcherInterface $eventDispatcher = null, LoggerInterface $logger = null)
+    public function __construct(array $receivers, MessageBusInterface $bus, object $eventDispatcher = null, LoggerInterface $logger = null)
     {
+        if ($eventDispatcher instanceof SymfonyEventDispatcherInterface) {
+            if (class_exists(Event::class)) {
+                $eventDispatcher = LegacyEventDispatcherProxy::decorate($eventDispatcher);
+            }
+        } elseif (null !== $eventDispatcher && !$eventDispatcher instanceof EventDispatcherInterface) {
+            throw new \TypeError(__METHOD__.sprintf(': Parameter $eventDispatcher expected to be either null or an instance of "%s" or "%s", "%s" given.', EventDispatcherInterface::class, SymfonyEventDispatcherInterface::class, get_debug_type($eventDispatcher)));
+        }
+
         $this->receivers = $receivers;
         $this->bus = $bus;
         $this->logger = $logger;
-        $this->eventDispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($eventDispatcher) : $eventDispatcher;
+        $this->eventDispatcher = $eventDispatcher;
         $this->metadata = new WorkerMetadata([
             'transportNames' => array_keys($receivers),
         ]);
