Better Cache Strategy Support

assets/src/connection-status_controller.js

@@ -38,7 +38,7 @@ export default class extends Controller {
         });
     }
     dispatchEvent = (name, payload) => {
-        this.dispatch(name, { detail: payload, prefix: 'connection-status' });
+        this.dispatch(name, { detail: payload });
     }
 
     statusChanged = (data) => {

assets/src/sync-broadcast_controller.js

@@ -26,7 +26,7 @@ export default class extends Controller {
     }
 
     dispatchEvent = (name, payload) => {
-        this.dispatch(name, { detail: payload, prefix: 'connection-status' });
+        this.dispatch(name, { detail: payload });
     }
 
     messageReceived = async (event) => {

src/Command/ListCacheStrategiesCommand.php

@@ -5,13 +5,16 @@
 namespace SpomkyLabs\PwaBundle\Command;
 
 use SpomkyLabs\PwaBundle\Service\HasCacheStrategies;
+use SpomkyLabs\PwaBundle\Service\Plugin\CachePlugin;
+use SpomkyLabs\PwaBundle\Service\WorkboxCacheStrategy;
 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\Component\DependencyInjection\Attribute\TaggedIterator;
 use Symfony\Component\Yaml\Yaml;
+use function count;
 
 #[AsCommand(name: 'pwa:cache:list-strategies', description: 'List the available cache strategies',)]
 final class ListCacheStrategiesCommand extends Command
@@ -32,18 +35,35 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io->title('Cache Strategies');
 
         $table = $io->createTable();
-        $table->setHeaders(['Name', 'Strategy', 'URL pattern', 'Enabled', 'Workbox?', 'Options']);
+        $table->setHeaders(
+            ['Name', 'Strategy', 'URL pattern', 'Enabled', 'Workbox?', 'Plugins', 'Preload URLs', 'Options']
+        );
         foreach ($this->services as $service) {
             $strategies = $service->getCacheStrategies();
             foreach ($strategies as $strategy) {
-                $table->addRow([
-                    $strategy->name,
-                    $strategy->strategy,
-                    $strategy->urlPattern,
-                    $strategy->enabled ? 'Yes' : 'No',
-                    $strategy->requireWorkbox ? 'Yes' : 'No',
-                    Yaml::dump($strategy->options),
-                ]);
+                if ($strategy instanceof WorkboxCacheStrategy) {
+                    $table->addRow([
+                        $strategy->name,
+                        $strategy->strategy,
+                        $strategy->matchCallback,
+                        $strategy->enabled ? 'Yes' : 'No',
+                        $strategy->requireWorkbox ? 'Yes' : 'No',
+                        Yaml::dump(array_map(fn (CachePlugin $v): string => $v->name, $strategy->plugins)),
+                        count($strategy->preloadUrls),
+                        Yaml::dump($strategy->options),
+                    ]);
+                } else {
+                    $table->addRow([
+                        $strategy->name,
+                        $strategy->strategy,
+                        $strategy->matchCallback,
+                        $strategy->enabled ? 'Yes' : 'No',
+                        $strategy->requireWorkbox ? 'Yes' : 'No',
+                        '',
+                        '',
+                        '',
+                    ]);
+                }
             }
         }
         $table->render();

src/Dto/AssetCache.php

@@ -4,17 +4,9 @@
 
 namespace SpomkyLabs\PwaBundle\Dto;
 
-use Symfony\Component\Serializer\Attribute\SerializedName;
-
-final class AssetCache
+final class AssetCache extends Cache
 {
     public bool $enabled = true;
 
-    #[SerializedName('cache_name')]
-    public string $cacheName = 'assets';
-
     public string $regex = '/\.(css|js|json|xml|txt|map|ico|png|jpe?g|gif|svg|webp|bmp)$/';
-
-    #[SerializedName('max_age')]
-    public int $maxAge = 60 * 60 * 24 * 365;
 }

src/Dto/BackgroundSync.php

@@ -6,12 +6,13 @@
 
 use Symfony\Component\Serializer\Attribute\SerializedName;
 
-final class BackgroundSync
+final class BackgroundSync extends Cache
 {
     #[SerializedName('queue_name')]
     public string $queueName;
 
-    public string $regex;
+    #[SerializedName('match_callback')]
+    public string $matchCallback;
 
     public string $method;
 

src/Dto/Cache.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SpomkyLabs\PwaBundle\Dto;
+
+use DateInterval;
+use DateTimeImmutable;
+use Symfony\Component\Serializer\Attribute\SerializedName;
+use function is_string;
+
+abstract class Cache
+{
+    #[SerializedName('cache_name')]
+    public null|string $cacheName = null;
+
+    #[SerializedName('max_age')]
+    public null|string|int $maxAge = null;
+
+    #[SerializedName('max_entries')]
+    public null|int $maxEntries = 60;
+
+    public function maxAgeInSeconds(): null|int
+    {
+        if ($this->maxAge === null) {
+            return null;
+        }
+        if (is_string($this->maxAge)) {
+            $now = new DateTimeImmutable();
+            $future = $now->add(DateInterval::createFromDateString($this->maxAge));
+            return abs($future->getTimestamp() - $now->getTimestamp());
+        }
+        return $this->maxAge;
+    }
+}

src/Dto/FontCache.php

@@ -6,19 +6,10 @@
 
 use Symfony\Component\Serializer\Attribute\SerializedName;
 
-final class FontCache
+final class FontCache extends Cache
 {
     public bool $enabled = true;
 
-    #[SerializedName('cache_name')]
-    public string $cacheName = 'fonts';
-
     #[SerializedName('regex')]
     public string $regex = '/\.(ttf|eot|otf|woff2)$/';
-
-    #[SerializedName('max_entries')]
-    public int $maxEntries = 60;
-
-    #[SerializedName('max_age')]
-    public int $maxAge = 60;
 }

src/Dto/GoogleFontCache.php

@@ -6,16 +6,10 @@
 
 use Symfony\Component\Serializer\Attribute\SerializedName;
 
-final class GoogleFontCache
+final class GoogleFontCache extends Cache
 {
     public bool $enabled;
 
     #[SerializedName('cache_prefix')]
     public null|string $cachePrefix = null;
-
-    #[SerializedName('max_age')]
-    public null|int $maxAge = null;
-
-    #[SerializedName('max_entries')]
-    public null|int $maxEntries = null;
 }

src/Dto/ImageCache.php

@@ -6,19 +6,10 @@
 
 use Symfony\Component\Serializer\Attribute\SerializedName;
 
-final class ImageCache
+final class ImageCache extends Cache
 {
     public bool $enabled = true;
 
-    #[SerializedName('cache_name')]
-    public string $cacheName = 'assets';
-
     #[SerializedName('regex')]
     public string $regex = '/\.(ico|png|jpe?g|gif|svg|webp|bmp)$/';
-
-    #[SerializedName('max_entries')]
-    public int $maxEntries = 60;
-
-    #[SerializedName('max_age')]
-    public int $maxAge = 60;
 }

src/Dto/PageCache.php

@@ -6,21 +6,33 @@
 
 use Symfony\Component\Serializer\Attribute\SerializedName;
 
-final class PageCache
+final class PageCache extends Cache
 {
-    #[SerializedName('cache_name')]
-    public string $cacheName;
-
-    #[SerializedName('regex')]
-    public string $regex;
+    #[SerializedName('match_callback')]
+    public string $matchCallback;
 
     #[SerializedName('network_timeout')]
     public int $networkTimeout = 3;
 
-    public string $strategy = 'networkFirst';
+    public string $strategy = 'NetworkFirst';
 
     public bool $broadcast = false;
 
+    #[SerializedName('range_requests')]
+    public bool $rangeRequests = false;
+
+    /**
+     * @var int[]
+     */
+    #[SerializedName('cacheable_response_statuses')]
+    public array $cacheableResponseStatuses = [0, 200];
+
+    /**
+     * @var null|array<string, string>
+     */
+    #[SerializedName('cacheable_response_headers')]
+    public array $cacheableResponseHeaders = [];
+
     /**
      * @var array<string>
      */
@@ -30,5 +42,6 @@ final class PageCache
     /**
      * @var array<Url>
      */
+    #[SerializedName('preload_urls')]
     public array $urls = [];
 }