Better Cache Strategy Support

Spomky-Labs · Mar 17, 2024 · 5e2e5a6 · 5e2e5a6
1 parent 1ef2470
commit 5e2e5a6
Show file tree

Hide file tree

Showing 15 changed files with 169 additions and 93 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -91,22 +91,22 @@ parameters:
 			path: src/Dto/BackgroundSync.php
 
 		-
-			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$maxRetentionTime\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$matchCallback\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1
 			path: src/Dto/BackgroundSync.php
 
 		-
-			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$method\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$maxRetentionTime\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1
 			path: src/Dto/BackgroundSync.php
 
 		-
-			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$queueName\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$method\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1
 			path: src/Dto/BackgroundSync.php
 
 		-
-			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$regex\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\BackgroundSync has an uninitialized property \\$queueName\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1
 			path: src/Dto/BackgroundSync.php
 
@@ -176,12 +176,12 @@ parameters:
 			path: src/Dto/Manifest.php
 
 		-
-			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\PageCache has an uninitialized property \\$cacheName\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\PageCache has an uninitialized property \\$matchCallback\\. Give it default value or assign it in the constructor\\.$#"
 			count: 1
 			path: src/Dto/PageCache.php
 
 		-
-			message: "#^Class SpomkyLabs\\\\PwaBundle\\\\Dto\\\\PageCache has an uninitialized property \\$regex\\. Give it default value or assign it in the constructor\\.$#"
+			message: "#^PHPDoc tag @var for property SpomkyLabs\\\\PwaBundle\\\\Dto\\\\PageCache\\:\\:\\$cacheableResponseHeaders with type array\\<string, string\\>\\|null is not subtype of native type array\\.$#"
 			count: 1
 			path: src/Dto/PageCache.php
 
@@ -492,14 +492,19 @@ parameters:
 
 		-
 			message: "#^Anonymous function should return array but returns mixed\\.$#"
-			count: 6
+			count: 8
 			path: src/Resources/config/definition/service_worker.php
 
 		-
 			message: "#^Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeDefinition\\:\\:children\\(\\)\\.$#"
 			count: 1
 			path: src/Resources/config/definition/service_worker.php
 
+		-
+			message: "#^Cannot access an offset on mixed\\.$#"
+			count: 1
+			path: src/Resources/config/definition/service_worker.php
+
 		-
 			message: "#^Cannot access offset 'asset_cache' on mixed\\.$#"
 			count: 2
@@ -560,11 +565,31 @@ parameters:
 			count: 1
 			path: src/Resources/config/definition/service_worker.php
 
+		-
+			message: "#^Cannot access offset 'network_timeout…' on mixed\\.$#"
+			count: 1
+			path: src/Resources/config/definition/service_worker.php
+
+		-
+			message: "#^Cannot access offset 'page_cache_name' on mixed\\.$#"
+			count: 1
+			path: src/Resources/config/definition/service_worker.php
+
+		-
+			message: "#^Cannot access offset 'page_caches' on mixed\\.$#"
+			count: 2
+			path: src/Resources/config/definition/service_worker.php
+
 		-
 			message: "#^Cannot access offset 'static_regex' on mixed\\.$#"
 			count: 1
 			path: src/Resources/config/definition/service_worker.php
 
+		-
+			message: "#^Cannot access offset 'warm_cache_urls' on mixed\\.$#"
+			count: 1
+			path: src/Resources/config/definition/service_worker.php
+
 		-
 			message: "#^Strict comparison using \\!\\=\\= between mixed and null will always evaluate to true\\.$#"
 			count: 3
@@ -626,25 +651,60 @@ parameters:
 			path: src/Resources/config/definition/web_client.php
 
 		-
