[HttpKernel] allow cache warmers to add to the list of preloaded classes and files

Author: nicolas-grekas

CacheWarmer/AbstractPhpFileCacheWarmer.php

@@ -42,6 +42,8 @@ public function isOptional()
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[] A list of classes to preload on PHP 7.4+
      */
     public function warmUp(string $cacheDir)
     {
@@ -61,12 +63,15 @@ public function warmUp(string $cacheDir)
         // so here we un-serialize the values first
         $values = array_map(function ($val) { return null !== $val ? unserialize($val) : null; }, $arrayAdapter->getValues());
 
-        $this->warmUpPhpArrayAdapter(new PhpArrayAdapter($this->phpArrayFile, new NullAdapter()), $values);
+        return $this->warmUpPhpArrayAdapter(new PhpArrayAdapter($this->phpArrayFile, new NullAdapter()), $values);
     }
 
+    /**
+     * @return string[] A list of classes to preload on PHP 7.4+
+     */
     protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values)
     {
-        $phpArrayAdapter->warmUp($values);
+        return (array) $phpArrayAdapter->warmUp($values);
     }
 
     /**

CacheWarmer/CachePoolClearerCacheWarmer.php

@@ -36,14 +36,18 @@ public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[]
      */
-    public function warmUp($cacheDirectory): void
+    public function warmUp($cacheDirectory): array
     {
         foreach ($this->pools as $pool) {
             if ($this->poolClearer->hasPool($pool)) {
                 $this->poolClearer->clearPool($pool);
             }
         }
+
+        return [];
     }
 
     /**

CacheWarmer/RouterCacheWarmer.php

@@ -36,15 +36,15 @@ public function __construct(ContainerInterface $container)
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[]
      */
     public function warmUp(string $cacheDir)
     {
         $router = $this->container->get('router');
 
         if ($router instanceof WarmableInterface) {
-            $router->warmUp($cacheDir);
-
-            return;
+            return (array) $router->warmUp($cacheDir);
         }
 
         throw new \LogicException(sprintf('The router "%s" cannot be warmed up because it does not implement "%s".', get_debug_type($router), WarmableInterface::class));

CacheWarmer/TranslationsCacheWarmer.php

@@ -35,6 +35,8 @@ public function __construct(ContainerInterface $container)
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[]
      */
     public function warmUp(string $cacheDir)
     {
@@ -43,8 +45,10 @@ public function warmUp(string $cacheDir)
         }
 
         if ($this->translator instanceof WarmableInterface) {
-            $this->translator->warmUp($cacheDir);
+            return (array) $this->translator->warmUp($cacheDir);
         }
+
+        return [];
     }
 
     /**

CacheWarmer/ValidatorCacheWarmer.php

@@ -68,10 +68,13 @@ protected function doWarmUp(string $cacheDir, ArrayAdapter $arrayAdapter)
         return true;
     }
 
+    /**
+     * @return string[] A list of classes to preload on PHP 7.4+
+     */
     protected function warmUpPhpArrayAdapter(PhpArrayAdapter $phpArrayAdapter, array $values)
     {
         // make sure we don't cache null values
-        parent::warmUpPhpArrayAdapter($phpArrayAdapter, array_filter($values));
+        return parent::warmUpPhpArrayAdapter($phpArrayAdapter, array_filter($values));
     }
 
     /**

Command/CacheClearCommand.php

@@ -17,6 +17,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\DependencyInjection\Dumper\Preloader;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Filesystem\Exception\IOException;
 use Symfony\Component\Filesystem\Filesystem;
@@ -117,7 +118,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $warmer = $kernel->getContainer()->get('cache_warmer');
                 // non optional warmers already ran during container compilation
                 $warmer->enableOnlyOptionalWarmers();
-                $warmer->warmUp($realCacheDir);
+                $preload = (array) $warmer->warmUp($warmupDir);
+
+                if (file_exists($preloadFile = $warmupDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
+                    Preloader::append($preloadFile, $preload);
+                }
             }
         } else {
             $fs->mkdir($warmupDir);
@@ -193,7 +198,11 @@ private function warmup(string $warmupDir, string $realCacheDir, bool $enableOpt
             $warmer = $kernel->getContainer()->get('cache_warmer');
             // non optional warmers already ran during container compilation
             $warmer->enableOnlyOptionalWarmers();
-            $warmer->warmUp($warmupDir);
+            $preload = (array) $warmer->warmUp($warmupDir);
+
+            if (file_exists($preloadFile = $warmupDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
+                Preloader::append($preloadFile, $preload);
+            }
         }
 
         // fix references to cached files with the real cache directory name

Routing/Router.php

@@ -21,16 +21,11 @@
 use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
-use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\Routing\Router as BaseRouter;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
 
-// Help opcache.preload discover always-needed symbols
-class_exists(RedirectableCompiledUrlMatcher::class);
-class_exists(Route::class);
-
 /**
  * This Router creates the Loader only when the cache is empty.
  *
@@ -90,6 +85,8 @@ public function getRouteCollection()
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[] A list of classes to preload on PHP 7.4+
      */
     public function warmUp(string $cacheDir)
     {
@@ -101,6 +98,11 @@ public function warmUp(string $cacheDir)
         $this->getGenerator();
 
         $this->setOption('cache_dir', $currentDir);
+
+        return [
+            $this->getOption('generator_class'),
+            $this->getOption('matcher_class'),
+        ];
     }
 
     /**

Translation/Translator.php

@@ -95,6 +95,8 @@ public function __construct(ContainerInterface $container, MessageFormatterInter
 
     /**
      * {@inheritdoc}
+     *
+     * @return string[]
      */
     public function warmUp(string $cacheDir)
     {
@@ -113,6 +115,8 @@ public function warmUp(string $cacheDir)
 
             $this->loadCatalogue($locale);
         }
+
+        return [];
     }
 
     public function addResource(string $format, $resource, string $locale, string $domain = null)