[FrameworkBundle][HttpKernel] Introduce $buildDir argument to WarmableInterface::warmup to warm read-only artefacts in build_dir

okhoshi · nicolas-grekas · commit 38e411904881 · 2023-10-17T13:35:41.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,7 @@ CHANGELOG
  * Add `--exclude` option to the `cache:pool:clear` command
  * Add parameters deprecations to the output of `debug:container` command
  * Change `framework.asset_mapper.importmap_polyfill` from a URL to the name of an item in the importmap
+ * Provide `$buildDir` when running `CacheWarmer` to build read-only resources
 
 6.3
 ---
diff --git a/CacheWarmer/AbstractPhpFileCacheWarmer.php b/CacheWarmer/AbstractPhpFileCacheWarmer.php
@@ -35,15 +35,16 @@ public function isOptional(): bool
     }
 
     /**
-     * @return string[] A list of classes to preload on PHP 7.4+
+     * @param string|null $buildDir
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
+        $buildDir = 1 < \func_num_args() ? func_get_arg(1) : null;
         $arrayAdapter = new ArrayAdapter();
 
         spl_autoload_register([ClassExistenceResource::class, 'throwOnRequiredClass']);
         try {
-            if (!$this->doWarmUp($cacheDir, $arrayAdapter)) {
+            if (!$this->doWarmUp($cacheDir, $arrayAdapter, $buildDir)) {
                 return [];
             }
         } finally {
@@ -78,7 +79,9 @@ final protected function ignoreAutoloadException(string $class, \Exception $exce
     }
 
     /**
+     * @param string|null $buildDir
+     *
      * @return bool false if there is nothing to warm-up
      */
-    abstract protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool;
+    abstract protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool;
 }
diff --git a/CacheWarmer/AnnotationsCacheWarmer.php b/CacheWarmer/AnnotationsCacheWarmer.php
@@ -44,7 +44,10 @@ public function __construct(
         parent::__construct($phpArrayFile);
     }
 
-    protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
+    /**
+     * @param string|null $buildDir
+     */
+    protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool
     {
         $annotatedClassPatterns = $cacheDir.'/annotations.map';
 
diff --git a/CacheWarmer/CachePoolClearerCacheWarmer.php b/CacheWarmer/CachePoolClearerCacheWarmer.php
@@ -37,10 +37,7 @@ public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])
         $this->pools = $pools;
     }
 
