[HttpKernel] allow cache warmers to add to the list of preloaded clas…

…ses and files
symfony · fabpot · Apr 5, 2020 · Mar 25, 2020 · Apr 4, 2020 · 8ab75d99d4cda5237b48ee3e4a1f361fe78ae8e5
commit 8ab75d99d4cda5237b48ee3e4a1f361fe78ae8e5
diff --git a/UPGRADE-5.1.md b/UPGRADE-5.1.md
@@ -59,6 +59,8 @@ HttpFoundation
 HttpKernel
 ----------

+ * Made `WarmableInterface::warmUp()` return a list of classes or files to preload on PHP 7.4+
+   not returning an array is deprecated
 * Deprecated support for `service:action` syntax to reference controllers. Use `serviceOrFqcn::method` instead.

 Mailer

diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -56,6 +56,7 @@ HttpFoundation
 HttpKernel
 ----------

+ * Made `WarmableInterface::warmUp()` return a list of classes or files to preload on PHP 7.4+
 * Removed support for `service:action` syntax to reference controllers. Use `serviceOrFqcn::method` instead.

 Messenger

diff --git a/src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php b/src/Symfony/Bridge/Doctrine/CacheWarmer/ProxyCacheWarmer.php
@@ -43,9 +43,12 @@ public function isOptional()

    /**
     * {@inheritdoc}
+     *
+     * @return string[] A list of files to preload on PHP 7.4+
     */
    public function warmUp(string $cacheDir)
    {
+        $files = [];
        foreach ($this->registry->getManagers() as $em) {
            // we need the directory no matter the proxy cache generation strategy
            if (!is_dir($proxyCacheDir = $em->getConfiguration()->getProxyDir())) {
@@ -64,6 +67,14 @@ public function warmUp(string $cacheDir)
            $classes = $em->getMetadataFactory()->getAllMetadata();

            $em->getProxyFactory()->generateProxyClasses($classes);
+
+            foreach (scandir($proxyCacheDir) as $file) {
+                if (!is_dir($file = $proxyCacheDir.'/'.$file)) {
+                    $files[] = $file;
+                }
+            }
        }
+
+        return $files;
    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/AbstractPhpFileCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/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);
    }

    /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/CachePoolClearerCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/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 [];
    }

    /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/RouterCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/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));

diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/TranslationsCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/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 [];
    }

    /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ValidatorCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/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));
    }

    /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php b/src/Symfony/Bundle/FrameworkBundle/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

diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php b/src/Symfony/Bundle/FrameworkBundle/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'),
+        ];
    }

    /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/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)

diff --git a/src/Symfony/Bundle/SecurityBundle/CacheWarmer/ExpressionCacheWarmer.php b/src/Symfony/Bundle/SecurityBundle/CacheWarmer/ExpressionCacheWarmer.php
@@ -34,10 +34,15 @@ public function isOptional()
        return true;
    }

+    /**
+     * @return string[]
+     */
    public function warmUp(string $cacheDir)
    {
        foreach ($this->expressions as $expression) {
            $this->expressionLanguage->parse($expression, ['token', 'user', 'object', 'subject', 'roles', 'request', 'trust_resolver']);
        }
+
+        return [];
    }
 }
diff --git a/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php b/src/Symfony/Bundle/TwigBundle/CacheWarmer/TemplateCacheWarmer.php
@@ -37,21 +37,31 @@ public function __construct(ContainerInterface $container, iterable $iterator)

    /**
     * {@inheritdoc}
+     *
+     * @return string[] A list of template files to preload on PHP 7.4+
     */
    public function warmUp(string $cacheDir)
    {
        if (null === $this->twig) {
            $this->twig = $this->container->get('twig');
        }

+        $files = [];
+
        foreach ($this->iterator as $template) {
            try {
-                $this->twig->load($template);
+                $template = $this->twig->load($template);
+
+                if (\is_callable([$template, 'unwrap'])) {
+                    $files[] = (new \ReflectionClass($template->unwrap()))->getFileName();
+                }
            } catch (Error $e) {
                // problem during compilation, give up
                // might be a syntax error or a non-Twig template
            }
        }
+
+        return $files;
    }

    /**

diff --git a/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/PhpArrayAdapter.php
@@ -291,6 +291,8 @@ public function clear(string $prefix = '')
     * Store an array of cached values.
     *
     * @param array $values The cached values
+     *
+     * @return string[] A list of classes to preload on PHP 7.4+
     */
    public function warmUp(array $values)
    {
@@ -314,6 +316,7 @@ public function warmUp(array $values)
            }
        }

+        $preload = [];
        $dumpedValues = '';
        $dumpedMap = [];
        $dump = <<<'EOF'
@@ -334,7 +337,7 @@ public function warmUp(array $values)
                $value = "'N;'";
            } elseif (\is_object($value) || \is_array($value)) {
                try {
-                    $value = VarExporter::export($value, $isStaticValue);
+                    $value = VarExporter::export($value, $isStaticValue, $preload);
                } catch (\Exception $e) {
                    throw new InvalidArgumentException(sprintf('Cache key "%s" has non-serializable "%s" value.', $key, get_debug_type($value)), 0, $e);
                }
@@ -376,6 +379,8 @@ public function warmUp(array $values)
        unset(self::$valuesCache[$this->file]);

        $this->initialize();
+
+        return $preload;
    }

    /**

diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
 * updated the signature of method `DeprecateTrait::deprecate()` to `DeprecateTrait::deprecation(string $package, string $version, string $message)`
 * deprecated the `Psr\Container\ContainerInterface` and `Symfony\Component\DependencyInjection\ContainerInterface` aliases of the `service_container` service,
   configure them explicitly instead
+ * added class `Symfony\Component\DependencyInjection\Dumper\Preloader` to help with preloading on PHP 7.4+

 5.0.0
 -----

diff --git a/src/Symfony/Component/DependencyInjection/Dumper/Preloader.php b/src/Symfony/Component/DependencyInjection/Dumper/Preloader.php
@@ -13,12 +13,31 @@

 /**
 * @author Nicolas Grekas <p@tchwork.com>
- *
- * @internal
 */
-class Preloader
+final class Preloader
 {
-    public static function preload(array $classes)
+    public static function append(string $file, array $list): void
+    {
+        if (!file_exists($file)) {
+            throw new \LogicException(sprintf('File "%s" does not exist.', $file));
+        }
+
+        $cacheDir = \dirname($file);
+        $classes = [];
+
+        foreach ($list as $item) {
+            if (0 === strpos($item, $cacheDir)) {
+                file_put_contents($file, sprintf("require __DIR__.%s;\n", var_export(substr($item, \strlen($cacheDir)), true)), FILE_APPEND);
+                continue;
+            }
+
+            $classes[] = sprintf("\$classes[] = %s;\n", var_export($item, true));
+        }
+
+        file_put_contents($file, sprintf("\n\$classes = [];\n%sPreloader::preload(\$classes);\n", implode('', $classes)), FILE_APPEND);
+    }
+
+    public static function preload(array $classes): void
    {
        set_error_handler(function ($t, $m, $f, $l) {
            if (error_reporting() & $t) {

diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -4,6 +4,8 @@ CHANGELOG
 5.1.0
 -----

+ * made `WarmableInterface::warmUp()` return a list of classes or files to preload on PHP 7.4+;
+   not returning an array is deprecated
 * deprecated support for `service:action` syntax to reference controllers, use `serviceOrFqcn::method` instead
 * allowed using public aliases to reference controllers
 * added session usage reporting when the `_stateless` attribute of the request is set to `true`