bug #37569 [Messenger] Allow same middleware to be used multiple times with different arguments (HypeMC)

nicolas-grekas · nicolas-grekas · commit 0d867bcc0dd2 · 2020-07-23T11:57:42.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Messenger] Allow same middleware to be used multiple times with different arguments | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #37568 | License | MIT | Doc PR | - Middleware service names now take into account arguments as well to allow the same middleware to be used multiple times with different arguments: ```yaml framework: messenger: buses: messenger.bus.default: middleware: - doctrine_ping_connection: ['main'] - doctrine_ping_connection: ['logs'] ``` Commits ------- d10e43d Allow same middleware to be used multiple times with different arguments
diff --git a/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php b/src/Symfony/Component/Messenger/DependencyInjection/MessengerPass.php
@@ -339,7 +339,7 @@ private function registerBusMiddleware(ContainerBuilder $container, string $busI
             if ($container->findDefinition($messengerMiddlewareId)->isAbstract()) {
                 $childDefinition = new ChildDefinition($messengerMiddlewareId);
                 $childDefinition->setArguments($arguments);
-                $container->setDefinition($messengerMiddlewareId = $busId.'.middleware.'.$id, $childDefinition);
+                $container->setDefinition($messengerMiddlewareId = $busId.'.middleware.'.$id.'.'.ContainerBuilder::hash($arguments), $childDefinition);
             } elseif ($arguments) {
                 throw new RuntimeException(sprintf('Invalid middleware factory "%s": a middleware factory must be an abstract definition.', $id));
             }
diff --git a/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php b/src/Symfony/Component/Messenger/Tests/DependencyInjection/MessengerPassTest.php
@@ -508,21 +508,35 @@ public function testRegistersMiddlewareFromServices()
 
         $container->setParameter($middlewareParameter = $fooBusId.'.middleware', [
             ['id' => UselessMiddleware::class],
-            ['id' => 'middleware_with_factory', 'arguments' => ['index_0' => 'foo', 'bar']],
+            ['id' => 'middleware_with_factory', 'arguments' => $factoryChildMiddlewareArgs1 = ['index_0' => 'foo', 'bar']],
+            ['id' => 'middleware_with_factory', 'arguments' => $factoryChildMiddlewareArgs2 = ['index_0' => 'baz']],
             ['id' => 'middleware_with_factory_using_default'],
         ]);
 
         (new MessengerPass())->process($container);
         (new ResolveChildDefinitionsPass())->process($container);
 
-        $this->assertTrue($container->hasDefinition($factoryChildMiddlewareId = $fooBusId.'.middleware.middleware_with_factory'));
+        $this->assertTrue($container->hasDefinition(
+            $factoryChildMiddlewareArgs1Id = $fooBusId.'.middleware.middleware_with_factory.'.ContainerBuilder::hash($factoryChildMiddlewareArgs1)
+        ));
         $this->assertEquals(
             ['foo', 'bar'],
-            $container->getDefinition($factoryChildMiddlewareId)->getArguments(),
+            $container->getDefinition($factoryChildMiddlewareArgs1Id)->getArguments(),
             'parent default argument is overridden, and next ones appended'
         );
 
-        $this->assertTrue($container->hasDefinition($factoryWithDefaultChildMiddlewareId = $fooBusId.'.middleware.middleware_with_factory_using_default'));
+        $this->assertTrue($container->hasDefinition(
+            $factoryChildMiddlewareArgs2Id = $fooBusId.'.middleware.middleware_with_factory.'.ContainerBuilder::hash($factoryChildMiddlewareArgs2)
+        ));
+        $this->assertEquals(
+            ['baz'],
+            $container->getDefinition($factoryChildMiddlewareArgs2Id)->getArguments(),
+            'parent default argument is overridden, and next ones appended'
+        );
+
+        $this->assertTrue($container->hasDefinition(
+            $factoryWithDefaultChildMiddlewareId = $fooBusId.'.middleware.middleware_with_factory_using_default.'.ContainerBuilder::hash([])
+        ));
         $this->assertEquals(
             ['some_default'],
             $container->getDefinition($factoryWithDefaultChildMiddlewareId)->getArguments(),
@@ -531,7 +545,8 @@ public function testRegistersMiddlewareFromServices()
 
         $this->assertEquals([
             new Reference(UselessMiddleware::class),
-            new Reference($factoryChildMiddlewareId),
+            new Reference($factoryChildMiddlewareArgs1Id),
+            new Reference($factoryChildMiddlewareArgs2Id),
             new Reference($factoryWithDefaultChildMiddlewareId),
         ], $container->getDefinition($fooBusId)->getArgument(0)->getValues());
         $this->assertFalse($container->hasParameter($middlewareParameter));

Original file line number	Diff line number	Diff line change
`@@ -339,7 +339,7 @@ private function registerBusMiddleware(ContainerBuilder $container, string $busI`
`339`	`339`	`if ($container->findDefinition($messengerMiddlewareId)->isAbstract()) {`
`340`	`340`	`$childDefinition = new ChildDefinition($messengerMiddlewareId);`
`341`	`341`	`$childDefinition->setArguments($arguments);`
`342`		`- $container->setDefinition($messengerMiddlewareId = $busId.'.middleware.'.$id, $childDefinition);`
	`342`	`+ $container->setDefinition($messengerMiddlewareId = $busId.'.middleware.'.$id.'.'.ContainerBuilder::hash($arguments), $childDefinition);`
`343`	`343`	`} elseif ($arguments) {`
`344`	`344`	`throw new RuntimeException(sprintf('Invalid middleware factory "%s": a middleware factory must be an abstract definition.', $id));`
`345`	`345`	`}`