Configure the class used to decorate your bus

symfony · sroze · Apr 25, 2018 · Apr 25, 2018 · Apr 27, 2018 · Apr 25, 2018
commit 78c15c19fba3513ac94d727c885daff59fec90d0
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1054,7 +1054,7 @@ function ($a) {
                                 ->addDefaultsIfNotSet()
                                 ->children()
                                     ->booleanNode('default_middlewares')->defaultTrue()->end()
-                                    ->scalarNode('class')->end()
+                                    ->scalarNode('decorator_class')->end()
                                     ->arrayNode('middlewares')
                                         ->defaultValue(array())
                                         ->prototype('scalar')->end()

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1481,13 +1481,14 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
                 throw new LogicException('The Validation middleware is only available when the Validator component is installed and enabled. Try running "composer require symfony/validator".');
             }
 
-            $container->setParameter($busId.'.middlewares', $middlewares);
-            $container->setDefinition($busId, (new Definition($bus['class'] ?? MessageBus::class, array(array())))->addTag('messenger.bus', array('name' => $name)));
-
-            if (isset($bus['class'])) {
-                $container->setAlias($bus['class'], $busId);
+            $tagAttributes = array('name' => $name);
+            if (isset($bus['decorator_class'])) {
+                $tagAttributes['decorator_class'] = $bus['decorator_class'];
             }
 
+            $container->setParameter($busId.'.middlewares', $middlewares);
+            $container->setDefinition($busId, (new Definition(MessageBus::class, array(array())))->addTag('messenger.bus', $tagAttributes));
+
             if ($name === $config['default_bus']) {
                 $container->setAlias('message_bus', $busId);
                 $container->setAlias(MessageBusInterface::class, $busId);

diff --git a/src/Symfony/Component/Messenger/DecoratedMessageBus.php b/src/Symfony/Component/Messenger/DecoratedMessageBus.php
@@ -0,0 +1,38 @@
+<?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\Component\Messenger;
+
+/**
+ * A decorated message bus.
+ *
+ * Use this abstract class to created your message bus decorator to specialise your
+ * bus instances and type-hint them.
+ *
+ * @author Samuel Roze <samuel.roze@gmail.com>
+ */
+abstract class DecoratedMessageBus implements MessageBusInterface
+{
+    private $decoratedBus;
+
+    public function __construct(MessageBusInterface $decoratedBus)
+    {
+        $this->decoratedBus = $decoratedBus;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function dispatch($message)
+    {
+        return $this->decoratedBus->dispatch($message);
+    }
+}
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -63,6 +63,12 @@ public function process(ContainerBuilder $container)
             if ($container->hasDefinition('messenger.data_collector')) {
                 $this->registerBusToCollector($container, $busId, $tags[0]);
             }
+
+            if (isset($tags[0]['decorator_class'])) {
+                $container->register($tags[0]['decorator_class'], $tags[0]['decorator_class'])
+                    ->setDecoratedService($busId)
+                    ->setArguments(array(new Reference($tags[0]['decorator_class'].'.inner')));
+            }
         }
 
         $this->registerReceivers($container);

diff --git a/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php b/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Messenger\Adapter\AmqpExt\AmqpSender;
 use Symfony\Component\Messenger\ContainerHandlerLocator;
 use Symfony\Component\Messenger\DataCollector\MessengerDataCollector;
+use Symfony\Component\Messenger\DecoratedMessageBus;
 use Symfony\Component\Messenger\DependencyInjection\MessengerPass;
 use Symfony\Component\Messenger\Handler\ChainHandler;
 use Symfony\Component\Messenger\Handler\MessageSubscriberInterface;
@@ -260,6 +261,17 @@ public function testRegistersTraceableBusesToCollector()
         $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 testRegistersBusDecoratedClass()
+    {
+        $container = $this->getContainerBuilder();
+        $container->register($fooBusId = 'messenger.bus.foo', MessageBusInterface::class)->addTag('messenger.bus', array('decorator_class' => MyTypeHintedBus::class));
+
+        (new MessengerPass())->process($container);
+
+        $this->assertTrue($container->hasDefinition(MyTypeHintedBus::class));
+        $this->assertSame(array($fooBusId, null, 0), $container->getDefinition(MyTypeHintedBus::class)->getDecoratedService());
+    }
+
     public function testRegistersMiddlewaresFromServices()
     {
         $container = $this->getContainerBuilder();
@@ -413,3 +425,7 @@ public function handle($messa
7694
ge, callable $next)
         return $next($message);
     }
 }
+
+final class MyTypeHintedBus extends DecoratedMessageBus
+{
+}