[HttpKernel] Deprecate AddAnnotatedClassesToCachePass and related code infrastructure

nicolas-grekas · fabpot · commit ef9592868d80 · 2024-04-08T13:25:07.000+02:00
diff --git a/UPGRADE-7.1.md b/UPGRADE-7.1.md
@@ -37,6 +37,11 @@ PropertyInfo
 
  * Deprecate `PropertyTypeExtractorInterface::getTypes()`, use `PropertyTypeExtractorInterface::getType()` instead
 
+HttpKernel
+----------
+
+ * Deprecate `Extension::addAnnotatedClassesToCompile()` and related code infrastructure
+
 SecurityBundle
 --------------
 
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * Add `$validationFailedStatusCode` argument to `#[MapQueryParameter]` that allows setting a custom HTTP status code when validation fails
  * Add `NearMissValueResolverException` to let value resolvers report when an argument could be under their watch but failed to be resolved
  * Add `$type` argument to `#[MapRequestPayload]` that allows mapping a list of items
+ * Deprecate `Extension::addAnnotatedClassesToCompile()` and related code infrastructure
 
 7.0
 ---
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/AddAnnotatedClassesToCachePass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/AddAnnotatedClassesToCachePass.php
@@ -17,10 +17,14 @@
 use Symfony\Component\ErrorHandler\DebugClassLoader;
 use Symfony\Component\HttpKernel\Kernel;
 
+trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s" class is deprecated since Symfony 7.1 and will be removed in 8.0.', AddAnnotatedClassesToCachePass::class);
+
 /**
  * Sets the classes to compile in the cache for the container.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 7.1, to be removed in 8.0
  */
 class AddAnnotatedClassesToCachePass implements CompilerPassInterface
 {
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/Extension.php b/src/Symfony/Component/HttpKernel/DependencyInjection/Extension.php
@@ -17,6 +17,8 @@
  * Allow adding classes to the class cache.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @internal since Symfony 7.1, to be deprecated in 8.1; use Symfony\Component\DependencyInjection\Extension\Extension instead
  */
 abstract class Extension extends BaseExtension
 {
@@ -26,19 +28,27 @@ abstract class Extension extends BaseExtension
      * Gets the annotated classes to cache.
      *
      * @return string[]
+     *
+     * @deprecated since Symfony 7.1, to be removed in 8.0
      */
     public function getAnnotatedClassesToCompile(): array
     {
+        trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s()" method is deprecated since Symfony 7.1 and will be removed in 8.0.', __METHOD__);
+
         return $this->annotatedClasses;
     }
 
     /**
      * Adds annotated classes to the class cache.
      *
      * @param string[] $annotatedClasses An array of class patterns
+     *
+     * @deprecated since Symfony 7.1, to be removed in 8.0
      */
     public function addAnnotatedClassesToCompile(array $annotatedClasses): void
     {
+        trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s()" method is deprecated since Symfony 7.1 and will be removed in 8.0.', __METHOD__);
+
         $this->annotatedClasses = array_merge($this->annotatedClasses, $annotatedClasses);
     }
 }
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -37,7 +37,6 @@
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
 use Symfony\Component\HttpKernel\Config\FileLocator;
-use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;
 use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
 
 // Help opcache.preload discover always-needed symbols
@@ -278,9 +277,13 @@ public function getContainer(): ContainerInterface
 
     /**
      * @internal
+     *
+     * @deprecated since Symfony 7.1, to be removed in 8.0
      */
     public function setAnnotatedClassCache(array $annotatedClasses): void
     {
+        trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s()" method is deprecated since Symfony 7.1 and will be removed in 8.0.', __METHOD__);
+
         file_put_contents(($this->warmupDir ?: $this->getBuildDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
     }
 
@@ -314,9 +317,13 @@ public function getCharset(): string
      * Gets the patterns defining the classes to parse and cache for annotations.
      *
      * @return string[]
+     *
+     * @deprecated since Symfony 7.1, to be removed in 8.0
      */
     public function getAnnotatedClassesToCompile(): array
     {
+        trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s()" method is deprecated since Symfony 7.1 and will be removed in 8.0.', __METHOD__);
+
         return [];
     }
 
@@ -591,8 +598,6 @@ protected function buildContainer(): ContainerBuilder
         $this->prepareContainer($container);
         $this->registerContainerConfiguration($this->getContainerLoader($container));
 
-        $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
-
         return $container;
     }
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/AddAnnotatedClassesToCachePassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/AddAnnotatedClassesToCachePassTest.php
@@ -14,6 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;
 
+/**
+ * @group legacy
+ */
 class AddAnnotatedClassesToCachePassTest extends TestCase
 {
     public function testExpandClasses()
diff --git a/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/MergeExtensionConfigurationPassTest.php b/src/Symfony/Component/HttpKernel/Tests/DependencyInjection/MergeExtensionConfigurationPassTest.php
@@ -13,8 +13,8 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
-use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
 use Symfony\Component\HttpKernel\Tests\Fixtures\AcmeFooBundle\AcmeFooBundle;
 
diff --git a/src/Symfony/Component/HttpKernel/composer.json b/src/Symfony/Component/HttpKernel/composer.json
@@ -17,6 +17,7 @@
     ],
     "require": {
         "php": ">=8.2",
+        "symfony/deprecation-contracts": "^2.5|^3",
         "symfony/error-handler": "^6.4|^7.0",
         "symfony/event-dispatcher": "^6.4|^7.0",
         "symfony/http-foundation": "^6.4|^7.0",

Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,14 @@`
`17`	`17`	`use Symfony\Component\ErrorHandler\DebugClassLoader;`
`18`	`18`	`use Symfony\Component\HttpKernel\Kernel;`
`19`	`19`
	`20`	`+trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s" class is deprecated since Symfony 7.1 and will be removed in 8.0.', AddAnnotatedClassesToCachePass::class);`
	`21`	`+`
`20`	`22`	`/**`
`21`	`23`	`* Sets the classes to compile in the cache for the container.`
`22`	`24`	`*`
`23`	`25`	`* @author Fabien Potencier <[email protected]>`
	`26`	`+ *`
	`27`	`+ * @deprecated since Symfony 7.1, to be removed in 8.0`
`24`	`28`	`*/`
`25`	`29`	`class AddAnnotatedClassesToCachePass implements CompilerPassInterface`
`26`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`* Allow adding classes to the class cache.`
`18`	`18`	`*`
`19`	`19`	`* @author Fabien Potencier <[email protected]>`
	`20`	`+ *`
	`21`	`+ * @internal since Symfony 7.1, to be deprecated in 8.1; use Symfony\Component\DependencyInjection\Extension\Extension instead`
`20`	`22`	`*/`
`21`	`23`	`abstract class Extension extends BaseExtension`
`22`	`24`	`{`
`@@ -26,19 +28,27 @@ abstract class Extension extends BaseExtension`
`26`	`28`	`* Gets the annotated classes to cache.`
`27`	`29`	`*`
`28`	`30`	`* @return string[]`
	`31`	`+ *`
	`32`	`+ * @deprecated since Symfony 7.1, to be removed in 8.0`
`29`	`33`	`*/`
`30`	`34`	`public function getAnnotatedClassesToCompile(): array`
`31`	`35`	`{`
	`36`	`+ trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s()" method is deprecated since Symfony 7.1 and will be removed in 8.0.', __METHOD__);`
	`37`	`+`
`32`	`38`	`return $this->annotatedClasses;`
`33`	`39`	`}`
`34`	`40`
`35`	`41`	`/**`
`36`	`42`	`* Adds annotated classes to the class cache.`
`37`	`43`	`*`
`38`	`44`	`* @param string[] $annotatedClasses An array of class patterns`
	`45`	`+ *`
	`46`	`+ * @deprecated since Symfony 7.1, to be removed in 8.0`
`39`	`47`	`*/`
`40`	`48`	`public function addAnnotatedClassesToCompile(array $annotatedClasses): void`
`41`	`49`	`{`
	`50`	`+ trigger_deprecation('symfony/http-kernel', '7.1', 'The "%s()" method is deprecated since Symfony 7.1 and will be removed in 8.0.', __METHOD__);`
	`51`	`+`
`42`	`52`	`$this->annotatedClasses = array_merge($this->annotatedClasses, $annotatedClasses);`
`43`	`53`	`}`
`44`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@`
`14`	`14`	`use PHPUnit\Framework\TestCase;`
`15`	`15`	`use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;`
`16`	`16`
	`17`	`+/**`
	`18`	`+ * @group legacy`
	`19`	`+ */`
`17`	`20`	`class AddAnnotatedClassesToCachePassTest extends TestCase`
`18`	`21`	`{`
`19`	`22`	`public function testExpandClasses()`