[DI] Fix autowire error for inlined services

weaverryan · nicolas-grekas · commit 4bcef3d67c23 · 2017-05-23T10:56:44.000+02:00
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AutowireExceptionPass.php b/src/Symfony/Component/DependencyInjection/Compiler/AutowireExceptionPass.php
@@ -21,16 +21,30 @@
 class AutowireExceptionPass implements CompilerPassInterface
 {
     private $autowirePass;
+    private $inlineServicePass;
 
-    public function __construct(AutowirePass $autowirePass)
+    public function __construct(AutowirePass $autowirePass, InlineServiceDefinitionsPass $inlineServicePass)
     {
         $this->autowirePass = $autowirePass;
+        $this->inlineServicePass = $inlineServicePass;
     }
 
     public function process(ContainerBuilder $container)
     {
-        foreach ($this->autowirePass->getAutowiringExceptions() as $exception) {
-            if ($container->hasDefinition($exception->getServiceId())) {
+        // the pass should only be run once
+        if (null === $this->autowirePass || null === $this->inlineServicePass) {
+            return;
+        }
+
+        $inlinedIds = $this->inlineServicePass->getInlinedServiceIds();
+        $exceptions = $this->autowirePass->getAutowiringExceptions();
+
+        // free up references
+        $this->autowirePass = null;
+        $this->inlineServicePass = null;
+
+        foreach ($exceptions as $exception) {
+            if ($container->hasDefinition($exception->getServiceId()) || in_array($exception->getServiceId(), $inlinedIds)) {
                 throw $exception;
             }
         }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/InlineServiceDefinitionsPass.php
@@ -23,6 +23,7 @@
 class InlineServiceDefinitionsPass extends AbstractRecursivePass implements RepeatablePassInterface
 {
     private $repeatedPass;
+    private $inlinedServiceIds = array();
 
     /**
      * {@inheritdoc}
@@ -32,6 +33,16 @@ public function setRepeatedPass(RepeatedPass $repeatedPass)
         $this->repeatedPass = $repeatedPass;
     }
 
+    /**
+     * Returns an array of all services inlined by this pass.
+     *
+     * @return array Service id strings
+     */
+    public function getInlinedServiceIds()
+    {
+        return $this->inlinedServiceIds;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -46,6 +57,7 @@ protected function processValue($value, $isRoot = false)
 
             if ($this->isInlineableDefinition($id, $definition, $this->container->getCompiler()->getServiceReferenceGraph())) {
                 $this->container->log($this, sprintf('Inlined service "%s" to "%s".', $id, $this->currentId));
+                $this->inlinedServiceIds[] = $id;
 
                 if ($definition->isShared()) {
                     return $definition;
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php b/src/Symfony/Component/DependencyInjection/Compiler/PassConfig.php
@@ -73,11 +73,11 @@ public function __construct()
             new RemoveAbstractDefinitionsPass(),
             new RepeatedPass(array(
                 new AnalyzeServiceReferencesPass(),
-                new InlineServiceDefinitionsPass(),
+                $inlinedServicePass = new InlineServiceDefinitionsPass(),
                 new AnalyzeServiceReferencesPass(),
                 new RemoveUnusedDefinitionsPass(),
             )),
-            new AutowireExceptionPass($autowirePass),
+            new AutowireExceptionPass($autowirePass, $inlinedServicePass),
             new CheckExceptionOnInvalidReferenceBehaviorPass(),
         ));
     }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowireExceptionPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowireExceptionPassTest.php
@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\Compiler\AutowireExceptionPass;
 use Symfony\Component\DependencyInjection\Compiler\AutowirePass;
+use Symfony\Component\DependencyInjection\Compiler\InlineServiceDefinitionsPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Exception\AutowiringFailedException;
 
@@ -29,10 +30,45 @@ public function testThrowsException()
             ->method('getAutowiringExceptions')
             ->will($this->returnValue(array($autowireException)));
 
+        $inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
+            ->getMock();
+        $inlinePass->expects($this->any())
+            ->method('getInlinedServiceIds')
+            ->will($this->returnValue(array()));
+
         $container = new ContainerBuilder();
         $container->register('foo_service_id');
 
-        $pass = new AutowireExceptionPass($autowirePass);
+        $pass = new AutowireExceptionPass($autowirePass, $inlinePass);
+
+        try {
+            $pass->process($container);
+            $this->fail('->process() should throw the exception if the service id exists');
+        } catch (\Exception $e) {
+            $this->assertSame($autowireException, $e);
+        }
+    }
+
+    public function testThrowExceptionIfServiceInlined()
+    {
+        $autowirePass = $this->getMockBuilder(AutowirePass::class)
+            ->getMock();
+
+        $autowireException = new AutowiringFailedException('foo_service_id', 'An autowiring exception message');
+        $autowirePass->expects($this->any())
+            ->method('getAutowiringExceptions')
+            ->will($this->returnValue(array($autowireException)));
+
+        $inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
+            ->getMock();
+        $inlinePass->expects($this->any())
+            ->method('getInlinedServiceIds')
+            ->will($this->returnValue(array('foo_service_id')));
+
+        // don't register the foo_service_id service
+        $container = new ContainerBuilder();
+
+        $pass = new AutowireExceptionPass($autowirePass, $inlinePass);
 
         try {
             $pass->process($container);
@@ -52,9 +88,15 @@ public function testNoExceptionIfServiceRemoved()
             ->method('getAutowiringExceptions')
             ->will($this->returnValue(array($autowireException)));
 
+        $inlinePass = $this->getMockBuilder(InlineServiceDefinitionsPass::class)
+            ->getMock();
+        $inlinePass->expects($this->any())
+            ->method('getInlinedServiceIds')
+            ->will($this->returnValue(array()));
+
         $container = new ContainerBuilder();
 
-        $pass = new AutowireExceptionPass($autowirePass);
+        $pass = new AutowireExceptionPass($autowirePass, $inlinePass);
 
         $pass->process($container);
         // mark the test as passed
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/InlineServiceDefinitionsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/InlineServiceDefinitionsPassTest.php
@@ -252,6 +252,30 @@ public function testProcessDoesNotSetLazyArgumentValuesAfterInlining()
         $this->assertSame('inline', (string) $values[0]);
     }
 
+    public function testGetInlinedServiceIds()
+    {
+        $container = new ContainerBuilder();
+        $container
+            ->register('inlinable.service')
+            ->setPublic(false)
+        ;
+        $container
+            ->register('non_inlinable.service')
+            ->setPublic(true)
+        ;
+
+        $container
+            ->register('service')
+            ->setArguments(array(new Reference('inlinable.service')))
+        ;
+
+        $inlinePass = new InlineServiceDefinitionsPass();
+        $repeatedPass = new RepeatedPass(array(new AnalyzeServiceReferencesPass(), $inlinePass));
+        $repeatedPass->process($container);
+
+        $this->assertEquals(array('inlinable.service'), $inlinePass->getInlinedServiceIds());
+    }
+
     protected function process(ContainerBuilder $container)
     {
         $repeatedPass = new RepeatedPass(array(new AnalyzeServiceReferencesPass(), new InlineServiceDefinitionsPass()));

Original file line number	Diff line number	Diff line change
`@@ -21,16 +21,30 @@`
`21`	`21`	`class AutowireExceptionPass implements CompilerPassInterface`
`22`	`22`	`{`
`23`	`23`	`private $autowirePass;`
	`24`	`+ private $inlineServicePass;`
`24`	`25`
`25`		`- public function __construct(AutowirePass $autowirePass)`
	`26`	`+ public function __construct(AutowirePass $autowirePass, InlineServiceDefinitionsPass $inlineServicePass)`
`26`	`27`	`{`
`27`	`28`	`$this->autowirePass = $autowirePass;`
	`29`	`+ $this->inlineServicePass = $inlineServicePass;`
`28`	`30`	`}`
`29`	`31`
`30`	`32`	`public function process(ContainerBuilder $container)`
`31`	`33`	`{`
`32`		`- foreach ($this->autowirePass->getAutowiringExceptions() as $exception) {`
`33`		`- if ($container->hasDefinition($exception->getServiceId())) {`
	`34`	`+ // the pass should only be run once`
	`35`	`+ if (null === $this->autowirePass \|\| null === $this->inlineServicePass) {`
	`36`	`+ return;`
	`37`	`+ }`
	`38`	`+`
	`39`	`+ $inlinedIds = $this->inlineServicePass->getInlinedServiceIds();`
	`40`	`+ $exceptions = $this->autowirePass->getAutowiringExceptions();`
	`41`	`+`
	`42`	`+ // free up references`
	`43`	`+ $this->autowirePass = null;`
	`44`	`+ $this->inlineServicePass = null;`
	`45`	`+`
	`46`	`+ foreach ($exceptions as $exception) {`
	`47`	`+ if ($container->hasDefinition($exception->getServiceId()) \|\| in_array($exception->getServiceId(), $inlinedIds)) {`
`34`	`48`	`throw $exception;`
`35`	`49`	`}`
`36`	`50`	`}`