Register the debug bus decorator in the message pass directly

sroze · sroze · commit 955a2af034c0 · 2018-04-22T14:44:16.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -63,7 +63,6 @@
 use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
 use Symfony\Component\Messenger\MessageBus;
 use Symfony\Component\Messenger\MessageBusInterface;
-use Symfony\Component\Messenger\TraceableMessageBus;
 use Symfony\Component\Messenger\Transport\ReceiverInterface;
 use Symfony\Component\Messenger\Transport\SenderInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
@@ -1483,11 +1482,6 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
                 $container->setAlias('message_bus', $busId);
                 $container->setAlias(MessageBusInterface::class, $busId);
             }
-
-            $container->setDefinition(
-                $tracedBusId = 'debug.traced.'.$busId,
-                (new Definition(TraceableMessageBus::class, array(new Reference($tracedBusId.'.inner'))))->setDecoratedService($busId)
-            );
         }
 
         if (!$container->hasAlias('message_bus')) {
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -22,6 +22,7 @@
 use Symfony\Component\Messenger\Handler\ChainHandler;
 use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
 use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
+use Symfony\Component\Messenger\TraceableMessageBus;
 
 /**
  * @author Samuel Roze <samuel.roze@gmail.com>
@@ -59,7 +60,7 @@ public function process(ContainerBuilder $container)
                 $container->getParameterBag()->remove($busMiddlewaresParameter);
             }
 
-            if ($container->hasDefinition('messenger.data_collector')) {
+            if ($container->getParameter('kernel.debug') && $container->hasDefinition('messenger.data_collector')) {
                 $this->registerBusToCollector($container, $busId, $tags[0]);
             }
         }
@@ -191,15 +192,12 @@ private function registerSenders(ContainerBuilder $container)
 
     private function registerBusToCollector(ContainerBuilder $container, string $busId, array $tag)
     {
-        if (!$container->hasDefinition($debugBusId = 'debug.traced.'.$busId)) {
-            return;
-        }
+        $container->setDefinition(
+            $tracedBusId = 'debug.traced.'.$busId,
+            (new Definition(TraceableMessageBus::class, array(new Reference($tracedBusId.'.inner'))))->setDecoratedService($busId)
+        );
 
-        if ($container->getParameter('kernel.debug')) {
-            $container->getDefinition('messenger.data_collector')->addMethodCall('registerBus', array($tag['name'] ?? $debugBusId, new Reference($debugBusId)));
-        } else {
-            $container->removeDefinition($debugBusId);
-        }
+        $container->getDefinition('messenger.data_collector')->addMethodCall('registerBus', array($tag['name'] ?? $busId, new Reference($tracedBusId)));
     }
 
     private function registerBusMiddlewares(ContainerBuilder $container, string $busId, array $middlewares)
diff --git a/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php b/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php
@@ -29,7 +29,6 @@
 use Symfony\Component\Messenger\MiddlewareInterface;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Tests\Fixtures\SecondMessage;
-use Symfony\Component\Messenger\TraceableMessageBus;
 use Symfony\Component\Messenger\Transport\ReceiverInterface;
 
 class MessengerPassTest extends TestCase
@@ -250,13 +249,16 @@ public function testRegistersTraceableBusesToCollector()
         $container = $this->getContainerBuilder();
         $container->register('messenger.data_collector', $dataCollector);
         $container->register($fooBusId = 'messenger.bus.foo', MessageBusInterface::class)->addTag('messenger.bus', array('name' => 'foo'));
-        $container->register('messenger.bus.bar', MessageBusInterface::class)->addTag('messenger.bus');
-        $container->register($debugedFooBusId = 'debug.traced.'.$fooBusId, TraceableMessageBus::class)->setDecoratedService($fooBusId);
+        $container->register($barBusId = 'messenger.bus.bar', MessageBusInterface::class)->addTag('messenger.bus');
         $container->setParameter('kernel.debug', true);
 
         (new MessengerPass())->process($container);
 
-        $this->assertEquals(array(array('registerBus', array('foo', new Reference($debugedFooBusId)))), $container->getDefinition('messenger.data_collector')->getMethodCalls());
+        $this->assertTrue($container->hasDefinition($debuggedFooBusId = 'debug.traced.'.$fooBusId));
+        $this->assertSame(array($fooBusId, null, 0), $container->getDefinition($debuggedFooBusId)->getDecoratedService());
+        $this->assertTrue($container->hasDefinition($debuggedBarBusId = 'debug.traced.'.$barBusId));
+        $this->assertSame(array($barBusId, null, 0), $container->getDefinition($debuggedBarBusId)->getDecoratedService());
+        $this->assertEquals(array(array('registerBus', array('foo', new Reference($debuggedFooBusId))), array('registerBus', array('messenger.bus.bar', new Reference($debuggedBarBusId)))), $container->getDefinition('messenger.data_collector')->getMethodCalls());
     }
 
     public function testRegistersMiddlewaresFromServices()
