add ux:icons:warm-cache command

Author: kbond

src/Icons/README.md

@@ -57,6 +57,14 @@ site.
 
 To avoid having to parse icon files on every request, icons are cached.
 
+In production, you can pre-warm the cache by running the following command:
+
+```bash
+bin/console ux:icons:warm-cache
+```
+
+This command looks in all your twig templates for `ux_icon` calls and caches the icons it finds.
+
 > [!NOTE]
 > During development, if you change an icon, you will need to clear the cache (`bin/console cache:clear`)
 > to see the changes.

src/Icons/config/services.php

@@ -11,9 +11,11 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Symfony\UX\Icons\Command\WarmCacheCommand;
 use Symfony\UX\Icons\IconRenderer;
 use Symfony\UX\Icons\Registry\CacheIconRegistry;
 use Symfony\UX\Icons\Registry\LocalSvgIconRegistry;
+use Symfony\UX\Icons\Twig\IconFinder;
 use Symfony\UX\Icons\Twig\UXIconComponent;
 use Symfony\UX\Icons\Twig\UXIconComponentListener;
 use Symfony\UX\Icons\Twig\UXIconExtension;
@@ -53,5 +55,17 @@
 
         ->set('.ux_icons.twig_component.icon', UXIconComponent::class)
             ->tag('twig.component', ['key' => 'UX:Icon'])
+
+        ->set('.ux_icons.twig_icon_finder', IconFinder::class)
+            ->args([
+                service('twig'),
+            ])
+
+        ->set('.ux_icons.command.warm_cache', WarmCacheCommand::class)
+            ->args([
+                service('.ux_icons.cache_icon_registry'),
+                service('.ux_icons.twig_icon_finder'),
+            ])
+            ->tag('console.command')
     ;
 };

src/Icons/src/Command/WarmCacheCommand.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons\Command;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\UX\Icons\Exception\IconNotFoundException;
+use Symfony\UX\Icons\Registry\CacheIconRegistry;
+use Symfony\UX\Icons\Twig\IconFinder;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ *
+ * @internal
+ */
+#[AsCommand(
+    name: 'ux:icons:warm-cache',
+    description: 'Warm the icon cache',
+)]
+final class WarmCacheCommand extends Command
+{
+    public function __construct(private CacheIconRegistry $registry, private IconFinder $icons)
+    {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+        $io->comment('Warming the icon cache...');
+
+        foreach ($this->icons->icons() as $icon) {
+            try {
+                $this->registry->get($icon, refresh: true);
+
+                if ($output->isVerbose()) {
+                    $io->writeln(sprintf(' Warmed icon <comment>%s</comment>.', $icon));
+                }
+            } catch (IconNotFoundException) {
+            }
+        }
+
+        $io->success('Icon cache warmed.');
+
+        return Command::SUCCESS;
+    }
+}

src/Icons/src/Registry/CacheIconRegistry.php

