[Icons] Improve cache warmup by looking at every string

Author: kbond

src/Icons/config/iconify.php

@@ -25,6 +25,7 @@
 
         ->set('.ux_icons.iconify', Iconify::class)
             ->args([
+                service('cache.system'),
                 abstract_arg('endpoint'),
                 service('http_client')->nullOnInvalid(),
             ])

src/Icons/doc/index.rst

@@ -115,6 +115,22 @@ In production, you can pre-warm the cache by running the following command:
 
 This command looks in all your twig templates for ``ux_icon`` calls and caches the icons it finds.
 
+.. caution::
+
+    Icons that have a name built dynamically will not be cached. It's advised to have the icon
+    name as a string literal in your templates.
+
+    .. code-block:: twig
+
+        {# This will be cached #}
+        {{ ux_icon('flag-fr') }}
+
+        {# This will NOT be cached #}
+        {{ ux_icon('flag-' ~ locale) }}
+
+        {% set flags = {fr: 'flag-fr', de: 'flag-de'} %} {# both "flag-fr" and "flag-de" will be cached #}
+        {{ ux_icon(flags[locale]) }}
+
 .. note::
 
     During development, if you modify an icon, you will need to clear the cache (``bin/console cache:clear``)

src/Icons/src/Command/WarmCacheCommand.php

@@ -45,7 +45,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                     $io->writeln(sprintf(' Warmed icon <comment>%s</comment>.', $name));
                 }
             },
-            onFailure: fn (string $name) => $io->warning(sprintf('Icon <comment>%s</comment> not found.', $name))
         );
 
         $io->success('Icon cache warmed.');

src/Icons/src/DependencyInjection/UXIconsExtension.php

@@ -91,7 +91,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
             $loader->load('iconify.php');
 
             $container->getDefinition('.ux_icons.iconify')
-                ->setArgument(0, $mergedConfig['iconify']['endpoint'])
+                ->setArgument(1, $mergedConfig['iconify']['endpoint'])
             ;
         }
 

src/Icons/src/Iconify.php

@@ -14,6 +14,7 @@
 use Symfony\Component\HttpClient\Exception\JsonException;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\HttpClient\ScopingHttpClient;
+use Symfony\Contracts\Cache\CacheInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Symfony\UX\Icons\Exception\IconNotFoundException;
 use Symfony\UX\Icons\Svg\Icon;
@@ -26,8 +27,10 @@
 final class Iconify
 {
     private HttpClientInterface $http;
+    private \ArrayObject $sets;
 
     public function __construct(
+        private CacheInterface $cache,
         string $endpoint = 'https://api.iconify.design',
         ?HttpClientInterface $http = null,
     ) {
@@ -40,13 +43,15 @@ public function __construct(
 
     public function metadataFor(string $prefix): array
     {
-        $response = $this->http->request('GET', sprintf('/collections?prefix=%s', $prefix));
-
-        return $response->toArray()[$prefix] ?? throw new \RuntimeException(sprintf('The icon prefix "%s" does not exist on iconify.design.', $prefix));
+        return $this->sets()[$prefix] ?? throw new \RuntimeException(sprintf('The icon prefix "%s" does not exist on iconify.design.', $prefix));
     }
 
     public function fetchIcon(string $prefix, string $name): Icon
     {
+        if (!isset($this->sets()[$prefix])) {
+            throw new IconNotFoundException(sprintf('The icon "%s:%s" does not exist on iconify.design.', $prefix, $name));
+        }
+
         $response = $this->http->request('GET', sprintf('/%s.json?icons=%s', $prefix, $name));
 
         try {
@@ -66,6 +71,10 @@ public function fetchIcon(string $prefix, string $name): Icon
 
     public function fetchSvg(string $prefix, string $name): string
     {
+        if (!isset($this->sets()[$prefix])) {
+            throw new IconNotFoundException(sprintf('The icon "%s:%s" does not exist on iconify.design.', $prefix, $name));
+        }
+
         $content = $this->http
             ->request('GET', sprintf('/%s/%s.svg', $prefix, $name))
             ->getContent()
@@ -77,4 +86,13 @@ public function fetchSvg(string $prefix, string $name): string
 
         return $content;
     }
+
+    private function sets(): \ArrayObject
+    {
+        return $this->sets ??= $this->cache->get('ux-iconify-sets', function () {
+            $response = $this->http->request('GET', '/collections');
+
+            return new \ArrayObject($response->toArray());
+        });
+    }
 }

src/Icons/src/Twig/IconFinder.php

@@ -38,11 +38,7 @@ public function icons(): array
         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)) {
+            if (preg_match_all('#["\']([\w:-]+)["\']#', $contents, $matches)) {
                 $found[] = $matches[1];
             }
         }

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

@@ -1,3 +1,5 @@
+{% set icon = 'flag:eu-4x3' %}
+
 {{ ux_icon('something:invalid') }}
 {{ ux_icon('invalid') }}
 {{ ux_icon('iconamoon:invalid') }}

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

@@ -29,6 +29,7 @@ public function testCanWarmCache(): void
             ->assertOutputContains('Warmed icon user.')
             ->assertOutputContains('Warmed icon sub:check.')
             ->assertOutputContains('Warmed icon iconamoon:3d-duotone.')
+            ->assertOutputContains('Warmed icon flag:eu-4x3.')
             ->assertOutputContains('Icon cache warmed.')
         ;
     }