From ad59e1804f71b4158eb4785b959b7b6bde1068d1 Mon Sep 17 00:00:00 2001
From: Robin Chalas <robin.chalas@gmail.com>
Date: Fri, 7 Apr 2017 14:05:50 +0200
Subject: [PATCH] Skip ContainerAwareInterface::setContainer from
 service_arguments actions registration

---
 ...RegisterControllerArgumentLocatorsPass.php |  6 +++++
 ...sterControllerArgumentLocatorsPassTest.php | 26 +++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
index a106866ec09f4..5846bbb65a53c 100644
--- a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
+++ b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
@@ -11,9 +11,11 @@
 
 namespace Symfony\Component\HttpKernel\DependencyInjection;
 
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
@@ -65,11 +67,15 @@ public function process(ContainerBuilder $container)
             if (!$r = $container->getReflectionClass($class)) {
                 throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
             }
+            $isContainerAware = $r->implementsInterface(ContainerAwareInterface::class) || is_subclass_of($class, AbstractController::class);
 
             // get regular public methods
             $methods = array();
             $arguments = array();
             foreach ($r->getMethods(\ReflectionMethod::IS_PUBLIC) as $r) {
+                if ('setContainer' === $r->name && $isContainerAware) {
+                    continue;
+                }
                 if (!$r->isConstructor() && !$r->isDestructor() && !$r->isAbstract()) {
                     $methods[strtolower($r->name)] = array($r, $r->getParameters());
                 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
index bfae7efde304b..cf1bfdd56d153 100644
--- a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
+++ b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
@@ -13,6 +13,8 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\ServiceLocator;
@@ -187,6 +189,21 @@ public function testOptionalArgument()
         $expected = array('bar' => new ServiceClosureArgument(new TypedReference('bar', ControllerDummy::class, RegisterTestController::class, ContainerInterface::IGNORE_ON_INVALID_REFERENCE)));
         $this->assertEquals($expected, $locator->getArgument(0));
     }
+
+    public function testSkipSetContainer()
+    {
+        $container = new ContainerBuilder();
+        $resolver = $container->register('argument_resolver.service')->addArgument(array());
+
+        $container->register('foo', ContainerAwareRegisterTestController::class)
+            ->addTag('controller.service_arguments');
+
+        $pass = new RegisterControllerArgumentLocatorsPass();
+        $pass->process($container);
+
+        $locator = $container->getDefinition((string) $resolver->getArgument(0))->getArgument(0);
+        $this->assertSame(array('foo:fooAction'), array_keys($locator));
+    }
 }
 
 class RegisterTestController
@@ -204,6 +221,15 @@ protected function barAction(ControllerDummy $bar)
     }
 }
 
+class ContainerAwareRegisterTestController implements ContainerAwareInterface
+{
+    use ContainerAwareTrait;
+
+    public function fooAction(ControllerDummy $bar)
+    {
+    }
+}
+
 class ControllerDummy
 {
 }