bug #62436 [FrameworkBundle] Dump all registered extensions’ configuration reference (MatTheCat)

This PR was squashed before being merged into the 7.4 branch.

Discussion
----------

[FrameworkBundle] Dump all registered extensions’ configuration reference

| Q             | A
| ------------- | ---
| Branch?       | 7.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Issues        | Fix #62428
| License       | MIT

Commits
-------

badc255c143 [FrameworkBundle] Dump all registered extensions’ configuration reference

Author: nicolas-grekas

DependencyInjection/Compiler/PhpConfigReferenceDumpPass.php

@@ -95,6 +95,15 @@ public function process(ContainerBuilder $container): void
         $appTypes = '';
 
         $anyEnvExtensions = [];
+        foreach ($container->getExtensions() as $alias => $extension) {
+            if (!$configuration = $this->getConfiguration($extension, $container)) {
+                continue;
+            }
+
+            $anyEnvExtensions[$alias] = $extension;
+            $type = $this->camelCase($alias).'Config';
+            $appTypes .= \sprintf("\n * @psalm-type %s = %s", $type, ArrayShapeGenerator::generate($configuration->getConfigTreeBuilder()->buildTree()));
+        }
         foreach ($this->bundlesDefinition as $bundle => $envs) {
             if (!is_subclass_of($bundle, BundleInterface::class)) {
                 continue;
@@ -105,15 +114,21 @@ public function process(ContainerBuilder $container): void
             if (!$configuration = $this->getConfiguration($extension, $container)) {
                 continue;
             }
-            $anyEnvExtensions[$bundle] = $extension;
-            $type = $this->camelCase($extension->getAlias()).'Config';
-            $appTypes .= \sprintf("\n * @psalm-type %s = %s", $type, ArrayShapeGenerator::generate($configuration->getConfigTreeBuilder()->buildTree()));
+
+            $extensionAlias = $extension->getAlias();
+            if (isset($anyEnvExtensions[$extensionAlias])) {
+                $extension = $anyEnvExtensions[$extensionAlias];
+            } else {
+                $anyEnvExtensions[$extensionAlias] = $extension;
+                $type = $this->camelCase($extensionAlias).'Config';
+                $appTypes .= \sprintf("\n * @psalm-type %s = %s", $type, ArrayShapeGenerator::generate($configuration->getConfigTreeBuilder()->buildTree()));
+            }
 
             foreach ($knownEnvs as $env) {
                 if ($envs[$env] ?? $envs['all'] ?? false) {
                     $extensionsPerEnv[$env][] = $extension;
                 } else {
-                    unset($anyEnvExtensions[$bundle]);
+                    unset($anyEnvExtensions[$extensionAlias]);
                 }
             }
         }

Tests/DependencyInjection/Compiler/PhpConfigReferenceDumpPassTest.php

@@ -95,8 +95,8 @@ public function testProcessGeneratesExpectedReferenceFile()
         $container = new ContainerBuilder();
         $container->setParameter('.container.known_envs', ['dev', 'prod', 'test']);
 
-        $extension = new TestExtension();
-        $container->registerExtension($extension);
+        $container->registerExtension(new TestExtension(false));
+        $container->registerExtension(new AppExtension());
 
         $pass = new PhpConfigReferenceDumpPass($this->tempDir.'/reference.php', [
             TestBundle::class => ['all' => true],
@@ -133,12 +133,16 @@ class TestBundle extends Bundle
 {
     public function getContainerExtension(): ?ExtensionInterface
     {
-        return new TestExtension();
+        return new TestExtension(true);
     }
 }
 
 class TestExtension extends Extension
 {
+    public function __construct(private bool $fromBundle)
+    {
+    }
+
     public function load(array $configs, ContainerBuilder $container): void
     {
     }
@@ -160,12 +164,16 @@ public function getAlias(): string
 
     public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
     {
-        return new TestConfiguration();
+        return new TestConfiguration($this->fromBundle);
     }
 }
 
 class TestConfiguration implements ConfigurationInterface
 {
+    public function __construct(private bool $fromBundle)
+    {
+    }
+
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('test');
@@ -181,9 +189,30 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->integerNode('count')->end()
                         ->end()
                     ->end()
+                    ->booleanNode('fromBundle')->defaultValue($this->fromBundle)->end()
                 ->end();
         }
 
         return $treeBuilder;
     }
 }
+
+class AppExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+    }
+
+    public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
+    {
+        return new AppConfiguration();
+    }
+}
+
+class AppConfiguration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        return new TreeBuilder('app', 'boolean');
+    }
+}

Tests/Fixtures/reference.php

@@ -129,12 +129,15 @@
  *         name?: scalar|null,
  *         count?: int,
  *     },
+ *     fromBundle?: bool, // Default: false
  * }
+ * @psalm-type AppConfig = bool
  * @psalm-type ConfigType = array{
  *     imports?: ImportsConfig,
  *     parameters?: ParametersConfig,
  *     services?: ServicesConfig,
  *     test?: TestConfig,
+ *     app?: AppConfig,
  *     "when@dev"?: array{
  *         imports?: ImportsConfig,
  *         parameters?: ParametersConfig,