minor #31306 [DI] Improve exception message on missing $ of named argument (jschaedl)

fabpot · fabpot · commit 7cd1bdd254db · 2019-04-29T11:48:47.000+02:00
This PR was squashed before being merged into the 4.3-dev branch (closes #31306). Discussion ---------- [DI] Improve exception message on missing $ of named argument | Q | A | ------------- | --- | Branch? | master | Bug fix? | - | New feature? | - | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | #31265  | License | MIT | Doc PR | not related  ### Description As described in #31265, missing the prefix `$` in an argument name: ``` App\Word\WordChecker: arguments: checkers: - '@app\Word\Checker\StaticWordChecker' - '@app\Word\Checker\BannedWorldListChecker' ``` led to the following error: `Invalid service "App\Word\WordChecker": the value of argument "checkers" of method "__construct()" must be null, an instance of Symfony\Component\DependencyInjection\Reference or an instance of Symfony\Component\DependencyInjection\Definition, array given.` As this error message is quite confusing I changed it to: `Invalid service "App\Word\WordChecker": Did you forget to add the "$" prefix to argument checkers` ### Todo - [x] add a unit test Commits ------- d0e4499 [DI] Improve exception message on missing $ of named argument
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveNamedArgumentsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveNamedArgumentsPass.php
@@ -53,6 +53,10 @@ protected function processValue($value, $isRoot = false)
                     $parameters = $r->getParameters();
                 }
 
+                if (isset($key[0]) && '$' !== $key[0] && !class_exists($key)) {
+                    throw new InvalidArgumentException(sprintf('Invalid service "%s": did you forget to add the "$" prefix to argument "%s"?', $this->currentId, $key));
+                }
+
                 if (isset($key[0]) && '$' === $key[0]) {
                     foreach ($parameters as $j => $p) {
                         if ($key === '$'.$p->name) {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveNamedArgumentsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveNamedArgumentsPassTest.php
@@ -149,6 +149,21 @@ public function testTypedArgument()
         $this->assertEquals([new Reference('foo'), '123'], $definition->getArguments());
     }
 
+    /**
+     * @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Invalid service "Symfony\Component\DependencyInjection\Tests\Fixtures\NamedArgumentsDummy": did you forget to add the "$" prefix to argument "apiKey"?
+     */
+    public function testTypedArgumentWithMissingDollar()
+    {
+        $container = new ContainerBuilder();
+
+        $definition = $container->register(NamedArgumentsDummy::class, NamedArgumentsDummy::class);
+        $definition->setArgument('apiKey', '123');
+
+        $pass = new ResolveNamedArgumentsPass();
+        $pass->process($container);
+    }
+
     public function testResolvesMultipleArgumentsOfTheSameType()
     {
         $container = new ContainerBuilder();
