[FrameworkBundle] Use WarmableAggregate to warm read-only artifacts…

… in `build_dir`
symfony · May 22, 2023 · a575a7e · a575a7e
1 parent 9307f91
commit a575a7e
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 10 deletions.
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 6.3
 ---
 
+ * Use `WarmableAggregate` to warm read-only artifacts in `build_dir`
  * Add `extra` option for `http_client.default_options` and `http_client.scoped_client`
  * Add `DomCrawlerAssertionsTrait::assertSelectorCount(int $count, string $selector)`
  * Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy

diff --git a/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php b/src/Symfony/Bundle/FrameworkBundle/CacheWarmer/ConfigBuilderCacheWarmer.php
@@ -18,15 +18,15 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
-use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
+use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
 
 /**
  * Generate all config builders.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class ConfigBuilderCacheWarmer implements CacheWarmerInterface
+class ConfigBuilderCacheWarmer implements WarmableInterface
 {
     private KernelInterface $kernel;
     private ?LoggerInterface $logger;
@@ -76,9 +76,4 @@ private function dumpExtension(ExtensionInterface $extension, ConfigBuilderGener
 
         $generator->build($configuration);
     }
-
-    public function isOptional(): bool
-    {
-        return true;
-    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -23,8 +23,8 @@ class UnusedTagsPass implements CompilerPassInterface
 {
     private const KNOWN_TAGS = [
         'annotations.cached_reader',
-        'assets.package',
         'asset_mapper.compiler',
+        'assets.package',
         'auto_alias',
         'cache.pool',
         'cache.pool.clearer',
@@ -55,6 +55,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'form.type_guesser',
         'html_sanitizer',
         'http_client.client',
+        'kernel.build_warmer',
         'kernel.cache_clearer',
         'kernel.cache_warmer',
         'kernel.event_listener',

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -91,6 +91,7 @@
 use Symfony\Component\HttpKernel\Attribute\AsController;
 use Symfony\Component\HttpKernel\Attribute\AsTargetedValueResolver;
 use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
+use Symfony\Component\HttpKernel\CacheWarmer\BuildWarmerInterface;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\BackedEnumValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\UidValueResolver;
@@ -610,6 +611,8 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('form.type_extension');
         $container->registerForAutoconfiguration(CacheClearerInterface::class)
             ->addTag('kernel.cache_clearer');
+        $container->registerForAutoconfiguration(BuildWarmerInterface::class)
+            ->addTag('kernel.build_warmer');
         $container->registerForAutoconfiguration(CacheWarmerInterface::class)
             ->addTag('kernel.cache_warmer');
         $container->registerForAutoconfiguration(EventDispatcherInterface::class)

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php
@@ -38,6 +38,7 @@
 use Symfony\Component\HttpFoundation\UrlHelper;
 use Symfony\Component\HttpKernel\CacheClearer\ChainCacheClearer;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate;
+use Symfony\Component\HttpKernel\CacheWarmer\WarmableAggregate;
 use Symfony\Component\HttpKernel\Config\FileLocator;
 use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter;
 use Symfony\Component\HttpKernel\EventListener\LocaleAwareListener;
@@ -124,6 +125,15 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
             ])
         ->alias(UrlHelper::class, 'url_helper')
 
+        ->set('build_warmer', WarmableAggregate::class)
+            ->public()
+            ->args([
+                tagged_iterator('kernel.build_warmer'),
+                param('kernel.debug'),
+                sprintf('%s/%sDeprecations.log', param('kernel.build_dir'), param('kernel.container_class')),
+            ])
+            ->tag('container.no_preload')
+
         ->set('cache_warmer', CacheWarmerAggregate::class)
             ->public()
             ->args([
@@ -227,7 +237,7 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
             ])
         ->set('config_builder.warmer', ConfigBuilderCacheWarmer::class)
             ->args([service(KernelInterface::class), service('logger')->nullOnInvalid()])
-            ->tag('kernel.cache_warmer')
+            ->tag('kernel.build_warmer')
 
         ->set('clock', Clock::class)
         ->alias(ClockInterface::class, 'clock')

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ContainerDebugCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ContainerDebugCommandTest.php
@@ -128,10 +128,11 @@ public function testTagsPartialSearch()
         $this->assertStringContainsString('Select one of the following tags to display its information', $tester->getDisplay());
         $this->assertStringContainsString('[0] kernel.event_subscriber', $tester->getDisplay());
         $this->assertStringContainsString('[1] kernel.locale_aware', $tester->getDisplay());
-        $this->assertStringContainsString('[2] kernel.cache_warmer', $tester->getDisplay());
+        $this->assertStringContainsString('[2] kernel.build_warmer', $tester->getDisplay());
         $this->assertStringContainsString('[3] kernel.fragment_renderer', $tester->getDisplay());
         $this->assertStringContainsString('[4] kernel.reset', $tester->getDisplay());
         $this->assertStringContainsString('[5] kernel.cache_clearer', $tester->getDisplay());
+        $this->assertStringContainsString('[6] kernel.cache_warmer', $tester->getDisplay());
         $this->assertStringContainsString('Symfony Container Services Tagged with "kernel.event_subscriber" Tag', $tester->getDisplay());
     }