[Messenger] remove AllowNoHandlerMiddleware in favor of a constructor argument on HandleMessageMiddleware

Author: nicolas-grekas

DependencyInjection/Configuration.php

@@ -1081,19 +1081,20 @@ function ($a) {
                         ->arrayNode('buses')
                             ->defaultValue(array('messenger.bus.default' => array('default_middleware' => true, 'middleware' => array())))
                             ->useAttributeAsKey('name')
-                            ->prototype('array')
+                            ->arrayPrototype()
                                 ->addDefaultsIfNotSet()
                                 ->children()
-                                    ->booleanNode('default_middleware')->defaultTrue()->end()
+                                    ->enumNode('default_middleware')
+                                        ->values(array(true, false, 'allow_no_handlers'))
+                                        ->defaultTrue()
+                                    ->end()
                                     ->arrayNode('middleware')
                                         ->beforeNormalization()
-                                            ->ifString()
-                                            ->then(function (string $middleware) {
-                                                return array($middleware);
-                                            })
+                                            ->ifTrue(function ($v) { return \is_string($v) || !\is_int(key($v)); })
+                                            ->then(function ($v) { return array($v); })
                                         ->end()
                                         ->defaultValue(array())
-                                        ->prototype('array')
+                                        ->arrayPrototype()
                                             ->beforeNormalization()
                                                 ->always()
                                                 ->then(function ($middleware): array {
@@ -1103,8 +1104,8 @@ function ($a) {
                                                     if (isset($middleware['id'])) {
                                                         return $middleware;
                                                     }
-                                                    if (\count($middleware) > 1) {
-                                                        throw new \InvalidArgumentException(sprintf('There is an error at path "framework.messenger" in one of the buses middleware definitions: expected a single entry for a middleware item config, with factory id as key and arguments as value. Got "%s".', json_encode($middleware)));
+                                                    if (1 < \count($middleware)) {
+                                                        throw new \InvalidArgumentException(sprintf('Invalid middleware at path "framework.messenger": a map with a single factory id as key and its arguments as value was expected, %s given.', json_encode($middleware)));
                                                     }
 
                                                     return array(

DependencyInjection/FrameworkExtension.php

@@ -1524,7 +1524,16 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             'after' => array(array('id' => 'route_messages'), array('id' => 'call_message_handler')),
         );
         foreach ($config['buses'] as $busId => $bus) {
-            $middleware = $bus['default_middleware'] ? array_merge($defaultMiddleware['before'], $bus['middleware'], $defaultMiddleware['after']) : $bus['middleware'];
+            $middleware = $bus['middleware'];
+
+            if ($bus['default_middleware']) {
+                if ('allow_no_handlers' === $bus['default_middleware']) {
+                    $defaultMiddleware['after'][1]['arguments'] = array(true);
+                } else {
+                    unset($defaultMiddleware['after'][1]['arguments']);
+                }
+                $middleware = array_merge($defaultMiddleware['before'], $middleware, $defaultMiddleware['after']);
+            }
 
             foreach ($middleware as $middlewareItem) {
                 if (!$validationConfig['enabled'] && 'messenger.middleware.validation' === $middlewareItem['id']) {

Resources/config/messenger.xml

@@ -25,7 +25,6 @@
         </service>
 
         <!-- Middleware -->
-        <service id="messenger.middleware.allow_no_handler" class="Symfony\Component\Messenger\Middleware\AllowNoHandlerMiddleware" abstract="true" />
         <service id="messenger.middleware.call_message_handler" class="Symfony\Component\Messenger\Middleware\HandleMessageMiddleware" abstract="true">
             <argument /> <!-- Bus handler resolver -->
         </service>

Resources/config/schema/symfony-1.0.xsd

@@ -331,6 +331,16 @@
         </xsd:sequence>
     </xsd:complexType>
 
+    <xsd:simpleType name="default_middleware">
+        <xsd:restriction base="xsd:string">
+            <xsd:enumeration value="true" />
+            <xsd:enumeration value="false" />
+            <xsd:enumeration value="1" />
+            <xsd:enumeration value="0" />
+            <xsd:enumeration value="allow_no_handlers" />
+        </xsd:restriction>
+    </xsd:simpleType>
+
     <xsd:simpleType name="cookie_secure">
         <xsd:restriction base="xsd:string">
             <xsd:enumeration value="true" />
@@ -408,7 +418,7 @@
             <xsd:element name="middleware" type="messenger_middleware" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
         <xsd:attribute name="name" type="xsd:string" use="required"/>
-        <xsd:attribute name="default-middleware" type="xsd:boolean"/>
+        <xsd:attribute name="default-middleware" type="default_middleware"/>
     </xsd:complexType>
 
     <xsd:complexType name="messenger_middleware">

Tests/DependencyInjection/Fixtures/php/messenger_multiple_buses.php

@@ -8,14 +8,12 @@
             'messenger.bus.events' => array(
                 'middleware' => array(
                     array('with_factory' => array('foo', true, array('bar' => 'baz'))),
-                    'allow_no_handler',
                 ),
             ),
             'messenger.bus.queries' => array(
                 'default_middleware' => false,
                 'middleware' => array(
                     'route_messages',
-                    'allow_no_handler',
                     'call_message_handler',
                 ),
             ),

Tests/DependencyInjection/Fixtures/xml/messenger_multiple_buses.xml

@@ -16,11 +16,9 @@
                         <framework:bar>baz</framework:bar>
                     </framework:argument>
                 </framework:middleware>
-                <framework:middleware id="allow_no_handler" />
             </framework:bus>
             <framework:bus name="messenger.bus.queries" default-middleware="false">
                 <framework:middleware id="route_messages" />
-                <framework:middleware id="allow_no_handler" />
                 <framework:middleware id="call_message_handler" />
             </framework:bus>
         </framework:messenger>

Tests/DependencyInjection/Fixtures/yml/messenger_multiple_buses.yml

@@ -6,10 +6,8 @@ framework:
             messenger.bus.events:
                 middleware:
                     - with_factory: [foo, true, { bar: baz }]
-                    - "allow_no_handler"
             messenger.bus.queries:
                 default_middleware: false
                 middleware:
                     - "route_messages"
-                    - "allow_no_handler"
                     - "call_message_handler"

Tests/DependencyInjection/FrameworkExtensionTest.php

@@ -627,15 +627,13 @@ public function testMessengerWithMultipleBuses()
         $this->assertEquals(array(
             array('id' => 'logging'),
             array('id' => 'with_factory', 'arguments' => array('foo', true, array('bar' => 'baz'))),
-            array('id' => 'allow_no_handler', 'arguments' => array()),
             array('id' => 'route_messages'),
             array('id' => 'call_message_handler'),
         ), $container->getParameter('messenger.bus.events.middleware'));
         $this->assertTrue($container->has('messenger.bus.queries'));
         $this->assertSame(array(), $container->getDefinition('messenger.bus.queries')->getArgument(0));
         $this->assertEquals(array(
             array('id' => 'route_messages', 'arguments' => array()),
-            array('id' => 'allow_no_handler', 'arguments' => array()),
             array('id' => 'call_message_handler', 'arguments' => array()),
         ), $container->getParameter('messenger.bus.queries.middleware'));
 
@@ -645,7 +643,7 @@ public function testMessengerWithMultipleBuses()
 
     /**
      * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage There is an error at path "framework.messenger" in one of the buses middleware definitions: expected a single entry for a middleware item config, with factory id as key and arguments as value. Got "{"foo":["qux"],"bar":["baz"]}"
+     * @expectedExceptionMessage Invalid middleware at path "framework.messenger": a map with a single factory id as key and its arguments as value was expected, {"foo":["qux"],"bar":["baz"]} given.
      */
     public function testMessengerMiddlewareFactoryErroneousFormat()
     {