bug #46973 [DependencyInjection] Fail gracefully when attempting to autowire composite types (derrabus)

fabpot · fabpot · commit 64afde5e829d · 2022-07-19T13:30:40.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [DependencyInjection] Fail gracefully when attempting to autowire composite types | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Part of #44282 | License | MIT | Doc PR | N/A Symfony 4.4 does not support autowiring union types. Unfortunately, we run into a fatal error when autowiring is attempted for a parameter with an intersection type nested into a union (`(A&B)|C`). Ironically, the error occurs while we try to generate a nice exception message. This PR fixes this, so the developer gets a nice exception message about the parameter that cannot be autowired. For nullable unions however, `null` is injected. This already was the case for `A|null` and it works out of the box for `(A&B)|null`. I've added a test case that covers this case. Commits ------- 2543091 Fail gracefully when attempting to autowire composite types
diff --git a/src/Symfony/Component/DependencyInjection/LazyProxy/ProxyHelper.php b/src/Symfony/Component/DependencyInjection/LazyProxy/ProxyHelper.php
@@ -32,6 +32,11 @@ public static function getTypeHint(\ReflectionFunctionAbstract $r, \ReflectionPa
             return null;
         }
 
+        return self::getTypeHintForType($type, $r, $noBuiltin);
+    }
+
+    private static function getTypeHintForType(\ReflectionType $type, \ReflectionFunctionAbstract $r, bool $noBuiltin): ?string
+    {
         $types = [];
         $glue = '|';
         if ($type instanceof \ReflectionUnionType) {
@@ -46,6 +51,17 @@ public static function getTypeHint(\ReflectionFunctionAbstract $r, \ReflectionPa
         }
 
         foreach ($reflectionTypes as $type) {
+            if ($type instanceof \ReflectionIntersectionType) {
+                $typeHint = self::getTypeHintForType($type, $r, $noBuiltin);
+                if (null === $typeHint) {
+                    return null;
+                }
+
+                $types[] = sprintf('(%s)', $typeHint);
+
+                continue;
+            }
+
             if ($type->isBuiltin()) {
                 if (!$noBuiltin) {
                     $types[] = $type->getName();
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php
@@ -241,8 +241,6 @@ public function testTypeNotGuessableNoServicesFound()
      */
     public function testTypeNotGuessableUnionType()
     {
-        $this->expectException(AutowiringFailedException::class);
-        $this->expectExceptionMessage('Cannot autowire service "a": argument "$collision" of method "Symfony\Component\DependencyInjection\Tests\Compiler\UnionClasses::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\CollisionA|Symfony\Component\DependencyInjection\Tests\Compiler\CollisionB" but this class was not found.');
         $container = new ContainerBuilder();
 
         $container->register(CollisionA::class);
@@ -252,6 +250,9 @@ public function testTypeNotGuessableUnionType()
         $aDefinition->setAutowired(true);
 
         $pass = new AutowirePass();
+
+        $this->expectException(AutowiringFailedException::class);
+        $this->expectExceptionMessage('Cannot autowire service "a": argument "$collision" of method "Symfony\Component\DependencyInjection\Tests\Compiler\UnionClasses::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\CollisionA|Symfony\Component\DependencyInjection\Tests\Compiler\CollisionB" but this class was not found.');
         $pass->process($container);
     }
 
@@ -260,17 +261,38 @@ public function testTypeNotGuessableUnionType()
      */
     public function testTypeNotGuessableIntersectionType()
     {
+        $container = new ContainerBuilder();
+
+        $container->register(CollisionInterface::class);
+        $container->register(AnotherInterface::class);
+
+        $aDefinition = $container->register('a', IntersectionClasses::class);
+        $aDefinition->setAutowired(true);
+
+        $pass = new AutowirePass();
+
         $this->expectException(AutowiringFailedException::class);
         $this->expectExceptionMessage('Cannot autowire service "a": argument "$collision" of method "Symfony\Component\DependencyInjection\Tests\Compiler\IntersectionClasses::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface&Symfony\Component\DependencyInjection\Tests\Compiler\AnotherInterface" but this class was not found.');
+        $pass->process($container);
+    }
+
+    /**
+     * @requires PHP 8.2
+     */
+    public function testTypeNotGuessableCompositeType()
+    {
         $container = new ContainerBuilder();
 
         $container->register(CollisionInterface::class);
         $container->register(AnotherInterface::class);
 
-        $aDefinition = $container->register('a', IntersectionClasses::class);
+        $aDefinition = $container->register('a', CompositeTypeClasses::class);
         $aDefinition->setAutowired(true);
 
         $pass = new AutowirePass();
+
+        $this->expectException(AutowiringFailedException::class);
+        $this->expectExceptionMessage('Cannot autowire service "a": argument "$collision" of method "Symfony\Component\DependencyInjection\Tests\Compiler\CompositeTypeClasses::__construct()" has type "(Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface&Symfony\Component\DependencyInjection\Tests\Compiler\AnotherInterface)|Symfony\Component\DependencyInjection\Tests\Compiler\YetAnotherInterface" but this class was not found.');
         $pass->process($container);
     }
 
@@ -373,6 +395,22 @@ public function testParameterWithNullUnionIsSkipped()
         $this->assertNull($definition->getArgument(0));
     }
 
+    /**
+     * @requires PHP 8.2
+     */
+    public function testParameterWithNullableIntersectionIsSkipped()
+    {
+        $container = new ContainerBuilder();
+
+        $optDefinition = $container->register('opt', NullableIntersection::class);
+        $optDefinition->setAutowired(true);
+
+        (new AutowirePass())->process($container);
+
+        $definition = $container->getDefinition('opt');
+        $this->assertNull($definition->getArgument(0));
+    }
+
     /**
      * @requires PHP 8
      */
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes.php
@@ -10,6 +10,9 @@
 if (\PHP_VERSION_ID >= 80100) {
     require __DIR__.'/intersectiontype_classes.php';
 }
+if (\PHP_VERSION_ID >= 80200) {
+    require __DIR__.'/compositetype_classes.php';
+}
 
 class Foo
 {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/compositetype_classes.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/compositetype_classes.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Compiler;
+
+interface YetAnotherInterface
+{
+}
+
+class CompositeTypeClasses
+{
+    public function __construct((CollisionInterface&AnotherInterface)|YetAnotherInterface $collision)
+    {
+    }
+}
+
+class NullableIntersection
+{
+    public function __construct((CollisionInterface&AnotherInterface)|null $a)
+    {
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,9 @@`
`10`	`10`	`if (\PHP_VERSION_ID >= 80100) {`
`11`	`11`	`require __DIR__.'/intersectiontype_classes.php';`
`12`	`12`	`}`
	`13`	`+if (\PHP_VERSION_ID >= 80200) {`
	`14`	`+ require __DIR__.'/compositetype_classes.php';`
	`15`	`+}`
`13`	`16`
`14`	`17`	`class Foo`
`15`	`18`	`{`