[Messenger] support iterable in sender locator

Tobion · Tobion · commit 7a4abf180caa · 2018-05-09T13:58:16.000+02:00
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Asynchronous/Middleware/SendMessageMiddleware.php
@@ -36,20 +36,21 @@ public function handle($message, callable $next)
             return $next($message->getMessage());
         }
 
-        if (!empty($senders = $this->senderLocator->getSendersForMessage($message))) {
-            foreach ($senders as $sender) {
-                if (null === $sender) {
-                    continue;
-                }
-
-                $sender->send($message);
+        $hasSender = false;
+        $forwardToSenderAndHandler = false;
+        foreach ($this->senderLocator->getSendersForMessage($message) as $sender) {
+            $hasSender = true;
+
+            if (null === $sender) {
+                $forwardToSenderAndHandler = true;
+                continue;
             }
 
-            if (!\in_array(null, $senders, true)) {
-                return;
-            }
+            $sender->send($message);
         }
 
-        return $next($message);
+        if (!$hasSender || $forwardToSenderAndHandler) {
+            return $next($message);
+        }
     }
 }
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Routing/SenderLocator.php b/src/Symfony/Component/Messenger/Asynchronous/Routing/SenderLocator.php
@@ -30,15 +30,12 @@ public function __construct(ContainerInterface $senderServiceLocator, array $mes
     /**
      * {@inheritdoc}
      */
-    public function getSendersForMessage($message): array
+    public function getSendersForMessage($message): iterable
     {
         $senderIds = $this->messageToSenderIdsMapping[\get_class($message)] ?? $this->messageToSenderIdsMapping['*'] ?? array();
 
-        $senders = array();
         foreach ($senderIds as $senderId) {
-            $senders[] = $this->senderServiceLocator->get($senderId);
+            yield $this->senderServiceLocator->get($senderId);
         }
-
-        return $senders;
     }
 }
diff --git a/src/Symfony/Component/Messenger/Asynchronous/Routing/SenderLocatorInterface.php b/src/Symfony/Component/Messenger/Asynchronous/Routing/SenderLocatorInterface.php
@@ -21,11 +21,11 @@
 interface SenderLocatorInterface
 {
     /**
-     * Gets the sender (if applicable) for the given message object.
+     * Gets the senders (if applicable) for the given message object.
      *
      * @param object $message
      *
      * @return SenderInterface[]
      */
-    public function getSendersForMessage($message): array;
+    public function getSendersForMessage($message): iterable;
 }
diff --git a/src/Symfony/Component/Messenger/Tests/Asynchronous/Middleware/SendMessageMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Asynchronous/Middleware/SendMessageMiddlewareTest.php
@@ -88,12 +88,12 @@ class InMemorySenderLocator implements SenderLocatorInterface
 {
     private $senders;
 
-    public function __construct(array $senders)
+    public function __construct(iterable $senders)
     {
         $this->senders = $senders;
     }
 
-    public function getSendersForMessage($message): array
+    public function getSendersForMessage($message): iterable
     {
         return $this->senders;
     }
diff --git a/src/Symfony/Component/Messenger/Tests/Asynchronous/Routing/SenderLocatorTest.php b/src/Symfony/Component/Messenger/Tests/Asynchronous/Routing/SenderLocatorTest.php
@@ -32,8 +32,8 @@ public function testItReturnsTheSenderBasedOnTheMessageClass()
             ),
         ));
 
-        $this->assertEquals(array($sender), $locator->getSendersForMessage(new DummyMessage('Hello')));
-        $this->assertEquals(array(), $locator->getSendersForMessage(new SecondMessage()));
+        $this->assertIterableEquals(array($sender), $locator->getSendersForMessage(new DummyMessage('Hello')));
+        $this->assertIterableEquals(array(), $locator->getSendersForMessage(new SecondMessage()));
     }
 
     public function testItSupportsAWildcardInsteadOfTheMessageClass()
@@ -55,7 +55,19 @@ public function testItSupportsAWildcardInsteadOfTheMessageClass()
             ),
         ));
 
-        $this->assertEquals(array($sender), $locator->getSendersForMessage(new DummyMessage('Hello')));
-        $this->assertEquals(array($apiSender), $locator->getSendersForMessage(new SecondMessage()));
+        $this->assertIterableEquals(array($sender), $locator->getSendersForMessage(new DummyMessage('Hello')));
+        $this->assertIterableEquals(array($apiSender), $locator->getSendersForMessage(new SecondMessage()));
+    }
+
+    private function assertIterableEquals(iterable $expected, iterable $actual)
+    {
+        if ($actual instanceof \Traversable) {
+            $actual = iterator_to_array($actual, false);
+        }
+        if ($expected instanceof \Traversable) {
+            $expected = iterator_to_array($expected, false);
+        }
+
+        $this->assertEquals($expected, $actual);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,15 +30,12 @@ public function __construct(ContainerInterface $senderServiceLocator, array $mes`
`30`	`30`	`/**`
`31`	`31`	`* {@inheritdoc}`
`32`	`32`	`*/`
`33`		`- public function getSendersForMessage($message): array`
	`33`	`+ public function getSendersForMessage($message): iterable`
`34`	`34`	`{`
`35`	`35`	`$senderIds = $this->messageToSenderIdsMapping[\get_class($message)] ?? $this->messageToSenderIdsMapping['*'] ?? array();`
`36`	`36`
`37`		`- $senders = array();`
`38`	`37`	`foreach ($senderIds as $senderId) {`
`39`		`- $senders[] = $this->senderServiceLocator->get($senderId);`
	`38`	`+ yield $this->senderServiceLocator->get($senderId);`
`40`	`39`	`}`
`41`		`-`
`42`		`- return $senders;`
`43`	`40`	`}`
`44`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,11 @@`
`21`	`21`	`interface SenderLocatorInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * Gets the sender (if applicable) for the given message object.`
	`24`	`+ * Gets the senders (if applicable) for the given message object.`
`25`	`25`	`*`
`26`	`26`	`* @param object $message`
`27`	`27`	`*`
`28`	`28`	`* @return SenderInterface[]`
`29`	`29`	`*/`
`30`		`- public function getSendersForMessage($message): array;`
	`30`	`+ public function getSendersForMessage($message): iterable;`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,12 +88,12 @@ class InMemorySenderLocator implements SenderLocatorInterface`
`88`	`88`	`{`
`89`	`89`	`private $senders;`
`90`	`90`
`91`		`- public function __construct(array $senders)`
	`91`	`+ public function __construct(iterable $senders)`
`92`	`92`	`{`
`93`	`93`	`$this->senders = $senders;`
`94`	`94`	`}`
`95`	`95`
`96`		`- public function getSendersForMessage($message): array`
	`96`	`+ public function getSendersForMessage($message): iterable`
`97`	`97`	`{`
`98`	`98`	`return $this->senders;`
`99`	`99`	`}`