@@ -27,12 +27,7 @@ public function __construct(private IconRegistryInterface $inner, private CacheI
     {
     }
 
-    public function get(string $name): Icon
-    {
-        return $this->fetchIcon($name);
-    }
-
-    private function fetchIcon(string $name, bool $refresh = false): Icon
+    public function get(string $name, bool $refresh = false): Icon
     {
         if (!Icon::isValidName($name)) {
             throw new IconNotFoundException(sprintf('The icon name "%s" is not valid.', $name));

src/Icons/src/Twig/IconFinder.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons\Twig;
+
+use Symfony\Component\Finder\Finder;
+use Twig\Environment;
+use Twig\Loader\ChainLoader;
+use Twig\Loader\FilesystemLoader;
+use Twig\Loader\LoaderInterface;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ *
+ * @internal
+ */
+final class IconFinder
+{
+    public function __construct(private Environment $twig)
+    {
+    }
+
+    /**
+     * @return string[]
+     */
+    public function icons(): array
+    {
+        $found = [];
+
+        foreach ($this->files($this->twig->getLoader()) as $file) {
+            $contents = file_get_contents($file);
+
+            if (preg_match_all('#ux_icon\(["\']([\w:-]+)["\']#', $contents, $matches)) {
+                $found[] = $matches[1];
+            }
+
+            if (preg_match_all('#name=["\']([\w:-]+)["\']#', $contents, $matches)) {
+                $found[] = $matches[1];
+            }
+        }
+
+        return array_unique(array_merge(...$found));
+    }
+
+    /**
+     * @return string[]
+     */
+    private function files(LoaderInterface $loader): iterable
+    {
+        $files = [];
+
+        if ($loader instanceof FilesystemLoader) {
+            foreach ($loader->getNamespaces() as $namespace) {
+                foreach ($loader->getPaths($namespace) as $path) {
+                    foreach ((new Finder())->files()->in($path)->name('*.twig') as $file) {
+                        $file = (string) $file;
+                        if (!\in_array($file, $files, true)) {
+                            yield $file;
+                        }
+
+                        $files[] = $file;
+                    }
+                }
+            }
+        }
+
+        if ($loader instanceof ChainLoader) {
+            foreach ($loader->getLoaders() as $subLoader) {
+                yield from $this->files($subLoader);
+            }
+        }
+    }
+}

src/Icons/tests/Fixtures/TestKernel.php

@@ -39,6 +39,10 @@ protected function configureContainer(ContainerConfigurator $c): void
             'http_client' => true,
         ]);
 
+        $c->extension('twig', [
+            'default_path' => __DIR__.'/templates',
+        ]);
+
         $c->extension('twig_component', [
             'defaults' => [],
             'anonymous_template_directory' => 'components',

src/Icons/tests/Fixtures/templates/template1.html.twig

@@ -0,0 +1,8 @@
+<ul class="svg">
+    <li id="first">{{ ux_icon('user', {class: 'h-8 w-8'}) }}</li>
+    <li id="second">{{ ux_icon('user') }}</li>
+    <li id="third">{{ ux_icon('sub:check', {'data-action': 'string "with" quotes'}) }}</li>
+    <li id="fifth"><twig:UX:Icon name="user" class="h-8 w-8" /></li>
+    <li id="sixth"><twig:UX:Icon name="sub:check" /></li>
+    <li id="seventh"><twig:UX:Icon :name="'sub:'~'check'" /></li>
+</ul>

src/Icons/tests/Fixtures/templates/template2.html.twig

@@ -0,0 +1,2 @@
+{{ ux_icon('something:invalid') }}
+{{ ux_icon('invalid') }}

src/Icons/tests/Integration/Command/WarmCacheCommandTest.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons\Tests\Integration\Command;
+
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Console\Test\InteractsWithConsole;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+final class WarmCacheCommandTest extends KernelTestCase
+{
+    use InteractsWithConsole;
+
+    public function testCanWarmCache(): void
+    {
+        $this->executeConsoleCommand('ux:icons:warm-cache -v')
+            ->assertSuccessful()
+            ->assertOutputContains('Warming the icon cache...')
+            ->assertOutputContains('Warmed icon user.')
+            ->assertOutputContains('Warmed icon sub:check.')
+            ->assertOutputContains('Icon cache warmed.')
+        ;
+    }
+}

src/Icons/tests/Integration/RenderIconsInTwigTest.php

@@ -21,17 +21,7 @@ final class RenderIconsInTwigTest extends KernelTestCase
 {
     public function testRenderIcons(): void
     {
-        $output = self::getContainer()->get(Environment::class)->createTemplate(<<<TWIG
-            <ul class="svg">
-                <li id="first">{{ ux_icon('user', {class: 'h-8 w-8'}) }}</li>
-                <li id="second">{{ ux_icon('user') }}</li>
-                <li id="third">{{ ux_icon('sub:check', {'data-action': 'string "with" quotes'}) }}</li>
-                <li id="fifth"><twig:UX:Icon name="user" class="h-8 w-8" /></li>
-                <li id="sixth"><twig:UX:Icon name="sub:check" /></li>
-                <li id="seventh"><twig:UX:Icon :name="'sub:'~'check'" /></li>
-            </ul>
-            TWIG
-        )->render();
+        $output = self::getContainer()->get(Environment::class)->render('template1.html.twig');
 
         $this->assertSame(<<<HTML
             <ul class="svg">
@@ -43,7 +33,7 @@ public function testRenderIcons(): void
                 <li id="seventh"><svg viewBox="0 0 24 24" fill="currentColor" class="w-6 h-6"><path fill-rule="evenodd" d="M19.916 4.626a.75.75 0 0 1 .208 1.04l-9 13.5a.75.75 0 0 1-1.154.114l-6-6a.75.75 0 0 1 1.06-1.06l5.353 5.353 8.493-12.74a.75.75 0 0 1 1.04-.207Z" clip-rule="evenodd"></path></svg></li>
             </ul>
             HTML,
-            preg_replace("#(\s+)</li>#m", '</li>', $output)
+            trim($output)
         );
     }
 }