-			message: "#^Parameter \\#6 \\$options of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\CacheStrategy\\:\\:create\\(\\) expects array\\{maxTimeout\\?\\: int, maxAge\\?\\: int, maxEntries\\?\\: int, warmUrls\\?\\: array\\<string\\>, plugins\\?\\: array\\<string\\>\\}, array\\{maxEntries\\: int\\<0, max\\>, maxAge\\: int, warmUrls\\: mixed\\} given\\.$#"
+			message: "#^Part \\$broadcastChannel \\(mixed\\) of encapsed string cannot be cast to string\\.$#"
+			count: 1
+			path: src/Service/Plugin/BackgroundSyncPlugin.php
+
+		-
+			message: "#^Part \\$maxRetentionTime \\(mixed\\) of encapsed string cannot be cast to string\\.$#"
+			count: 1
+			path: src/Service/Plugin/BackgroundSyncPlugin.php
+
+		-
+			message: "#^Part \\$queueName \\(mixed\\) of encapsed string cannot be cast to string\\.$#"
+			count: 2
+			path: src/Service/Plugin/BackgroundSyncPlugin.php
+
+		-
+			message: "#^Parameter \\#2 \\.\\.\\.\\$values of function sprintf expects bool\\|float\\|int\\|string\\|null, mixed given\\.$#"
+			count: 1
+			path: src/Service/Rule/AppendCacheStrategies.php
+
+		-
+			message: "#^Parameter \\#1 \\$name of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\WorkboxCacheStrategy\\:\\:create\\(\\) expects string, string\\|null given\\.$#"
+			count: 1
+			path: src/Service/Rule/AssetCache.php
+
+		-
+			message: "#^Parameter \\#8 \\$preloadUrls of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\WorkboxCacheStrategy\\:\\:create\\(\\) expects array\\<string\\>, mixed given\\.$#"
 			count: 1
 			path: src/Service/Rule/AssetCache.php
 
 		-
-			message: "#^Parameter \\#6 \\$options of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\CacheStrategy\\:\\:create\\(\\) expects array\\{maxTimeout\\?\\: int, maxAge\\?\\: int, maxEntries\\?\\: int, warmUrls\\?\\: array\\<string\\>, plugins\\?\\: array\\<string\\>\\}, array\\{maxAge\\: int\\|null, maxEntries\\: int\\|null\\} given\\.$#"
+			message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, mixed given\\.$#"
 			count: 1
-			path: src/Service/Rule/GoogleFontCache.php
+			path: src/Service/Rule/FontCache.php
+
+		-
+			message: "#^Parameter \\#8 \\$preloadUrls of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\WorkboxCacheStrategy\\:\\:create\\(\\) expects array\\<string\\>, mixed given\\.$#"
+			count: 1
+			path: src/Service/Rule/FontCache.php
 
 		-
 			message: "#^Strict comparison using \\=\\=\\= between int\\<1, max\\> and 0 will always evaluate to false\\.$#"
 			count: 1
 			path: src/Service/Rule/OfflineFallback.php
 
 		-
-			message: "#^Parameter \\#6 \\$options of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\CacheStrategy\\:\\:create\\(\\) expects array\\{maxTimeout\\?\\: int, maxAge\\?\\: int, maxEntries\\?\\: int, warmUrls\\?\\: array\\<string\\>, plugins\\?\\: array\\<string\\>\\}, array\\{maxTimeout\\: int, plugins\\: array\\{0\\: 'CacheableResponsePl…', 1\\?\\: 'BroadcastUpdatePlug…'\\}, warmUrls\\: mixed\\} given\\.$#"
+			message: "#^Parameter \\#8 \\$preloadUrls of static method SpomkyLabs\\\\PwaBundle\\\\Service\\\\WorkboxCacheStrategy\\:\\:create\\(\\) expects array\\<string\\>, mixed given\\.$#"
 			count: 1
 			path: src/Service/Rule/PageCaches.php
 
+		-
+			message: "#^Part \\$this\\-\\>options\\['networkTimeoutSeconds'\\] \\(mixed\\) of encapsed string cannot be cast to string\\.$#"
+			count: 1
+			path: src/Service/WorkboxCacheStrategy.php
+
 		-
 			message: "#^Method SpomkyLabs\\\\PwaBundle\\\\SpomkyLabsPwaBundle\\:\\:loadExtension\\(\\) has parameter \\$config with no value type specified in iterable type array\\.$#"
 			count: 1

