Add ExtensionInterface::build() to register compiler passes

wouterj · wouterj · commit d25fa13cc969 · 2023-08-12T15:09:58.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -15,6 +15,7 @@ DependencyInjection
 -------------------
 
  * Deprecate `ContainerAwareInterface` and `ContainerAwareTrait`, use dependency injection instead
+ * Add `ExtensionInterface::build(ContainerBuilder $container): void` to register compiler passes from an extension
 
    *Before*
    ```php
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/ExtensionWithoutConfigTestBundle/DependencyInjection/ExtensionWithoutConfigTestExtension.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/ExtensionWithoutConfigTestBundle/DependencyInjection/ExtensionWithoutConfigTestExtension.php
@@ -16,6 +16,10 @@
 
 class ExtensionWithoutConfigTestExtension implements ExtensionInterface
 {
+    public function build(ContainerBuilder $container): void
+    {
+    }
+
     public function load(array $configs, ContainerBuilder $container): void
     {
     }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php
@@ -78,7 +78,7 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
         $loader->load($this->rootConfig);
     }
 
-    protected function build(ContainerBuilder $container): void
+    public function build(ContainerBuilder $container): void
     {
         $container->register('logger', NullLogger::class);
         $container->registerExtension(new TestDumpExtension());
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Allow using `#[Target]` with no arguments to state that a parameter must match a named autowiring alias
  * Deprecate `ContainerAwareInterface` and `ContainerAwareTrait`, use dependency injection instead
  * Add `defined` env var processor that returns `true` for defined and neither null nor empty env vars
+ * Add `ExtensionInterface::build(ContainerBuilder $container): void` to register compiler passes from an extension
 
 6.3
 ---
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -209,6 +209,11 @@ public function registerExtension(ExtensionInterface $extension)
         if (false !== $extension->getNamespace()) {
             $this->extensionsByNs[$extension->getNamespace()] = $extension;
         }
+
+        // @deprecated remove if statement in Symfony 7
+        if (method_exists($extension, 'build') && \is_callable([$extension, 'build'])) {
+            $extension->build($this);
+        }
     }
 
     /**
diff --git a/src/Symfony/Component/DependencyInjection/Extension/Extension.php b/src/Symfony/Component/DependencyInjection/Extension/Extension.php
@@ -28,6 +28,10 @@ abstract class Extension implements ExtensionInterface, ConfigurationExtensionIn
 {
     private array $processedConfigs = [];
 
+    public function build(ContainerBuilder $container): void
+    {
+    }
+
     /**
      * @return string|false
      */
diff --git a/src/Symfony/Component/DependencyInjection/Extension/ExtensionInterface.php b/src/Symfony/Component/DependencyInjection/Extension/ExtensionInterface.php
@@ -16,6 +16,8 @@
 /**
  * ExtensionInterface is the interface implemented by container extension classes.
  *
+ * @method void build(ContainerBuilder $container) Called just before compilation, use this to register compiler passes
+ *
  * @author Fabien Potencier <fabien@symfony.com>
  */
 interface ExtensionInterface
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php
@@ -39,6 +39,7 @@
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 use Symfony\Component\DependencyInjection\LazyProxy\Instantiator\RealServiceInstantiator;
 use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
@@ -1326,6 +1327,17 @@ public function testExtensionConfig()
         $this->assertEquals([$second, $first], $configs);
     }
 
+    public function testExtensionBuild()
+    {
+        $container = new ContainerBuilder();
+
+        $container->registerExtension(new BuildExtension());
+
+        $container->compile();
+        $testpass = array_filter($container->getCompilerPassConfig()->getPasses(), fn ($pass) => $pass instanceof TestPass);
+        $this->assertCount(1, $testpass, 'The extension did not register a compiler pass.');
+    }
+
     public function testAbstractAlias()
     {
         $container = new ContainerBuilder();
@@ -2065,3 +2077,22 @@ public function __construct($first = '', $second = '')
         $this->second = $second;
     }
 }
+
+class BuildExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+    }
+
+    public function build(ContainerBuilder $container): void
+    {
+        $container->addCompilerPass(new TestPass());
+    }
+}
+
+class TestPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/AcmeExtension.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/AcmeExtension.php
@@ -24,4 +24,8 @@ public function getAlias(): string
     {
         return 'acme';
     }
+
+    public function build(ContainerBuilder $container): void
+    {
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectExtension.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/ProjectExtension.php
@@ -41,4 +41,8 @@ public function getAlias(): string
     public function getConfiguration(array $config, ContainerBuilder $container)
     {
     }
+
+    public function build(ContainerBuilder $container): void
+    {
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,10 @@`
`16`	`16`
`17`	`17`	`class ExtensionWithoutConfigTestExtension implements ExtensionInterface`
`18`	`18`	`{`
	`19`	`+ public function build(ContainerBuilder $container): void`
	`20`	`+ {`
	`21`	`+ }`
	`22`	`+`
`19`	`23`	`public function load(array $configs, ContainerBuilder $container): void`
`20`	`24`	`{`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function registerContainerConfiguration(LoaderInterface $loader): void`
`78`	`78`	`$loader->load($this->rootConfig);`
`79`	`79`	`}`
`80`	`80`
`81`		`- protected function build(ContainerBuilder $container): void`
	`81`	`+ public function build(ContainerBuilder $container): void`
`82`	`82`	`{`
`83`	`83`	`$container->register('logger', NullLogger::class);`
`84`	`84`	`$container->registerExtension(new TestDumpExtension());`
Original file line number	Diff line number	Diff line change
`@@ -209,6 +209,11 @@ public function registerExtension(ExtensionInterface $extension)`
`209`	`209`	`if (false !== $extension->getNamespace()) {`
`210`	`210`	`$this->extensionsByNs[$extension->getNamespace()] = $extension;`
`211`	`211`	`}`
	`212`	`+`
	`213`	`+ // @deprecated remove if statement in Symfony 7`
	`214`	`+ if (method_exists($extension, 'build') && \is_callable([$extension, 'build'])) {`
	`215`	`+ $extension->build($this);`
	`216`	`+ }`
`212`	`217`	`}`
`213`	`218`
`214`	`219`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`/**`
`17`	`17`	`* ExtensionInterface is the interface implemented by container extension classes.`
`18`	`18`	`*`
	`19`	`+ * @method void build(ContainerBuilder $container) Called just before compilation, use this to register compiler passes`
	`20`	`+ *`
`19`	`21`	`* @author Fabien Potencier <fabien@symfony.com>`
`20`	`22`	`*/`
`21`	`23`	`interface ExtensionInterface`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,8 @@ public function getAlias(): string`
`24`	`24`	`{`
`25`	`25`	`return 'acme';`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+ public function build(ContainerBuilder $container): void`
	`29`	`+ {`
	`30`	`+ }`
`27`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,8 @@ public function getAlias(): string`
`41`	`41`	`public function getConfiguration(array $config, ContainerBuilder $container)`
`42`	`42`	`{`
`43`	`43`	`}`
	`44`	`+`
	`45`	`+ public function build(ContainerBuilder $container): void`
	`46`	`+ {`
	`47`	`+ }`
`44`	`48`	`}`