[FrameworkBundle][HttpKernel] Display warmers duration on debug verbosity for cache:clear command

Author: alexandre-daubois

CacheWarmer/CacheWarmerAggregate.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\HttpKernel\CacheWarmer;
 
+use Symfony\Component\Console\Style\SymfonyStyle;
+
 /**
  * Aggregates several cache warmers into a single one.
  *
@@ -46,7 +48,7 @@ public function enableOnlyOptionalWarmers(): void
         $this->onlyOptionalsEnabled = $this->optionalsEnabled = true;
     }
 
-    public function warmUp(string $cacheDir): array
+    public function warmUp(string $cacheDir, SymfonyStyle $io = null): array
     {
         if ($collectDeprecations = $this->debug && !\defined('PHPUNIT_COMPOSER_INSTALL')) {
             $collectedLogs = [];
@@ -93,12 +95,17 @@ public function warmUp(string $cacheDir): array
                     continue;
                 }
 
+                $start = microtime(true);
                 foreach ((array) $warmer->warmUp($cacheDir) as $item) {
                     if (is_dir($item) || (str_starts_with($item, \dirname($cacheDir)) && !is_file($item))) {
                         throw new \LogicException(sprintf('"%s::warmUp()" should return a list of files or classes but "%s" is none of them.', $warmer::class, $item));
                     }
                     $preload[] = $item;
                 }
+
+                if ($io?->isDebug()) {
+                    $io->info(sprintf('"%s" completed in %0.2fms.', $warmer::class, 1000 * (microtime(true) - $start)));
+                }
             }
         } finally {
             if ($collectDeprecations) {

Tests/CacheWarmer/CacheWarmerAggregateTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpKernel\Tests\CacheWarmer;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerAggregate;
 use Symfony\Component\HttpKernel\CacheWarmer\CacheWarmerInterface;
 
@@ -91,4 +92,54 @@ public function testWarmupChecksInvalidFiles()
         $this->expectException(\LogicException::class);
         $aggregate->warmUp(__DIR__);
     }
+
+    public function testWarmupWhenDebugDisplaysWarmupDuration()
+    {
+        $warmer = $this->createMock(CacheWarmerInterface::class);
+        $io = $this->createMock(SymfonyStyle::class);
+
+        $io
+            ->expects($this->once())
+            ->method('isDebug')
+            ->willReturn(true)
+        ;
+
+        $io
+            ->expects($this->once())
+            ->method('info')
+            ->with($this->matchesRegularExpression('/"(.+)" completed in (.+)ms\./'))
+        ;
+
+        $warmer
+            ->expects($this->once())
+            ->method('warmUp');
+
+        $aggregate = new CacheWarmerAggregate([$warmer]);
+        $aggregate->warmUp(__DIR__, $io);
+    }
+
+    public function testWarmupWhenNotDebugDoesntDisplayWarmupDuration()
+    {
+        $warmer = $this->createMock(CacheWarmerInterface::class);
+        $io = $this->createMock(SymfonyStyle::class);
+
+        $io
+            ->expects($this->once())
+            ->method('isDebug')
+            ->willReturn(false)
+        ;
+
+        $io
+            ->expects($this->never())
+            ->method('info')
+            ->with($this->matchesRegularExpression('/"(.+)" completed in (.+)ms\./'))
+        ;
+
+        $warmer
+            ->expects($this->once())
+            ->method('warmUp');
+
+        $aggregate = new CacheWarmerAggregate([$warmer]);
+        $aggregate->warmUp(__DIR__, $io);
+    }
 }