[Messenger] Fixed MessengerPass::guessHandledClasses return type

massimilianobraglia · nicolas-grekas · commit 0b1c8257d6df · 2018-06-19T11:34:40.000+02:00
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -185,7 +185,7 @@ private function registerHandlers(ContainerBuilder $container, array $busIds)
         }
     }
 
-    private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId): array
+    private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId): iterable
     {
         if ($handlerClass->implementsInterface(MessageSubscriberInterface::class)) {
             if (!$handledMessages = $handlerClass->getName()::getHandledMessages()) {
diff --git a/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php b/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php
@@ -274,6 +274,23 @@ public function testItRegistersSenderWithoutTagName()
         $this->assertEquals(array(AmqpSender::class => new Reference(AmqpSender::class)), $container->getDefinition('messenger.sender_locator')->getArgument(0));
     }
 
+    public function testItShouldNotThrowIfGeneratorIsReturnedInsteadOfArray()
+    {
+        $container = $this->getContainerBuilder($busId = 'message_bus');
+        $container
+            ->register(HandlerWithGenerators::class, HandlerWithGenerators::class)
+            ->addTag('messenger.message_handler')
+        ;
+
+        (new MessengerPass())->process($container);
+
+        $handlerLocatorDefinition = $container->getDefinition($container->getDefinition("$busId.messenger.handler_resolver")->getArgument(0));
+        $handlerMapping = $handlerLocatorDefinition->getArgument(0);
+
+        $this->assertArrayHasKey('handler.'.DummyMessage::class, $handlerMapping);
+        $this->assertArrayHasKey('handler.'.SecondMessage::class, $handlerMapping);
+    }
+
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
      * @expectedExceptionMessage Invalid sender "app.messenger.sender": class "Symfony\Component\Messenger\Tests\DependencyInjection\InvalidSender" must implement interface "Symfony\Component\Messenger\Transport\SenderInterface".
@@ -685,6 +702,23 @@ public function __invoke()
     }
 }
 
+class HandlerWithGenerators implements MessageSubscriberInterface
+{
+    public static function getHandledMessages(): iterable
+    {
+        yield DummyMessage::class => 'dummyMethod';
+        yield SecondMessage::class => 'secondMessage';
+    }
+
+    public function dummyMethod()
+    {
+    }
+
+    public function secondMessage()
+    {
+    }
+}
+
 class UselessMiddleware implements MiddlewareInterface
 {
     public function handle($message, callable $next)

Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ private function registerHandlers(ContainerBuilder $container, array $busIds)`
`185`	`185`	`}`
`186`	`186`	`}`
`187`	`187`
`188`		`- private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId): array`
	`188`	`+ private function guessHandledClasses(\ReflectionClass $handlerClass, string $serviceId): iterable`
`189`	`189`	`{`
`190`	`190`	`if ($handlerClass->implementsInterface(MessageSubscriberInterface::class)) {`
`191`	`191`	`if (!$handledMessages = $handlerClass->getName()::getHandledMessages()) {`