[FrameworkBundle] Provide $buildDir when running CacheWarmer to build read-only resources

Okhoshi · Okhoshi · commit 3b806334d3ac · 2023-10-09T16:47:45.000+02:00
Signed-off-by: Quentin Devos &lt;4972091+Okhoshi@users.noreply.github.com&gt;
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -29,6 +29,7 @@ CHANGELOG
  * Add support for relative URLs in BrowserKit's redirect assertion
  * Change BrowserKitAssertionsTrait::getClient() to be protected
  * Deprecate the `framework.asset_mapper.provider` config option
+ * Provide `$buildDir` when running `CacheWarmer` to build read-only resources
 
 6.3
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php
@@ -40,9 +40,13 @@ public function __construct(KernelInterface $kernel, LoggerInterface $logger = n
     /**
      * @return string[]
      */
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, string $buildDir = null): array
     {
-        $generator = new ConfigBuilderGenerator($this->kernel->getBuildDir());
+        if (null === $buildDir) {
+            return [];
+        }
+
+        $generator = new ConfigBuilderGenerator($buildDir);
 
         foreach ($this->kernel->getBundles() as $bundle) {
             $extension = $bundle->getContainerExtension();
@@ -79,6 +83,6 @@ private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGener
 
     public function isOptional(): bool
     {
-        return true;
+        return false;
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php b/src/Symfony/Bundle/FrameworkBundle/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, null, $io);
 
         if ($preload && file_exists($preloadFile = $warmupDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
             Preloader::append($preloadFile, $preload);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CacheWarmupCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CacheWarmupCommand.php
@@ -66,9 +66,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->cacheWarmer->enableOptionalWarmers();
         }
 
-        $preload = $this->cacheWarmer->warmUp($cacheDir = $kernel->getContainer()->getParameter('kernel.cache_dir'));
+        $preload = $this->cacheWarmer->warmUp($kernel->getContainer()->getParameter('kernel.cache_dir'));
 
-        if ($preload && file_exists($preloadFile = $cacheDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
+        if ($preload && file_exists($preloadFile = $kernel->getContainer()->getParameter('kernel.build_dir').'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
             Preloader::append($preloadFile, $preload);
         }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/ConfigBuilderCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/ConfigBuilderCacheWarmerTest.php
@@ -15,9 +15,11 @@
 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;
+use Symfony\Component\HttpKernel\KernelInterface;
 
 class ConfigBuilderCacheWarmerTest extends TestCase
 {
@@ -39,7 +41,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 +77,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');
     }

Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,13 @@ public function __construct(KernelInterface $kernel, LoggerInterface $logger = n`
`40`	`40`	`/**`
`41`	`41`	`* @return string[]`
`42`	`42`	`*/`
`43`		`- public function warmUp(string $cacheDir): array`
	`43`	`+ public function warmUp(string $cacheDir, string $buildDir = null): array`
`44`	`44`	`{`
`45`		`- $generator = new ConfigBuilderGenerator($this->kernel->getBuildDir());`
	`45`	`+ if (null === $buildDir) {`
	`46`	`+ return [];`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ $generator = new ConfigBuilderGenerator($buildDir);`
`46`	`50`
`47`	`51`	`foreach ($this->kernel->getBundles() as $bundle) {`
`48`	`52`	`$extension = $bundle->getContainerExtension();`
`@@ -79,6 +83,6 @@ private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGener`
`79`	`83`
`80`	`84`	`public function isOptional(): bool`
`81`	`85`	`{`
`82`		`- return true;`
	`86`	`+ return false;`
`83`	`87`	`}`
`84`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`66`	`66`	`$this->cacheWarmer->enableOptionalWarmers();`
`67`	`67`	`}`
`68`	`68`
`69`		`- $preload = $this->cacheWarmer->warmUp($cacheDir = $kernel->getContainer()->getParameter('kernel.cache_dir'));`
	`69`	`+ $preload = $this->cacheWarmer->warmUp($kernel->getContainer()->getParameter('kernel.cache_dir'));`
`70`	`70`
`71`		`- if ($preload && file_exists($preloadFile = $cacheDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {`
	`71`	`+ if ($preload && file_exists($preloadFile = $kernel->getContainer()->getParameter('kernel.build_dir').'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {`
`72`	`72`	`Preloader::append($preloadFile, $preload);`
`73`	`73`	`}`
`74`	`74`