[FrameworkBundle] cache ClassMetadataFactory in debug

bastnic · bastnic · commit 07b42d9e432e · 2019-12-26T01:52:58.000+01:00
We already track modification in serialization/validator config directory so we just need to clear the cache at warmup. Idea taken from apip: https://github.com/api-platform/core/blob/master/src/Bridge/Symfony/Bundle/CacheWarmer/CachePoolClearerCacheWarmer.php
diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/CachePoolClearerCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/CachePoolClearerCacheWarmer.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\CacheWarmer;
+
+use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
+use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
+
+/**
+ * Clears the cache pools when warming up the cache.
+ *
+ * Do not use in production!
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @internal
+ */
+final class CachePoolClearerCacheWarmer implements CacheWarmerInterface
+{
+    private $poolClearer;
+    private $pools;
+
+    public function __construct(Psr6CacheClearer $poolClearer, array $pools = [])
+    {
+        $this->poolClearer = $poolClearer;
+        $this->pools = $pools;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function warmUp($cacheDirectory): void
+    {
+        foreach ($this->pools as $pool) {
+            if ($this->poolClearer->hasPool($pool)) {
+                $this->poolClearer->clearPool($pool);
+            }
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isOptional(): bool
+    {
+        // optional cache warmers are not run when handling the request
+        return false;
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1457,10 +1457,6 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
         $chainLoader->replaceArgument(0, $serializerLoaders);
         $container->getDefinition('serializer.mapping.cache_warmer')->replaceArgument(0, $serializerLoaders);
 
-        if ($container->getParameter('kernel.debug')) {
-            $container->removeDefinition('serializer.mapping.cache_class_metadata_factory');
-        }
-
         if (isset($config['name_converter']) && $config['name_converter']) {
             $container->getDefinition('serializer.name_converter.metadata_aware')->setArgument(1, new Reference($config['name_converter']));
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache_debug.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache_debug.xml
@@ -11,5 +11,15 @@
         <service id="data_collector.cache" class="Symfony\Component\Cache\DataCollector\CacheDataCollector" public="true">
             <tag name="data_collector" template="@WebProfiler/Collector/cache.html.twig" id="cache" priority="275" />
         </service>
+
+        <!-- CacheWarmer used in dev to clear cache pool -->
+        <service id="cache_pool_clearer.cache_warmer" class="Symfony\Bundle\FrameworkBundle\CacheWarmer\CachePoolClearerCacheWarmer" public="false">
+            <argument type="service" id="cache.system_clearer" />
+            <argument type="collection">
+                <argument>cache.validator</argument>
+                <argument>cache.serializer</argument>
+            </argument>
+            <tag name="kernel.cache_warmer" priority="64" />
+        </service>
     </services>
 </container>
