Only subscribe to a given bus from the MessageSubscriber

sroze · sroze · commit 6fc6879b6add · 2018-08-26T15:47:15.000+01:00
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -97,6 +97,7 @@ private function registerHandlers(ContainerBuilder $container, array $busIds)
                 $handlerBuses = (array) ($tag['bus'] ?? $busIds);
 
                 foreach ($handles as $messageClass => $method) {
+                    $buses = $handlerBuses;
                     if (\is_int($messageClass)) {
                         $messageClass = $method;
                         $method = '__invoke';
@@ -110,8 +111,24 @@ private function registerHandlers(ContainerBuilder $container, array $busIds)
                     }
 
                     if (\is_array($method)) {
-                        $messagePriority = $method[1];
-                        $method = $method[0];
+                        if (isset($method[0]) && isset($method[1])) {
+                            $messagePriority = $method[1];
+                            $method = $method[0];
+                        } elseif (isset($method['method']) || isset($method['bus'])) {
+                            if (isset($method['bus'])) {
+                                $buses = array($method['bus']);
+                            }
+
+                            if (isset($method['priority'])) {
+                                $messagePriority = $method['priority'];
+                            }
+
+                            $method = $method['method'] ?? '__invoke';
+                        } else {
+                            $messageClassLocation = isset($tag['handles']) ? 'declared in your tag attribute "handles"' : $r->implementsInterface(MessageSubscriberInterface::class) ? sprintf('returned by method "%s::getHandledMessages()"', $r->getName()) : sprintf('used as argument type in method "%s::%s()"', $r->getName(), $method);
+
+                            throw new RuntimeException(sprintf('Invalid configuration %s for message "%s".', $messageClassLocation, $messageClass));
+                        }
                     }
 
                     if (!\class_exists($messageClass)) {
@@ -132,7 +149,7 @@ private function registerHandlers(ContainerBuilder $container, array $busIds)
                         $definitionId = $serviceId;
                     }
 
-                    foreach ($handlerBuses as $handlerBus) {
+                    foreach ($buses as $handlerBus) {
                         $handlersByBusAndMessage[$handlerBus][$messageClass][$messagePriority][] = $definitionId;
                     }
                 }
diff --git a/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php b/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php
@@ -297,6 +297,33 @@ public function testItShouldNotThrowIfGeneratorIsReturnedInsteadOfArray()
         $this->assertEquals(array(new Reference(HandlerWithGenerators::class), 'secondMessage'), $container->getDefinition($secondReference)->getArgument(0));
     }
 
+    public function testItRegistersHandlersOnDifferentBuses()
+    {
+        $container = $this->getContainerBuilder($eventsBusId = 'event_bus');
+        $container->register($commandsBusId = 'command_bus', MessageBusInterface::class)->addTag('messenger.bus')->setArgument(0, array());
+
+        $container
+            ->register(HandlerOnSpecificBuses::class, HandlerOnSpecificBuses::class)
+            ->addTag('messenger.message_handler')
+        ;
+
+        (new MessengerPass())->process($container);
+
+        $eventsHandlerLocatorDefinition = $container->getDefinition($container->getDefinition($eventsBusId.'.messenger.handler_resolver')->getArgument(0));
+        $eventsHandlerMapping = $eventsHandlerLocatorDefinition->getArgument(0);
+
+        $this->assertEquals(array('handler.'.DummyMessage::class), array_keys($eventsHandlerMapping));
+        $firstReference = $eventsHandlerMapping['handler.'.DummyMessage::class]->getValues()[0];
+        $this->assertEquals(array(new Reference(HandlerOnSpecificBuses::class), 'dummyMethodForEvents'), $container->getDefinition($firstReference)->getArgument(0));
+
+        $commandsHandlerLocatorDefinition = $container->getDefinition($container->getDefinition($commandsBusId.'.messenger.handler_resolver')->getArgument(0));
+        $commandsHandlerMapping = $commandsHandlerLocatorDefinition->getArgument(0);
+
+        $this->assertEquals(array('handler.'.DummyMessage::class), array_keys($commandsHandlerMapping));
+        $firstReference = $commandsHandlerMapping['handler.'.DummyMessage::class]->getValues()[0];
+        $this->assertEquals(array(new Reference(HandlerOnSpecificBuses::class), 'dummyMethodForCommands'), $container->getDefinition($firstReference)->getArgument(0));
+    }
+
     /**
      * @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".
@@ -747,6 +774,23 @@ public function secondMessage()
     }
 }
 
+class HandlerOnSpecificBuses implements MessageSubscriberInterface
+{
+    public static function getHandledMessages(): iterable
+    {
+        yield DummyMessage::class => ['method' => 'dummyMethodForEvents', 'bus' => 'event_bus'];
+        yield DummyMessage::class => ['method' => 'dummyMethodForCommands', 'bus' => 'command_bus'];
+    }
+
+    public function dummyMethodForEvents()
+    {
+    }
+
+    public function dummyMethodForCommands()
+    {
+    }
+}
+
 class UselessMiddleware implements MiddlewareInterface
 {
     public function handle($message, callable $next)