diff --git a/src/Command/ListCacheStrategiesCommand.php b/src/Command/ListCacheStrategiesCommand.php
@@ -55,8 +55,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 } else {
                     $table->addRow([
                         $strategy->name,
-                        $strategy->strategy,
-                        $strategy->matchCallback,
+                        '---',
+                        '---',
                         $strategy->enabled ? 'Yes' : 'No',
                         $strategy->requireWorkbox ? 'Yes' : 'No',
                         '',

diff --git a/src/Dto/Cache.php b/src/Dto/Cache.php
@@ -6,6 +6,7 @@
 
 use DateInterval;
 use DateTimeImmutable;
+use InvalidArgumentException;
 use Symfony\Component\Serializer\Attribute\SerializedName;
 use function is_string;
 
@@ -27,7 +28,11 @@ public function maxAgeInSeconds(): null|int
         }
         if (is_string($this->maxAge)) {
             $now = new DateTimeImmutable();
-            $future = $now->add(DateInterval::createFromDateString($this->maxAge));
+            $interval = DateInterval::createFromDateString($this->maxAge);
+            if ($interval === false) {
+                throw new InvalidArgumentException('Invalid max age');
+            }
+            $future = $now->add($interval);
             return abs($future->getTimestamp() - $now->getTimestamp());
         }
         return $this->maxAge;

diff --git a/src/Service/Plugin/BackgroundSyncPlugin.php b/src/Service/Plugin/BackgroundSyncPlugin.php
@@ -39,4 +39,21 @@ public function render(int $jsonOptions = 0): string
 
         return trim($declaration);
     }
+
+    public static function create(
+        string $queueName,
+        int $maxRetentionTime,
+        bool $forceSyncFallback,
+        ?string $broadcastChannel
+    ): static {
+        return new self(
+            'BackgroundSyncPlugin',
+            [
+                'queueName' => $queueName,
+                'maxRetentionTime' => $maxRetentionTime,
+                'forceSyncFallback' => $forceSyncFallback,
+                'broadcastChannel' => $broadcastChannel,
+            ]
+        );
+    }
 }
diff --git a/src/Service/Plugin/BroadcastUpdatePlugin.php b/src/Service/Plugin/BroadcastUpdatePlugin.php
@@ -13,4 +13,16 @@ public function render(int $jsonOptions = 0): string
             json_encode($this->options, $jsonOptions)
         );
     }
+
+    /**
+     * @param array<string, string> $headersToCheck
+     */
+    public static function create(array $headersToCheck = []): static
+    {
+        $headersToCheck = $headersToCheck === [] ? ['Content-Type', 'ETag', 'Last-Modified'] : $headersToCheck;
+
+        return new self('BroadcastUpdatePlugin', [
+            'headersToCheck' => $headersToCheck,
+        ]);
+    }
 }
diff --git a/src/Service/Plugin/CachePlugin.php b/src/Service/Plugin/CachePlugin.php
@@ -16,62 +16,4 @@ public function __construct(
     }
 
     abstract public function render(int $jsonOptions = 0): string;
-
-    public static function createExpirationPlugin(null|int $maxEntries, null|string|int $maxAgeSeconds): static
-    {
-        return new ExpirationPlugin(
-            'ExpirationPlugin',
-            [
-                'maxEntries' => $maxEntries,
-                'maxAgeSeconds' => $maxAgeSeconds,
-            ]
-        );
-    }
-
-    public static function createBroadcastUpdatePlugin(array $headersToCheck = []): static
-    {
-        $headersToCheck = $headersToCheck === [] ? ['Content-Type', 'ETag', 'Last-Modified'] : $headersToCheck;
-
-        return new BroadcastUpdatePlugin(
-            'BroadcastUpdatePlugin',
-            [
-                'headersToCheck' => $headersToCheck,
-            ]
-        );
-    }
-
-    public static function createCacheableResponsePlugin(array $statuses = [0, 200], array $headers = []): static
-    {
-        $options = array_filter([
-            'statuses' => $statuses,
-            'headers' => $headers,
-        ], fn ($value) => $value !== []);
-        $options = $options === [] ? [
-            'statuses' => [0, 200],
-        ] : $options;
-
-        return new CacheableResponsePlugin('CacheableResponsePlugin', $options);
-    }
-
-    public static function createRangeRequestsPlugin(): static
-    {
-        return new RangeRequestsPlugin('RangeRequestsPlugin');
-    }
-
-    public static function createBackgroundSyncPlugin(
-        string $queueName,
-        int $maxRetentionTime,
-        bool $forceSyncFallback,
-        ?string $broadcastChannel
-    ): static {
-        return new BackgroundSyncPlugin(
-            'BackgroundSyncPlugin',
-            [
-                'queueName' => $queueName,
-                'maxRetentionTime' => $maxRetentionTime,
-                'forceSyncFallback' => $forceSyncFallback,
-                'broadcastChannel' => $broadcastChannel,
-            ]
-        );
-    }
 }
diff --git a/src/Service/Plugin/CacheableResponsePlugin.php b/src/Service/Plugin/CacheableResponsePlugin.php
@@ -13,4 +13,21 @@ public function render(int $jsonOptions = 0): string
             json_encode($this->options, $jsonOptions)
         );
     }
