Move commands-specifics to a compiler pass in FWB

Author: sroze

DependencyInjection/Compiler/MessengerCommandsPass.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\Messenger\DependencyInjection\MessengerPass;
+
+/**
+ * @author Samuel Roze <samuel.roze@gmail.com>
+ */
+class MessengerCommandsPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->hasDefinition('console.command.messenger_consume_messages')) {
+            return;
+        }
+
+        $buses = array();
+        foreach ($container->findTaggedServiceIds('messenger.bus') as $busId => $tags) {
+            $buses[$busId] = new Reference($busId);
+        }
+
+        $container
+            ->getDefinition('console.command.messenger_consume_messages')
+            ->replaceArgument(3, $this->findReceiverNames($container))
+        ;
+    }
+
+    private function findReceiverNames(ContainerBuilder $container)
+    {
+        $receiverNames = array();
+        foreach (MessengerPass::findReceivers($container, 'messenger.receiver') as $name => $reference) {
+            $receiverNames[(string) $reference] = $name;
+        }
+
+        return array_values($receiverNames);
+    }
+}

FrameworkBundle.php

@@ -21,6 +21,7 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ContainerBuilderDebugDumpPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\DataCollectorTranslatorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\LoggingTranslatorPass;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\MessengerCommandsPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ProfilerPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TemplatingPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TestServiceContainerRealRefPass;
@@ -119,6 +120,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new TestServiceContainerWeakRefPass(), PassConfig::TYPE_BEFORE_REMOVING, -32);
         $container->addCompilerPass(new TestServiceContainerRealRefPass(), PassConfig::TYPE_AFTER_REMOVING);
         $this->addCompilerPassIfExists($container, MessengerPass::class);
+        $container->addCompilerPass(new MessengerCommandsPass());
 
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new AddDebugLogProcessorPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);

Tests/DependencyInjection/Compiler/MessengerCommandsPassTest.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection\Compiler;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\MessengerCommandsPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\Messenger\Command\ConsumeMessagesCommand;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Tests\Fixtures\DummyReceiver;
+use Symfony\Component\Messenger\Transport\AmqpExt\AmqpReceiver;
+
+class MessengerCommandsPassTest extends TestCase
+{
+    public function testItRegistersMultipleReceiversAndSetsTheReceiverNamesOnTheCommand()
+    {
+        $container = new ContainerBuilder();
+        $container->register('my_bus_name', MessageBusInterface::class)->addTag('messenger.bus')->setArgument(0, array());
+        $container->register('console.command.messenger_consume_messages', ConsumeMessagesCommand::class)->setArguments(array(
+            null,
+            new Reference('messenger.receiver_locator'),
+            null,
+            null,
+            null,
+        ));
+
+        $container->register(AmqpReceiver::class, AmqpReceiver::class)->addTag('messenger.receiver', array('alias' => 'amqp'));
+        $container->register(DummyReceiver::class, DummyReceiver::class)->addTag('messenger.receiver', array('alias' => 'dummy'));
+
+        (new MessengerCommandsPass())->process($container);
+
+        $this->assertSame(array('amqp', 'dummy'), $container->getDefinition('console.command.messenger_consume_messages')->getArgument(3));
+    }
+}

composer.json

@@ -67,6 +67,7 @@
         "symfony/asset": "<3.4",
         "symfony/console": "<3.4",
         "symfony/form": "<4.1",
+        "symfony/messenger": "<4.1.5",
         "symfony/property-info": "<3.4",
         "symfony/serializer": "<4.1",
         "symfony/stopwatch": "<3.4",