bug #27214 [HttpKernel] Fix services are no longer injected into __invoke controllers method (ogizanagi)

fabpot · fabpot · commit 6d3e8dfc6af5 · 2018-05-14T08:47:00.000+02:00
This PR was merged into the 4.1 branch. Discussion ---------- [HttpKernel] Fix services are no longer injected into __invoke controllers method | Q | A | ------------- | --- | Branch? | 4.1  | Bug fix? | yes | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | #27208  | License | MIT | Doc PR | N/A _TL;DR:_ The `RemoveEmptyControllerArgumentLocatorsPass` is the one adding the `Controller::_invoke` => `Controller` shortcut missing from the service locator. It isn't properly executed on some cases. This fixes it. Since symfony/symfony#26833, the resolvers are decorated by a `TraceableValueResolver`, which usually isn't much an issue to deal within passes. But the `RemoveEmptyControllerArgumentLocatorsPass` happens late (`TYPE_BEFORE_REMOVING`), when decoration inheritance is already resolved, so accessing `$controllerLocator = $container->getDefinition((string) $serviceResolver->getArgument(0));` isn't accessing the controller locator, but the decorated service instead. Commits ------- ee44903 [HttpKernel] Fix services are no longer injected into __invoke controllers method
diff --git a/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
@@ -33,11 +33,13 @@ class RegisterControllerArgumentLocatorsPass implements CompilerPassInterface
 {
     private $resolverServiceId;
     private $controllerTag;
+    private $controllerLocator;
 
-    public function __construct(string $resolverServiceId = 'argument_resolver.service', string $controllerTag = 'controller.service_arguments')
+    public function __construct(string $resolverServiceId = 'argument_resolver.service', string $controllerTag = 'controller.service_arguments', string $controllerLocator = 'argument_resolver.controller_locator')
     {
         $this->resolverServiceId = $resolverServiceId;
         $this->controllerTag = $controllerTag;
+        $this->controllerLocator = $controllerLocator;
     }
 
     public function process(ContainerBuilder $container)
@@ -179,6 +181,8 @@ public function process(ContainerBuilder $container)
         }
 
         $container->getDefinition($this->resolverServiceId)
-            ->replaceArgument(0, ServiceLocatorTagPass::register($container, $controllers));
+            ->replaceArgument(0, $controllerLocatorRef = ServiceLocatorTagPass::register($container, $controllers));
+
+        $container->setAlias($this->controllerLocator, (string) $controllerLocatorRef);
     }
 }
diff --git a/DependencyInjection/RemoveEmptyControllerArgumentLocatorsPass.php b/DependencyInjection/RemoveEmptyControllerArgumentLocatorsPass.php
@@ -21,21 +21,16 @@
  */
 class RemoveEmptyControllerArgumentLocatorsPass implements CompilerPassInterface
 {
-    private $resolverServiceId;
+    private $controllerLocator;
 
-    public function __construct(string $resolverServiceId = 'argument_resolver.service')
+    public function __construct(string $controllerLocator = 'argument_resolver.controller_locator')
     {
-        $this->resolverServiceId = $resolverServiceId;
+        $this->controllerLocator = $controllerLocator;
     }
 
     public function process(ContainerBuilder $container)
     {
-        if (false === $container->hasDefinition($this->resolverServiceId)) {
-            return;
-        }
-
-        $serviceResolver = $container->getDefinition($this->resolverServiceId);
-        $controllerLocator = $container->getDefinition((string) $serviceResolver->getArgument(0));
+        $controllerLocator = $container->findDefinition($this->controllerLocator);
         $controllers = $controllerLocator->getArgument(0);
 
         foreach ($controllers as $controller => $argumentRef) {

Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,13 @@ class RegisterControllerArgumentLocatorsPass implements CompilerPassInterface`
`33`	`33`	`{`
`34`	`34`	`private $resolverServiceId;`
`35`	`35`	`private $controllerTag;`
	`36`	`+ private $controllerLocator;`
`36`	`37`
`37`		`- public function __construct(string $resolverServiceId = 'argument_resolver.service', string $controllerTag = 'controller.service_arguments')`
	`38`	`+ public function __construct(string $resolverServiceId = 'argument_resolver.service', string $controllerTag = 'controller.service_arguments', string $controllerLocator = 'argument_resolver.controller_locator')`
`38`	`39`	`{`
`39`	`40`	`$this->resolverServiceId = $resolverServiceId;`
`40`	`41`	`$this->controllerTag = $controllerTag;`
	`42`	`+ $this->controllerLocator = $controllerLocator;`
`41`	`43`	`}`
`42`	`44`
`43`	`45`	`public function process(ContainerBuilder $container)`
`@@ -179,6 +181,8 @@ public function process(ContainerBuilder $container)`
`179`	`181`	`}`
`180`	`182`
`181`	`183`	`$container->getDefinition($this->resolverServiceId)`
`182`		`- ->replaceArgument(0, ServiceLocatorTagPass::register($container, $controllers));`
	`184`	`+ ->replaceArgument(0, $controllerLocatorRef = ServiceLocatorTagPass::register($container, $controllers));`
	`185`	`+`
	`186`	`+ $container->setAlias($this->controllerLocator, (string) $controllerLocatorRef);`
`183`	`187`	`}`
`184`	`188`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,21 +21,16 @@`
`21`	`21`	`*/`
`22`	`22`	`class RemoveEmptyControllerArgumentLocatorsPass implements CompilerPassInterface`
`23`	`23`	`{`
`24`		`- private $resolverServiceId;`
	`24`	`+ private $controllerLocator;`
`25`	`25`
`26`		`- public function __construct(string $resolverServiceId = 'argument_resolver.service')`
	`26`	`+ public function __construct(string $controllerLocator = 'argument_resolver.controller_locator')`
`27`	`27`	`{`
`28`		`- $this->resolverServiceId = $resolverServiceId;`
	`28`	`+ $this->controllerLocator = $controllerLocator;`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`public function process(ContainerBuilder $container)`
`32`	`32`	`{`
`33`		`- if (false === $container->hasDefinition($this->resolverServiceId)) {`
`34`		`- return;`
`35`		`- }`
`36`		`-`
`37`		`- $serviceResolver = $container->getDefinition($this->resolverServiceId);`
`38`		`- $controllerLocator = $container->getDefinition((string) $serviceResolver->getArgument(0));`
	`33`	`+ $controllerLocator = $container->findDefinition($this->controllerLocator);`
`39`	`34`	`$controllers = $controllerLocator->getArgument(0);`
`40`	`35`
`41`	`36`	`foreach ($controllers as $controller => $argumentRef) {`