feature #16464 [DependencyInjection] Fix some edge cases with autowiring (dunglas)

fabpot · fabpot · commit 0e66da8abb77 · 2015-11-07T09:14:48.000+01:00
This PR was merged into the 2.8 branch. Discussion ---------- [DependencyInjection] Fix some edge cases with autowiring | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Enhance the autowiring system: - Works with parent definitions and decorator - Always exclude parent definitions It allows to autowire major services of the standard edition (tested with Swift Mailer, Monolog, Doctrine and Twig). Commits ------- faefc60 [DependencyInjection] Autowing: exclude abstract definitons 71d502a [DependencyInjection] Autowiring: support parent/decorators
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php
@@ -138,7 +138,8 @@ private function populateAvailableTypes()
      */
     private function populateAvailableType($id, Definition $definition)
     {
-        if (!$definition->getClass()) {
+        // Never use abstract services
+        if ($definition->isAbstract()) {
             return;
         }
 
@@ -147,6 +148,11 @@ private function populateAvailableType($id, Definition $definition)
             $this->types[$type] = $id;
         }
 
+        // Cannot use reflection if the class isn't set
+        if (!$definition->getClass()) {
+            return;
+        }
+
         if ($reflectionClass = $this->getReflectionClass($id, $definition)) {
             $this->extractInterfaces($id, $reflectionClass);
             $this->extractAncestors($id, $reflectionClass);
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveDefinitionTemplatesPass.php
@@ -118,6 +118,7 @@ private function resolveDefinition(ContainerBuilder $container, DefinitionDecora
         $def->setArguments($parentDef->getArguments());
         $def->setMethodCalls($parentDef->getMethodCalls());
         $def->setProperties($parentDef->getProperties());
+        $def->setAutowiringTypes($parentDef->getAutowiringTypes());
         if ($parentDef->getFactoryClass(false)) {
             $def->setFactoryClass($parentDef->getFactoryClass(false));
         }
@@ -202,6 +203,11 @@ private function resolveDefinition(ContainerBuilder $container, DefinitionDecora
             $def->setMethodCalls(array_merge($def->getMethodCalls(), $calls));
         }
 
+        // merge autowiring types
+        foreach ($definition->getAutowiringTypes() as $autowiringType) {
+            $def->addAutowiringType($autowiringType);
+        }
+
         // these attributes are always taken from the child
         $def->setAbstract($definition->isAbstract());
         $def->setScope($definition->getScope(false), false);
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php
@@ -189,7 +189,7 @@ public function testOptionalParameter()
         $this->assertEquals('foo', $definition->getArgument(2));
     }
 
-    public function testDontTriggeruAutowiring()
+    public function testDontTriggerAutowiring()
     {
         $container = new ContainerBuilder();
 
@@ -216,6 +216,21 @@ public function testClassNotFoundThrowsException()
         $pass = new AutowirePass();
         $pass->process($container);
     }
+
+    public function testDontUseAbstractServices()
+    {
+        $container = new ContainerBuilder();
+
+        $container->register('abstract_foo', __NAMESPACE__.'\Foo')->setAbstract(true);
+        $container->register('foo', __NAMESPACE__.'\Foo');
+        $container->register('bar', __NAMESPACE__.'\Bar')->setAutowired(true);
+
+        $pass = new AutowirePass();
+        $pass->process($container);
+
+        $arguments = $container->getDefinition('bar')->getArguments();
+        $this->assertSame('foo', (string) $arguments[0]);
+    }
 }
 
 class Foo
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveDefinitionTemplatesPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveDefinitionTemplatesPassTest.php
@@ -274,6 +274,26 @@ public function testDecoratedServiceCanOverwriteDeprecatedParentStatus()
         $this->assertFalse($container->getDefinition('decorated_deprecated_parent')->isDeprecated());
     }
 
+    public function testProcessMergeAutowiringTypes()
+    {
+        $container = new ContainerBuilder();
+
+        $container
+            ->register('parent')
+            ->addAutowiringType('Foo')
+        ;
+
+        $container
+            ->setDefinition('child', new DefinitionDecorator('parent'))
+            ->addAutowiringType('Bar')
+        ;
+
+        $this->process($container);
+
+        $def = $container->getDefinition('child');
+        $this->assertEquals(array('Foo', 'Bar'), $def->getAutowiringTypes());
+    }
+
     protected function process(ContainerBuilder $container)
     {
         $pass = new ResolveDefinitionTemplatesPass();

Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,8 @@ private function populateAvailableTypes()`
`138`	`138`	`*/`
`139`	`139`	`private function populateAvailableType($id, Definition $definition)`
`140`	`140`	`{`
`141`		`- if (!$definition->getClass()) {`
	`141`	`+ // Never use abstract services`
	`142`	`+ if ($definition->isAbstract()) {`
`142`	`143`	`return;`
`143`	`144`	`}`
`144`	`145`
`@@ -147,6 +148,11 @@ private function populateAvailableType($id, Definition $definition)`
`147`	`148`	`$this->types[$type] = $id;`
`148`	`149`	`}`
`149`	`150`
	`151`	`+ // Cannot use reflection if the class isn't set`
	`152`	`+ if (!$definition->getClass()) {`
	`153`	`+ return;`
	`154`	`+ }`
	`155`	`+`
`150`	`156`	`if ($reflectionClass = $this->getReflectionClass($id, $definition)) {`
`151`	`157`	`$this->extractInterfaces($id, $reflectionClass);`
`152`	`158`	`$this->extractAncestors($id, $reflectionClass);`