More accurate message on invalid config builder

a-menshchikov · a-menshchikov · commit 5ece904ed2e5 · 2021-04-30T11:12:16.000+03:00
Throw exception when try to autowire nested bundle config instead of ConfigBuilder.
Also renamed test class AcmeConfigBuilder to AcmeConfig according config builders auto naming.
diff --git a/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/PhpFileLoader.php
@@ -159,12 +159,16 @@ private function configBuilder(string $namespace): ConfigBuilderInterface
 
         // If it does not start with Symfony\Config\ we dont know how to handle this
         if ('Symfony\\Config\\' !== substr($namespace, 0, 15)) {
-            throw new InvalidargumentException(sprintf('Could not find or generate class "%s".', $namespace));
+            throw new InvalidArgumentException(sprintf('Could not find or generate class "%s".', $namespace));
         }
 
         // Try to get the extension alias
         $alias = Container::underscore(substr($namespace, 15, -6));
 
+        if (false !== strpos($alias, '\\')) {
+            throw new InvalidArgumentException('You can only use "root" ConfigBuilders from "Symfony\\Config\\" namespace. Nested classes are the Plain Old PHP Objects.');
+        }
+
         if (!$this->container->hasExtension($alias)) {
             $extensions = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getAlias(); }, $this->container->getExtensions()));
             throw new InvalidArgumentException(sprintf('There is no extension able to load the configuration for "%s". Looked for namespace "%s", found "%s".', $namespace, $alias, $extensions ? implode('", "', $extensions) : 'none'));
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AcmeConfig.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AcmeConfig.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\Config\Builder\ConfigBuilderInterface;
+
+class AcmeConfig implements ConfigBuilderInterface
+{
+    private $color;
+
+    private $nested;
+
+    public function color($value)
+    {
+        $this->color = $value;
+    }
+
+    public function nested(array $value)
+    {
+        if (null === $this->nested) {
+            $this->nested = new \Symfony\Config\AcmeConfig\NestedConfig();
+        } elseif ([] !== $value) {
+            throw new \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException(sprintf('The node created by "nested()" has already been initialized. You cannot pass values the second time you call nested().'));
+        }
+
+        return $this->nested;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'color' => $this->color
+        ];
+    }
+
+    public function getExtensionAlias(): string
+    {
+        return 'acme';
+    }
+}
+
+class_alias(AcmeConfig::class, '\\Symfony\\Config\\AcmeConfig');
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AcmeConfig/NestedConfig.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AcmeConfig/NestedConfig.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures\AcmeConfig;
+
+class NestedConfig
+{
+}
+
+class_alias(NestedConfig::class, '\\Symfony\\Config\\AcmeConfig\\NestedConfig');
+
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AcmeConfigBuilder.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AcmeConfigBuilder.php
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/config_builder.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/config_builder.php
@@ -1,7 +1,7 @@
 <?php
 
-use Symfony\Component\DependencyInjection\Tests\Fixtures\AcmeConfigBuilder;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AcmeConfig;
 
-return static function (AcmeConfigBuilder $config) {
+return static function (AcmeConfig $config) {
     $config->color('blue');
 };
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/nested_bundle_config.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/config/nested_bundle_config.php
@@ -0,0 +1,7 @@
+<?php
+
+use Symfony\Config\AcmeConfig\NestedConfig;
+
+return static function (NestedConfig $config) {
+    throw new RuntimeException('This code should not be run.');
+};
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/PhpFileLoaderTest.php
@@ -164,4 +164,15 @@ public function testDeprecatedWithoutPackageAndVersion()
         $loader = new PhpFileLoader($container = new ContainerBuilder(), new FileLocator());
         $loader->load($fixtures.'/config/deprecated_without_package_version.php');
     }
+
+    public function testNestedBundleConfigNotAllowed()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessageMatches('/^'.preg_quote('Could not resolve argument "Symfony\\Config\\AcmeConfig\\NestedConfig $config"', '/').'/');
+
+        $fixtures = realpath(__DIR__.'/../Fixtures');
+        $container = new ContainerBuilder();
+        $loader = new PhpFileLoader($container, new FileLocator(), 'prod', new ConfigBuilderGenerator(sys_get_temp_dir()));
+        $loader->load($fixtures.'/config/nested_bundle_config.php');
+    }
 }
