bug #53985 [HttpKernel] Allow tagged controllers in ControllerResolver (marein)

nicolas-grekas · nicolas-grekas · commit b701ca3c68f7 · 2024-02-26T09:47:50.000+01:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [HttpKernel] Allow tagged controllers in ControllerResolver | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #52471 | License | MIT If the request attribute `_check_controller_is_allowed` is set, only `TemplateController`, children of `AbstractController` and controllers that have the attribute `#[AsController]` are allowed by default. This change also adds controllers tagged with `controller.service_arguments` to the mix. It allows them to be used with different fragment renderers (e.g. `esi` and `ssi`) without having to add any of the above conditions. This pull request is a follow up of [this discussion](#52471 (comment)). Commits ------- 7d2eb5a [HttpKernel] Allow tagged controllers in ControllerResolver
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
@@ -45,6 +45,7 @@ public function process(ContainerBuilder $container)
 
         $parameterBag = $container->getParameterBag();
         $controllers = [];
+        $controllerClasses = [];
 
         $publicAliases = [];
         foreach ($container->getAliases() as $id => $alias) {
@@ -74,6 +75,8 @@ public function process(ContainerBuilder $container)
                 throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
             }
 
+            $controllerClasses[] = $class;
+
             // get regular public methods
             $methods = [];
             $arguments = [];
@@ -227,5 +230,10 @@ public function process(ContainerBuilder $container)
         }
 
         $container->setAlias('argument_resolver.controller_locator', (string) $controllerLocatorRef);
+
+        if ($container->hasDefinition('controller_resolver')) {
+            $container->getDefinition('controller_resolver')
+                ->addMethodCall('allowControllers', [array_unique($controllerClasses)]);
+        }
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
@@ -557,6 +557,30 @@ public function testTaggedIteratorAndTaggedLocatorAttributes()
         $this->assertTrue($argLocator->has('foo'));
         $this->assertSame('bar', $argLocator->get('foo'));
     }
+
+    public function testTaggedControllersAreRegisteredInControllerResolver()
+    {
+        $container = new ContainerBuilder();
+        $container->register('argument_resolver.service')->addArgument([]);
+        $controllerResolver = $container->register('controller_resolver');
+
+        $container->register('foo', RegisterTestController::class)
+            ->addTag('controller.service_arguments')
+        ;
+
+        // duplicates should be removed
+        $container->register('bar', RegisterTestController::class)
+            ->addTag('controller.service_arguments')
+        ;
+
+        // services with no tag should be ignored
+        $container->register('baz', ControllerDummy::class);
+
+        $pass = new RegisterControllerArgumentLocatorsPass();
+        $pass->process($container);
+
+        $this->assertSame([['allowControllers', [[RegisterTestController::class]]]], $controllerResolver->getMethodCalls());
+    }
 }
 
 class RegisterTestController

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ public function process(ContainerBuilder $container)`
`45`	`45`
`46`	`46`	`$parameterBag = $container->getParameterBag();`
`47`	`47`	`$controllers = [];`
	`48`	`+ $controllerClasses = [];`
`48`	`49`
`49`	`50`	`$publicAliases = [];`
`50`	`51`	`foreach ($container->getAliases() as $id => $alias) {`
`@@ -74,6 +75,8 @@ public function process(ContainerBuilder $container)`
`74`	`75`	`throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));`
`75`	`76`	`}`
`76`	`77`
	`78`	`+ $controllerClasses[] = $class;`
	`79`	`+`
`77`	`80`	`// get regular public methods`
`78`	`81`	`$methods = [];`
`79`	`82`	`$arguments = [];`
`@@ -227,5 +230,10 @@ public function process(ContainerBuilder $container)`
`227`	`230`	`}`
`228`	`231`
`229`	`232`	`$container->setAlias('argument_resolver.controller_locator', (string) $controllerLocatorRef);`
	`233`	`+`
	`234`	`+ if ($container->hasDefinition('controller_resolver')) {`
	`235`	`+ $container->getDefinition('controller_resolver')`
	`236`	`+ ->addMethodCall('allowControllers', [array_unique($controllerClasses)]);`
	`237`	`+ }`
`230`	`238`	`}`
`231`	`239`	`}`