add senders to SendMessageToTransportsEvent

Jeroeny · Jeroeny · commit d50a0b78d874 · 2022-08-16T17:54:16.000+02:00
diff --git a/src/Symfony/Component/Messenger/Event/SendMessageToTransportsEvent.php b/src/Symfony/Component/Messenger/Event/SendMessageToTransportsEvent.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Messenger\Event;
 
 use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\Transport\Sender\SenderInterface;
 
 /**
  * Event is dispatched before a message is sent to the transport.
@@ -28,9 +29,12 @@ final class SendMessageToTransportsEvent
 {
     private Envelope $envelope;
 
-    public function __construct(Envelope $envelope)
+    private array $senders;
+
+    public function __construct(Envelope $envelope, array $senders)
     {
         $this->envelope = $envelope;
+        $this->senders = $senders;
     }
 
     public function getEnvelope(): Envelope
@@ -42,4 +46,12 @@ public function setEnvelope(Envelope $envelope)
     {
         $this->envelope = $envelope;
     }
+
+    /**
+     * @return array<string, SenderInterface>
+     */
+    public function getSenders(): array
+    {
+        return $this->senders;
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php
@@ -55,9 +55,11 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
             $this->logger->info('Received message {class}', $context);
         } else {
             $shouldDispatchEvent = true;
-            foreach ($this->sendersLocator->getSenders($envelope) as $alias => $sender) {
+            $senders = $this->sendersLocator->getSenders($envelope);
+            $senders = \is_array($senders) ? $senders : \iterator_to_array($senders);
+            foreach ($senders as $alias => $sender) {
                 if (null !== $this->eventDispatcher && $shouldDispatchEvent) {
-                    $event = new SendMessageToTransportsEvent($envelope);
+                    $event = new SendMessageToTransportsEvent($envelope, $senders);
                     $this->eventDispatcher->dispatch($event);
                     $envelope = $event->getEnvelope();
                     $shouldDispatchEvent = false;
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/SendMessageMiddlewareTest.php
@@ -168,13 +168,13 @@ public function testItDispatchesTheEventOneTime()
     {
         $envelope = new Envelope(new DummyMessage('original envelope'));
 
+        $sender1 = $this->createMock(SenderInterface::class);
+        $sender2 = $this->createMock(SenderInterface::class);
+
         $dispatcher = $this->createMock(EventDispatcherInterface::class);
         $dispatcher->expects($this->once())
             ->method('dispatch')
-            ->with(new SendMessageToTransportsEvent($envelope));
-
-        $sender1 = $this->createMock(SenderInterface::class);
-        $sender2 = $this->createMock(SenderInterface::class);
+            ->with(new SendMessageToTransportsEvent($envelope, ['foo' => $sender1, 'bar' => $sender2]));
 
         $sendersLocator = $this->createSendersLocator([DummyMessage::class => ['foo', 'bar']], ['foo' => $sender1, 'bar' => $sender2]);
         $middleware = new SendMessageMiddleware($sendersLocator, $dispatcher);

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Messenger\Event;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Messenger\Envelope;`
	`15`	`+use Symfony\Component\Messenger\Transport\Sender\SenderInterface;`
`15`	`16`
`16`	`17`	`/**`
`17`	`18`	`* Event is dispatched before a message is sent to the transport.`
`@@ -28,9 +29,12 @@ final class SendMessageToTransportsEvent`
`28`	`29`	`{`
`29`	`30`	`private Envelope $envelope;`
`30`	`31`
`31`		`- public function __construct(Envelope $envelope)`
	`32`	`+ private array $senders;`
	`33`	`+`
	`34`	`+ public function __construct(Envelope $envelope, array $senders)`
`32`	`35`	`{`
`33`	`36`	`$this->envelope = $envelope;`
	`37`	`+ $this->senders = $senders;`
`34`	`38`	`}`
`35`	`39`
`36`	`40`	`public function getEnvelope(): Envelope`
`@@ -42,4 +46,12 @@ public function setEnvelope(Envelope $envelope)`
`42`	`46`	`{`
`43`	`47`	`$this->envelope = $envelope;`
`44`	`48`	`}`
	`49`	`+`
	`50`	`+ /**`
	`51`	`+ * @return array<string, SenderInterface>`
	`52`	`+ */`
	`53`	`+ public function getSenders(): array`
	`54`	`+ {`
	`55`	`+ return $this->senders;`
	`56`	`+ }`
`45`	`57`	`}`