-    /**
-     * @return string[]
-     */
-    public function warmUp(string $cacheDirectory): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
         foreach ($this->pools as $pool) {
             if ($this->poolClearer->hasPool($pool)) {
diff --git a/CacheWarmer/ConfigBuilderCacheWarmer.php b/CacheWarmer/ConfigBuilderCacheWarmer.php
@@ -38,11 +38,17 @@ public function __construct(KernelInterface $kernel, LoggerInterface $logger = n
     }
 
     /**
-     * @return string[]
+     * @param string|null $buildDir
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
-        $generator = new ConfigBuilderGenerator($this->kernel->getBuildDir());
+        $buildDir = 1 < \func_num_args() ? func_get_arg(1) : null;
+
+        if (!$buildDir) {
+            return [];
+        }
+
+        $generator = new ConfigBuilderGenerator($buildDir);
 
         foreach ($this->kernel->getBundles() as $bundle) {
             $extension = $bundle->getContainerExtension();
diff --git a/CacheWarmer/RouterCacheWarmer.php b/CacheWarmer/RouterCacheWarmer.php
@@ -34,12 +34,12 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
         $router = $this->container->get('router');
 
         if ($router instanceof WarmableInterface) {
-            return (array) $router->warmUp($cacheDir);
+            return (array) $router->warmUp($cacheDir, $buildDir);
         }
 
         throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));
diff --git a/CacheWarmer/SerializerCacheWarmer.php b/CacheWarmer/SerializerCacheWarmer.php
@@ -39,7 +39,10 @@ public function __construct(array $loaders, string $phpArrayFile)
         $this->loaders = $loaders;
     }
 
-    protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
+    /**
+     * @param string|null $buildDir
+     */
+    protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool
     {
         if (!$this->loaders) {
             return true;
diff --git a/CacheWarmer/TranslationsCacheWarmer.php b/CacheWarmer/TranslationsCacheWarmer.php
@@ -34,14 +34,16 @@ public function __construct(ContainerInterface $container)
     }
 
     /**
-     * @return string[]
+     * @param string|null $buildDir
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $this->translator ??= $this->container->get('translator');
 
         if ($this->translator instanceof WarmableInterface) {
-            return (array) $this->translator->warmUp($cacheDir);
+            $buildDir = 1 < \func_num_args() ? func_get_arg(1) : null;
+
+            return (array) $this->translator->warmUp($cacheDir, $buildDir);
         }
 
         return [];
diff --git a/CacheWarmer/ValidatorCacheWarmer.php b/CacheWarmer/ValidatorCacheWarmer.php
@@ -39,7 +39,10 @@ public function __construct(ValidatorBuilder $validatorBuilder, string $phpArray
         $this->validatorBuilder = $validatorBuilder;
     }
 
-    protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool
+    /**
+     * @param string|null $buildDir
+     */
+    protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool
     {
         $loaders = $this->validatorBuilder->getLoaders();
         $metadataFactory = new LazyLoadingMetadataFactory(new LoaderChain($loaders), $arrayAdapter);
diff --git a/Command/CacheClearCommand.php b/Command/CacheClearCommand.php
@@ -245,7 +245,7 @@ private function warmupOptionals(string $cacheDir, string $warmupDir, SymfonySty
         $warmer = $kernel->getContainer()->get('cache_warmer');
         // non optional warmers already ran during container compilation
         $warmer->enableOnlyOptionalWarmers();
-        $preload = (array) $warmer->warmUp($cacheDir, $io);
+        $preload = (array) $warmer->warmUp($cacheDir, $warmupDir, $io);
 
         if ($preload && file_exists($preloadFile = $warmupDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
             Preloader::append($preloadFile, $preload);
diff --git a/Command/CacheWarmupCommand.php b/Command/CacheWarmupCommand.php
@@ -74,7 +74,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $preload = $this->cacheWarmer->warmUp($cacheDir);
 
-        if ($preload && file_exists($preloadFile = $cacheDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
+        $buildDir = $kernel->getContainer()->getParameter('kernel.build_dir');
+        if ($preload && $cacheDir === $buildDir && file_exists($preloadFile = $buildDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
             Preloader::append($preloadFile, $preload);
         }
 
diff --git a/Routing/Router.php b/Routing/Router.php
@@ -81,9 +81,9 @@ public function getRouteCollection(): RouteCollection
     }
 
     /**
-     * @return string[] A list of classes to preload on PHP 7.4+
+     * @param string|null $buildDir
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         $currentDir = $this->getOption('cache_dir');
 
diff --git a/Tests/CacheWarmer/ConfigBuilderCacheWarmerTest.php b/Tests/CacheWarmer/ConfigBuilderCacheWarmerTest.php
@@ -15,6 +15,7 @@
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\HttpKernel\Kernel;
@@ -39,7 +40,7 @@ protected function tearDown(): void
 
     public function testBuildDirIsUsedAsConfigBuilderOutputDir()
     {
-        $kernel = new class($this->varDir) extends Kernel {
+        $kernel = new class($this->varDir) extends Kernel implements CompilerPassInterface {
             private $varDir;
 
             public function __construct(string $varDir)
@@ -75,12 +76,25 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
                     ]);
                 });
             }
+
+            public function process(ContainerBuilder $container): void
+            {
+                $container->removeDefinition('config_builder.warmer');
+            }
         };
         $kernel->boot();
 
+        self::assertDirectoryDoesNotExist($kernel->getBuildDir().'/Symfony');
+        self::assertDirectoryDoesNotExist($kernel->getCacheDir().'/Symfony');
+
         $warmer = new ConfigBuilderCacheWarmer($kernel);
         $warmer->warmUp($kernel->getCacheDir());
 
+        self::assertDirectoryDoesNotExist($kernel->getBuildDir().'/Symfony');
+        self::assertDirectoryDoesNotExist($kernel->getCacheDir().'/Symfony');
+
+        $warmer->warmUp($kernel->getCacheDir(), $kernel->getBuildDir());
+
         self::assertDirectoryExists($kernel->getBuildDir().'/Symfony');
         self::assertDirectoryDoesNotExist($kernel->getCacheDir().'/Symfony');
     }
diff --git a/Tests/Command/CacheClearCommand/Fixture/TestAppKernel.php b/Tests/Command/CacheClearCommand/Fixture/TestAppKernel.php
@@ -52,7 +52,7 @@ public function isOptional(): bool
         return false;
     }
 
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
         file_put_contents($cacheDir.'/dummy.txt', 'Hello');
 
diff --git a/Translation/Translator.php b/Translation/Translator.php
@@ -95,9 +95,9 @@ public function __construct(ContainerInterface $container, MessageFormatterInter
     }
 
     /**
-     * @return string[]
+     * @param string|null $buildDir
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir /* , string $buildDir = null */): array
     {
         // skip warmUp when translator doesn't use cache
         if (null === $this->options['cache_dir']) {

Original file line number	Diff line number	Diff line change
`@@ -35,15 +35,16 @@ public function isOptional(): bool`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/**`
`38`		`- * @return string[] A list of classes to preload on PHP 7.4+`
	`38`	`+ * @param string\|null $buildDir`
`39`	`39`	`*/`
`40`		`- public function warmUp(string $cacheDir): array`
	`40`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`41`	`41`	`{`
	`42`	`+ $buildDir = 1 < \func_num_args() ? func_get_arg(1) : null;`
`42`	`43`	`$arrayAdapter = new ArrayAdapter();`
`43`	`44`
`44`	`45`	`spl_autoload_register([ClassExistenceResource::class, 'throwOnRequiredClass']);`
`45`	`46`	`try {`
`46`		`- if (!$this->doWarmUp($cacheDir, $arrayAdapter)) {`
	`47`	`+ if (!$this->doWarmUp($cacheDir, $arrayAdapter, $buildDir)) {`
`47`	`48`	`return [];`
`48`	`49`	`}`
`49`	`50`	`} finally {`
`@@ -78,7 +79,9 @@ final protected function ignoreAutoloadException(string $class, \Exception $exce`
`78`	`79`	`}`
`79`	`80`
`80`	`81`	`/**`
	`82`	`+ * @param string\|null $buildDir`
	`83`	`+ *`
`81`	`84`	`* @return bool false if there is nothing to warm-up`
`82`	`85`	`*/`
`83`		`- abstract protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool;`
	`86`	`+ abstract protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool;`
`84`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,10 @@ public function __construct(`
`44`	`44`	`parent::__construct($phpArrayFile);`
`45`	`45`	`}`
`46`	`46`
`47`		`- protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool`
	`47`	`+ /**`
	`48`	`+ * @param string\|null $buildDir`
	`49`	`+ */`
	`50`	`+ protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool`
`48`	`51`	`{`
`49`	`52`	`$annotatedClassPatterns = $cacheDir.'/annotations.map';`
`50`	`53`
Original file line number	Diff line number	Diff line change
`@@ -37,10 +37,7 @@ public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])`
`37`	`37`	`$this->pools = $pools;`
`38`	`38`	`}`
`39`	`39`
`40`		`- /**`
`41`		`- * @return string[]`
`42`		`- */`
`43`		`- public function warmUp(string $cacheDirectory): array`
	`40`	`+ public function warmUp(string $cacheDir, string $buildDir = null): array`
`44`	`41`	`{`
`45`	`42`	`foreach ($this->pools as $pool) {`
`46`	`43`	`if ($this->poolClearer->hasPool($pool)) {`
Original file line number	Diff line number	Diff line change
`@@ -34,12 +34,12 @@ public function __construct(ContainerInterface $container)`
`34`	`34`	`$this->container = $container;`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function warmUp(string $cacheDir): array`
	`37`	`+ public function warmUp(string $cacheDir, string $buildDir = null): array`
`38`	`38`	`{`
`39`	`39`	`$router = $this->container->get('router');`
`40`	`40`
`41`	`41`	`if ($router instanceof WarmableInterface) {`
`42`		`- return (array) $router->warmUp($cacheDir);`
	`42`	`+ return (array) $router->warmUp($cacheDir, $buildDir);`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,10 @@ public function __construct(array $loaders, string $phpArrayFile)`
`39`	`39`	`$this->loaders = $loaders;`
`40`	`40`	`}`
`41`	`41`
`42`		`- protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter): bool`
	`42`	`+ /**`
	`43`	`+ * @param string\|null $buildDir`
	`44`	`+ */`
	`45`	`+ protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter /* , string $buildDir = null */): bool`
`43`	`46`	`{`
`44`	`47`	`if (!$this->loaders) {`
`45`	`48`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -34,14 +34,16 @@ public function __construct(ContainerInterface $container)`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * @return string[]`
	`37`	`+ * @param string\|null $buildDir`
`38`	`38`	`*/`
`39`		`- public function warmUp(string $cacheDir): array`
	`39`	`+ public function warmUp(string $cacheDir /* , string $buildDir = null */): array`
`40`	`40`	`{`
`41`	`41`	`$this->translator ??= $this->container->get('translator');`
`42`	`42`
`43`	`43`	`if ($this->translator instanceof WarmableInterface) {`
`44`		`- return (array) $this->translator->warmUp($cacheDir);`
	`44`	`+ $buildDir = 1 < \func_num_args() ? func_get_arg(1) : null;`
	`45`	`+`
	`46`	`+ return (array) $this->translator->warmUp($cacheDir, $buildDir);`
`45`	`47`	`}`
`46`	`48`
`47`	`49`	`return [];`