[DI] Allow service subscribers to leverage autowiring to know where t…

…he locator should be injected
symfony · fabpot · Apr 25, 2017 · Apr 17, 2017 · Apr 19, 2017 · e407b3d42e9adff4e82df05b7f62b0363e9f685c
commit e407b3d42e9adff4e82df05b7f62b0363e9f685c
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
@@ -29,7 +29,7 @@
        <service id="twig.cache_warmer" class="Symfony\Bundle\TwigBundle\CacheWarmer\TemplateCacheCacheWarmer" public="false">
            <tag name="kernel.cache_warmer" />
            <tag name="container.service_subscriber" id="twig" />
-            <argument type="service" id="container" />
+            <argument type="service" id="Psr\Container\ContainerInterface" />
            <argument type="service" id="templating.finder" on-invalid="ignore" />
            <argument type="collection" /> <!-- Twig paths -->
        </service>

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
@@ -59,6 +59,7 @@ public function __construct()
            new RegisterServiceSubscribersPass(),
            new ResolveNamedArgumentsPass(),
            new AutowirePass(),
+            new ResolveServiceSubscribersPass(),
            new ResolveReferencesToAliasesPass(),
            new ResolveInvalidReferencesPass(),
            new AnalyzeServiceReferencesPass(true),

diff --git a/src/Symfony/Component/DependencyInjection/Compiler/RegisterServiceSubscribersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/RegisterServiceSubscribersPass.php
@@ -25,14 +25,8 @@
 */
 class RegisterServiceSubscribersPass extends AbstractRecursivePass
 {
-    private $serviceLocator;
-
    protected function processValue($value, $isRoot = false)
    {
-        if ($value instanceof Reference && $this->serviceLocator && 'container' === (string) $value) {
-            return new Reference($this->serviceLocator);
-        }
-
        if (!$value instanceof Definition || $value->isAbstract() || $value->isSynthetic() || !$value->hasTag('container.service_subscriber')) {
            return parent::processValue($value, $isRoot);
        }
@@ -100,13 +94,8 @@ protected function processValue($value, $isRoot = false)
            throw new InvalidArgumentException(sprintf('Service %s not exist in the map returned by "%s::getSubscribedServices()" for service "%s".', $message, $class, $this->currentId));
        }

-        $serviceLocator = $this->serviceLocator;
-        $this->serviceLocator = (string) ServiceLocatorTagPass::register($this->container, $subscriberMap);
+        $value->addTag('container.service_subscriber.locator', array('id' => (string) ServiceLocatorTagPass::register($this->container, $subscriberMap)));

-        try {
-            return parent::processValue($value);
-        } finally {
-            $this->serviceLocator = $serviceLocator;
-        }
+        return parent::processValue($value);
    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveServiceSubscribersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveServiceSubscribersPass.php
@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Compiler;
+
+use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * Compiler pass to inject their service locator to service subscribers.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+class ResolveServiceSubscribersPass extends AbstractRecursivePass
+{
+    private $serviceLocator;
+
+    protected function processValue($value, $isRoot = false)
+    {
+        if ($value instanceof Reference && $this->serviceLocator && ContainerInterface::class === (string) $value) {
+            return new Reference($this->serviceLocator);
+        }
+
+        if (!$value instanceof Definition) {
+            return parent::processValue($value, $isRoot);
+        }
+
+        $serviceLocator = $this->serviceLocator;
+        $this->serviceLocator = $value->hasTag('container.service_subscriber.locator') ? $value->getTag('container.service_subscriber.locator')[0]['id'] : null;
+
+        try {
+            return parent::processValue($value);
+        } finally {
+            $this->serviceLocator = $serviceLocator;
+        }
+    }
+}
diff --git a/...mfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php b/...mfony/Component/DependencyInjection/Tests/Compiler/RegisterServiceSubscribersPassTest.php
@@ -12,8 +12,10 @@
 namespace Symfony\Component\DependencyInjection\Tests\Compiler;

 use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Symfony\Component\DependencyInjection\Argument\ServiceClosureArgument;
 use Symfony\Component\DependencyInjection\Compiler\RegisterServiceSubscribersPass;
+use Symfony\Component\DependencyInjection\Compiler\ResolveServiceSubscribersPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Reference;
@@ -38,8 +40,8 @@ public function testInvalidClass()
            ->addTag('container.service_subscriber')
        ;

-        $pass = new RegisterServiceSubscribersPass();
-        $pass->process($container);
+        (new RegisterServiceSubscribersPass())->process($container);
+        (new ResolveServiceSubscribersPass())->process($container);
    }

    /**
@@ -54,21 +56,21 @@ public function testInvalidAttributes()
            ->addTag('container.service_subscriber', array('bar' => '123'))
        ;

-        $pass = new RegisterServiceSubscribersPass();
-        $pass->process($container);
+        (new RegisterServiceSubscribersPass())->process($container);
+        (new ResolveServiceSubscribersPass())->process($container);
    }

    public function testNoAttributes()
    {
        $container = new ContainerBuilder();

        $container->register('foo', TestServiceSubscriber::class)
-            ->addArgument(new Reference('container'))
+            ->addArgument(new Reference(PsrContainerInterface::class))
            ->addTag('container.service_subscriber')
        ;

-        $pass = new RegisterServiceSubscribersPass();
-        $pass->process($container);
+        (new RegisterServiceSubscribersPass())->process($container);
+        (new ResolveServiceSubscribersPass())->process($container);

        $foo = $container->getDefinition('foo');
        $locator = $container->getDefinition((string) $foo->getArgument(0));
@@ -92,13 +94,13 @@ public function testWithAttributes()

        $container->register('foo', TestServiceSubscriber::class)
            ->setAutowired(true)
-            ->addArgument(new Reference('container'))
+            ->addArgument(new Reference(PsrContainerInterface::class))
            ->addTag('container.service_subscriber', array('key' => 'bar', 'id' => 'bar'))
            ->addTag('container.service_subscriber', array('key' => 'bar', 'id' => 'baz')) // should be ignored: the first wins
        ;

-        $pass = new RegisterServiceSubscribersPass();
-        $pass->process($container);
+        (new RegisterServiceSubscribersPass())->process($container);
+        (new ResolveServiceSubscribersPass())->process($container);

        $foo = $container->getDefinition('foo');
        $locator = $container->getDefinition((string) $foo->getArgument(0));
@@ -125,7 +127,7 @@ public function testExtraServiceSubscriber()
        $container = new ContainerBuilder();
        $container->register('foo_service', TestServiceSubscriber::class)
            ->setAutowired(true)
-            ->addArgument(new Reference('container'))
+            ->addArgument(new Reference(PsrContainerInterface::class))
            ->addTag('container.service_subscriber', array(
                'key' => 'test',
                'id' => TestServiceSubscriber::class,

diff --git a/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php b/src/Symfony/Component/DependencyInjection/Tests/Dumper/PhpDumperTest.php
@@ -13,6 +13,7 @@

 use DummyProxyDumper;
 use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
@@ -560,7 +561,7 @@ public function testServiceSubscriber()
        $container = new ContainerBuilder();
        $container->register('foo_service', TestServiceSubscriber::class)
            ->setAutowired(true)
-            ->addArgument(new Reference('container'))
+            ->addArgument(new Reference(ContainerInterface::class))
            ->addTag('container.service_subscriber', array(
                'key' => 'bar',
                'id' => TestServiceSubscriber::class,