bug #44838 [DependencyInjection][HttpKernel] Fix enum typed bindings (ogizanagi)

nicolas-grekas · nicolas-grekas · commit 30594b2b76bd · 2021-12-29T11:08:38.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [DependencyInjection][HttpKernel] Fix enum typed bindings | Q | A | ------------- | --- | Branch? | 4.4  | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | N/A  | License | MIT | Doc PR | symfony/symfony-docs#...  Relates to #44834 While: ```yml # services.yaml services: _defaults: autowire: true autoconfigure: true bind: $myParam: !php/const App\Status::Deleted ``` is working for me, the following isn't: ```diff # services.yaml services: _defaults: autowire: true autoconfigure: true bind: - $myParam: !php/const App\Status::Deleted + App\Status $myParam: !php/const App\Status::Deleted ``` -> > Invalid value for binding key "App\Status $myParam" for service […]: expected "Symfony\Component\DependencyInjection\Reference", "Symfony\Component\DependencyInjection\Definition", "Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument", "Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument" or null, "App\Status" given. This attempts to fix it by accounting for `\UnitEnum` in the `ResolveBindingPass`, as well as re-allowing enum types already present in bindings after #44826. Commits ------- c32d749 [DependencyInjection][HttpKernel] Fix enum typed bindings
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveBindingsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveBindingsPass.php
@@ -133,6 +133,11 @@ protected function processValue($value, $isRoot = false)
                 continue;
             }
 
+            if (is_subclass_of($m[1], \UnitEnum::class)) {
+                $bindingNames[substr($key, \strlen($m[0]))] = $binding;
+                continue;
+            }
+
             if (null !== $bindingValue && !$bindingValue instanceof Reference && !$bindingValue instanceof Definition && !$bindingValue instanceof TaggedIteratorArgument && !$bindingValue instanceof ServiceLocatorArgument) {
                 throw new InvalidArgumentException(sprintf('Invalid value for binding key "%s" for service "%s": expected "%s", "%s", "%s", "%s" or null, "%s" given.', $key, $this->currentId, Reference::class, Definition::class, TaggedIteratorArgument::class, ServiceLocatorArgument::class, \gettype($bindingValue)));
             }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveBindingsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveBindingsPassTest.php
@@ -24,7 +24,9 @@
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\CaseSensitiveClass;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\FooUnitEnum;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\NamedArgumentsDummy;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\NamedEnumArgumentDummy;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\ParentNotExists;
 use Symfony\Component\DependencyInjection\TypedReference;
 
@@ -63,6 +65,27 @@ public function testProcess()
         $this->assertEquals([['setSensitiveClass', [new Reference('foo')]]], $definition->getMethodCalls());
     }
 
+    /**
+     * @requires PHP 8.1
+     */
+    public function testProcessEnum()
+    {
+        $container = new ContainerBuilder();
+
+        $bindings = [
+            FooUnitEnum::class.' $bar' => new BoundArgument(FooUnitEnum::BAR),
+        ];
+
+        $definition = $container->register(NamedEnumArgumentDummy::class, NamedEnumArgumentDummy::class);
+        $definition->setBindings($bindings);
+
+        $pass = new ResolveBindingsPass();
+        $pass->process($container);
+
+        $expected = [FooUnitEnum::BAR];
+        $this->assertEquals($expected, $definition->getArguments());
+    }
+
     public function testUnusedBinding()
     {
         $this->expectException(InvalidArgumentException::class);
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/NamedEnumArgumentDummy.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/NamedEnumArgumentDummy.php
@@ -0,0 +1,19 @@
+<?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\Tests\Fixtures;
+
+class NamedEnumArgumentDummy
+{
+    public function __construct(FooUnitEnum $bar)
+    {
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
@@ -127,11 +127,6 @@ public function process(ContainerBuilder $container)
                     $type = ltrim($target = (string) ProxyHelper::getTypeHint($r, $p), '\\');
                     $invalidBehavior = ContainerInterface::IGNORE_ON_INVALID_REFERENCE;
 
-                    if (is_subclass_of($type, \UnitEnum::class)) {
-                        // do not attempt to register enum typed arguments
-                        continue;
-                    }
-
                     if (isset($arguments[$r->name][$p->name])) {
                         $target = $arguments[$r->name][$p->name];
                         if ('?' !== $target[0]) {
@@ -156,6 +151,9 @@ public function process(ContainerBuilder $container)
                             $args[$p->name] = $bindingValue;
                         }
 
+                        continue;
+                    } elseif (is_subclass_of($type, \UnitEnum::class)) {
+                        // do not attempt to register enum typed arguments if not already present in bindings
                         continue;
                     } elseif (!$type || !$autowire || '\\' !== $target[0]) {
                         continue;

Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,11 @@ protected function processValue($value, $isRoot = false)`
`133`	`133`	`continue;`
`134`	`134`	`}`
`135`	`135`
	`136`	`+ if (is_subclass_of($m[1], \UnitEnum::class)) {`
	`137`	`+ $bindingNames[substr($key, \strlen($m[0]))] = $binding;`
	`138`	`+ continue;`
	`139`	`+ }`
	`140`	`+`
`136`	`141`	`if (null !== $bindingValue && !$bindingValue instanceof Reference && !$bindingValue instanceof Definition && !$bindingValue instanceof TaggedIteratorArgument && !$bindingValue instanceof ServiceLocatorArgument) {`
`137`	`142`	`throw new InvalidArgumentException(sprintf('Invalid value for binding key "%s" for service "%s": expected "%s", "%s", "%s", "%s" or null, "%s" given.', $key, $this->currentId, Reference::class, Definition::class, TaggedIteratorArgument::class, ServiceLocatorArgument::class, \gettype($bindingValue)));`
`138`	`143`	`}`