[DependencyInjection] Better error message when a param is not defined

Author: lyrixx

Compiler/MergeExtensionConfigurationPass.php

@@ -14,6 +14,7 @@
 use Symfony\Component\Config\Definition\BaseNode;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Exception\LogicException;
+use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
 use Symfony\Component\DependencyInjection\Extension\Extension;
@@ -56,7 +57,14 @@ public function process(ContainerBuilder $container): void
                     BaseNode::setPlaceholderUniquePrefix($resolvingBag->getEnvPlaceholderUniquePrefix());
                 }
             }
-            $config = $resolvingBag->resolveValue($config);
+
+            try {
+                $config = $resolvingBag->resolveValue($config);
+            } catch (ParameterNotFoundException $e) {
+                $e->setSourceExtensionName($name);
+
+                throw $e;
+            }
 
             try {
                 $tmpContainer = new MergeExtensionConfigurationContainerBuilder($extension, $resolvingBag);

Exception/ParameterNotFoundException.php

@@ -20,12 +20,6 @@
  */
 class ParameterNotFoundException extends InvalidArgumentException implements NotFoundExceptionInterface
 {
-    private string $key;
-    private ?string $sourceId;
-    private ?string $sourceKey;
-    private array $alternatives;
-    private ?string $nonNestedAlternative;
-
     /**
      * @param string          $key                  The requested parameter key
      * @param string|null     $sourceId             The service id that references the non-existent parameter
@@ -34,14 +28,15 @@ class ParameterNotFoundException extends InvalidArgumentException implements Not
      * @param string[]        $alternatives         Some parameter name alternatives
      * @param string|null     $nonNestedAlternative The alternative parameter name when the user expected dot notation for nested parameters
      */
-    public function __construct(string $key, ?string $sourceId = null, ?string $sourceKey = null, ?\Throwable $previous = null, array $alternatives = [], ?string $nonNestedAlternative = null)
-    {
-        $this->key = $key;
-        $this->sourceId = $sourceId;
-        $this->sourceKey = $sourceKey;
-        $this->alternatives = $alternatives;
-        $this->nonNestedAlternative = $nonNestedAlternative;
-
+    public function __construct(
+        private string $key,
+        private ?string $sourceId = null,
+        private ?string $sourceKey = null,
+        ?\Throwable $previous = null,
+        private array $alternatives = [],
+        private ?string $nonNestedAlternative = null,
+        private ?string $sourceExtensionName = null,
+    ) {
         parent::__construct('', 0, $previous);
 
         $this->updateRepr();
@@ -53,6 +48,8 @@ public function updateRepr(): void
             $this->message = sprintf('The service "%s" has a dependency on a non-existent parameter "%s".', $this->sourceId, $this->key);
         } elseif (null !== $this->sourceKey) {
             $this->message = sprintf('The parameter "%s" has a dependency on a non-existent parameter "%s".', $this->sourceKey, $this->key);
+        } elseif (null !== $this->sourceExtensionName) {
+            $this->message = sprintf('You have requested a non-existent parameter "%s" while loading extension "%s".', $this->key, $this->sourceExtensionName);
         } elseif ('.' === ($this->key[0] ?? '')) {
             $this->message = sprintf('Parameter "%s" not found. It was probably deleted during the compilation of the container.', $this->key);
         } else {
@@ -99,4 +96,11 @@ public function setSourceKey(?string $sourceKey): void
 
         $this->updateRepr();
     }
+
+    public function setSourceExtensionName(?string $sourceExtensionName): void
+    {
+        $this->sourceExtensionName = $sourceExtensionName;
+
+        $this->updateRepr();
+    }
 }

Tests/Compiler/MergeExtensionConfigurationPassTest.php

@@ -18,6 +18,7 @@
 use Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\MergeExtensionConfigurationPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
@@ -127,11 +128,32 @@ public function testThrowingExtensionsGetMergedBag()
             $pass->process($container);
             $this->fail('An exception should have been thrown.');
         } catch (\Exception $e) {
+            $this->assertSame('here', $e->getMessage());
         }
 
         $this->assertSame(['FOO'], array_keys($container->getParameterBag()->getEnvPlaceholders()));
     }
 
+    public function testMissingParameterIncludesExtension()
+    {
+        $container = new ContainerBuilder();
+        $container->registerExtension(new FooExtension());
+        $container->prependExtensionConfig('foo', [
+            'foo' => '%missing_parameter%',
+        ]);
+
+        $pass = new MergeExtensionConfigurationPass();
+        try {
+            $pass = new MergeExtensionConfigurationPass();
+            $pass->process($container);
+            $this->fail('An exception should have been thrown.');
+        } catch (\Exception $e) {
+            $this->assertInstanceOf(ParameterNotFoundException::class, $e);
+            $this->assertSame('You have requested a non-existent parameter "missing_parameter" while loading extension "foo".', $e->getMessage());
+        }
+
+    }
+
     public function testReuseEnvPlaceholderGeneratedByPreviousExtension()
     {
         $container = new ContainerBuilder();
@@ -210,7 +232,7 @@ public function getConfiguration(array $config, ContainerBuilder $container): ?C
 
     public function load(array $configs, ContainerBuilder $container): void
     {
-        throw new \Exception();
+        throw new \Exception('here');
     }
 }