[FrameworkBundle][HttpKernel] Fix behavior of cache-warmers regarding cache vs build dirs

nicolas-grekas · nicolas-grekas · commit 0b0a8fa3c8e4 · 2024-06-27T14:16:27.000+02:00
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, $warmupDir, $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/Component/HttpKernel/CacheWarmer/CacheWarmerInterface.php b/src/Symfony/Component/HttpKernel/CacheWarmer/CacheWarmerInterface.php
@@ -26,6 +26,9 @@ interface CacheWarmerInterface extends WarmableInterface
      * A warmer should return true if the cache can be
      * generated incrementally and on-demand.
      *
+     * Note that optional cache-warmers are never called
+     * with a $buildDir {@see WarmableInterface::warmUp()}
+     *
      * @return bool
      */
     public function isOptional();
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -539,10 +539,10 @@ protected function initializeContainer()
             touch($oldContainerDir.'.legacy');
         }
 
-        $preload = $this instanceof WarmableInterface ? (array) $this->warmUp($this->container->getParameter('kernel.cache_dir'), $buildDir) : [];
+        $preload = $this instanceof WarmableInterface ? (array) $this->warmUp($buildDir, $buildDir) : [];
 
         if ($this->container->has('cache_warmer')) {
-            $preload = array_merge($preload, (array) $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'), $buildDir));
+            $preload = array_merge($preload, (array) $this->container->get('cache_warmer')->warmUp($buildDir, $buildDir));
         }
 
         if ($preload && file_exists($preloadFile = $buildDir.'/'.$class.'.preload.php')) {

Original file line number	Diff line number	Diff line change
`@@ -539,10 +539,10 @@ protected function initializeContainer()`
`539`	`539`	`touch($oldContainerDir.'.legacy');`
`540`	`540`	`}`
`541`	`541`
`542`		`- $preload = $this instanceof WarmableInterface ? (array) $this->warmUp($this->container->getParameter('kernel.cache_dir'), $buildDir) : [];`
	`542`	`+ $preload = $this instanceof WarmableInterface ? (array) $this->warmUp($buildDir, $buildDir) : [];`
`543`	`543`
`544`	`544`	`if ($this->container->has('cache_warmer')) {`
`545`		`- $preload = array_merge($preload, (array) $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'), $buildDir));`
	`545`	`+ $preload = array_merge($preload, (array) $this->container->get('cache_warmer')->warmUp($buildDir, $buildDir));`
`546`	`546`	`}`
`547`	`547`
`548`	`548`	`if ($preload && file_exists($preloadFile = $buildDir.'/'.$class.'.preload.php')) {`