+
+    /**
+     * @param array<int> $statuses
+     * @param array<string, string> $headers
+     */
+    public static function create(array $statuses = [0, 200], array $headers = []): static
+    {
+        $options = array_filter([
+            'statuses' => $statuses,
+            'headers' => $headers,
+        ], fn ($value) => $value !== []);
+        $options = $options === [] ? [
+            'statuses' => [0, 200],
+        ] : $options;
+
+        return new self('CacheableResponsePlugin', $options);
+    }
 }
diff --git a/src/Service/Plugin/ExpirationPlugin.php b/src/Service/Plugin/ExpirationPlugin.php
@@ -10,4 +10,12 @@ public function render(int $jsonOptions = 0): string
     {
         return sprintf('new workbox.expiration.ExpirationPlugin(%s)', json_encode($this->options, $jsonOptions));
     }
+
+    public static function create(null|int $maxEntries, null|string|int $maxAgeSeconds): static
+    {
+        return new self('ExpirationPlugin', [
+            'maxEntries' => $maxEntries,
+            'maxAgeSeconds' => $maxAgeSeconds,
+        ]);
+    }
 }
diff --git a/src/Service/Plugin/RangeRequestsPlugin.php b/src/Service/Plugin/RangeRequestsPlugin.php
@@ -10,4 +10,9 @@ public function render(int $jsonOptions = 0): string
     {
         return 'new workbox.rangeRequests.RangeRequestsPlugin()';
     }
+
+    public static function create(): static
+    {
+        return new self('RangeRequestsPlugin');
+    }
 }
diff --git a/src/Service/Rule/AssetCache.php b/src/Service/Rule/AssetCache.php
@@ -8,7 +8,7 @@
 use SpomkyLabs\PwaBundle\Dto\Workbox;
 use SpomkyLabs\PwaBundle\Service\CacheStrategy;
 use SpomkyLabs\PwaBundle\Service\HasCacheStrategies;
-use SpomkyLabs\PwaBundle\Service\Plugin\CachePlugin;
+use SpomkyLabs\PwaBundle\Service\Plugin\ExpirationPlugin;
 use SpomkyLabs\PwaBundle\Service\WorkboxCacheStrategy;
 use Symfony\Component\AssetMapper\AssetMapperInterface;
 use Symfony\Component\AssetMapper\Path\PublicAssetsPathResolverInterface;
@@ -61,7 +61,7 @@ public function getCacheStrategies(): array
                 true,
                 null,
                 [
-                    CachePlugin::createExpirationPlugin(
+                    ExpirationPlugin::create(
                         count($this->getAssets()) * 2,
                         $this->workbox->assetCache->maxAgeInSeconds() ?? 60 * 60 * 24 * 365,
                     ),

diff --git a/src/Service/Rule/BackgroundSync.php b/src/Service/Rule/BackgroundSync.php
@@ -8,21 +8,22 @@
 use SpomkyLabs\PwaBundle\Dto\Workbox;
 use SpomkyLabs\PwaBundle\Service\CacheStrategy;
 use SpomkyLabs\PwaBundle\Service\HasCacheStrategies;
-use SpomkyLabs\PwaBundle\Service\Plugin\CachePlugin;
+use SpomkyLabs\PwaBundle\Service\MatchCallbackHandler\MatchCallbackHandler;
+use SpomkyLabs\PwaBundle\Service\Plugin\BackgroundSyncPlugin;
 use SpomkyLabs\PwaBundle\Service\WorkboxCacheStrategy;
-use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
 
 final readonly class BackgroundSync implements HasCacheStrategies
 {
     private Workbox $workbox;
 
+    /**
+     * @param iterable<MatchCallbackHandler> $matchCallbackHandlers
+     */
     public function __construct(
         ServiceWorker $serviceWorker,
         #[TaggedIterator('spomky_labs_pwa.match_callback_handler')]
         private iterable $matchCallbackHandlers,
-        #[Autowire('%kernel.debug%')]
-        bool $debug,
     ) {
         $this->workbox = $serviceWorker->workbox;
     }
@@ -42,7 +43,7 @@ public function getCacheStrategies(): array
                 true,
                 null,
                 [
-                    CachePlugin::createBackgroundSyncPlugin(
+                    BackgroundSyncPlugin::create(
                         $sync->queueName,
                         $sync->maxRetentionTime,
                         $sync->forceSyncFallback,