Better Cache Strategy Support

Spomky-Labs · Mar 17, 2024 · 504c818 · 504c818
1 parent 4e58ffb
commit 504c818
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 52 deletions.
diff --git a/src/CachingStrategy/ManifestCache.php b/src/CachingStrategy/ManifestCache.php
@@ -7,7 +7,6 @@
 use SpomkyLabs\PwaBundle\Dto\ServiceWorker;
 use SpomkyLabs\PwaBundle\Dto\Workbox;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
-use const PHP_EOL;
 
 final readonly class ManifestCache implements HasCacheStrategies
 {
@@ -24,27 +23,6 @@ public function __construct(
         $this->manifestPublicUrl = '/' . trim($manifestPublicUrl, '/');
     }
 
-    public function process(string $body): string
-    {
-        if ($this->workbox->enabled === false) {
-            return $body;
-        }
-        if ($this->workbox->cacheManifest === false) {
-            return $body;
-        }
-
-        $declaration = <<<IMAGE_CACHE_RULE_STRATEGY
-workbox.routing.registerRoute(
-  ({url}) => '{$this->manifestPublicUrl}' === url.pathname,
-  new workbox.strategies.StaleWhileRevalidate({
-    cacheName: 'manifest'
-  })
-);
-IMAGE_CACHE_RULE_STRATEGY;
-
-        return $body . PHP_EOL . PHP_EOL . trim($declaration);
-    }
-
     public function getCacheStrategies(): array
     {
         return [

diff --git a/src/Resources/config/services.php b/src/Resources/config/services.php
@@ -110,18 +110,18 @@
     ;
 
     /*** Service Worker Compiler Rules ***/
-    $container->load('SpomkyLabs\\PwaBundle\\ServiceWorkerRule\\', '../../ServiceWorkerRule/*');
     $container->instanceof(ServiceWorkerRule::class)
         ->tag('spomky_labs_pwa.service_worker_rule')
     ;
+    $container->load('SpomkyLabs\\PwaBundle\\ServiceWorkerRule\\', '../../ServiceWorkerRule/*');
 
-    $container->load('SpomkyLabs\\PwaBundle\\CachingStrategy\\', '../../CachingStrategy/*');
     $container->instanceof(HasCacheStrategies::class)
         ->tag('spomky_labs_pwa.cache_strategy')
     ;
+    $container->load('SpomkyLabs\\PwaBundle\\CachingStrategy\\', '../../CachingStrategy/*');
 
-    $container->load('SpomkyLabs\\PwaBundle\\MatchCallbackHandler\\', '../../MatchCallbackHandler/*');
     $container->instanceof(MatchCallbackHandler::class)
         ->tag('spomky_labs_pwa.match_callback_handler')
     ;
+    $container->load('SpomkyLabs\\PwaBundle\\MatchCallbackHandler\\', '../../MatchCallbackHandler/*');
 };
diff --git a/src/Service/ServiceWorkerCompiler.php b/src/Service/ServiceWorkerCompiler.php
@@ -33,8 +33,9 @@ public function compile(): ?string
             return null;
         }
         $body = '';
+
         foreach ($this->serviceworkerRules as $rule) {
-            $body = $rule->process($body);
+            $body .= $rule->process();
         }
 
         return $body . $this->includeRootSW();

diff --git a/src/ServiceWorkerRule/AppendCacheStrategies.php b/src/ServiceWorkerRule/AppendCacheStrategies.php
@@ -33,15 +33,16 @@ public function __construct(
         $this->jsonOptions = $options;
     }
 
-    public function process(string $body): string
+    public function process(): string
     {
+        $body = '';
         foreach ($this->cacheStrategies as $idCacheStrategy => $cacheStrategy) {
             foreach ($cacheStrategy->getCacheStrategies() as $idStrategy => $strategy) {
                 if ($strategy->enabled === false) {
                     continue;
                 }
 
-                $body .= PHP_EOL . PHP_EOL . trim($strategy->render(
+                $body .= PHP_EOL . trim($strategy->render(
                     sprintf('cache_%d_%d', $idCacheStrategy, $idStrategy),
                     $this->jsonOptions
                 ));

diff --git a/src/ServiceWorkerRule/ClearCache.php b/src/ServiceWorkerRule/ClearCache.php
@@ -6,7 +6,6 @@
 
 use SpomkyLabs\PwaBundle\Dto\ServiceWorker;
 use SpomkyLabs\PwaBundle\Dto\Workbox;
-use const PHP_EOL;
 
 final readonly class ClearCache implements ServiceWorkerRule
 {
@@ -18,13 +17,13 @@ public function __construct(
         $this->workbox = $serviceWorker->workbox;
     }
 
-    public function process(string $body): string
+    public function process(): string
     {
         if ($this->workbox->enabled === false) {
-            return $body;
+            return '';
         }
         if ($this->workbox->clearCache === false) {
-            return $body;
+            return '';
         }
 
         $declaration = <<<CLEAR_CACHE
@@ -40,6 +39,6 @@ public function process(string $body): string
 });
 CLEAR_CACHE;
 
-        return $body . PHP_EOL . PHP_EOL . trim($declaration);
+        return trim($declaration);
     }
 }
diff --git a/src/ServiceWorkerRule/OfflineFallback.php b/src/ServiceWorkerRule/OfflineFallback.php
@@ -15,7 +15,6 @@
 use const JSON_THROW_ON_ERROR;
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
-use const PHP_EOL;
 
 final readonly class OfflineFallback implements ServiceWorkerRule
 {
@@ -44,10 +43,10 @@ public function __construct(
         $this->jsonOptions = $options;
     }
 
-    public function process(string $body): string
+    public function process(): string
     {
         if ($this->workbox->enabled === false || ! isset($this->workbox->offlineFallback)) {
-            return $body;
+            return '';
         }
         $options = [
             'pageFallback' => $this->workbox->offlineFallback->pageFallback,
@@ -56,7 +55,7 @@ public function process(string $body): string
         ];
         $options = array_filter($options, static fn (mixed $v): bool => $v !== null);
         if (count($options) === 0) {
-            return $body;
+            return '';
         }
         $options = count($options) === 0 ? '' : $this->serializer->serialize($options, 'json', $this->jsonOptions);
 
@@ -65,6 +64,6 @@ public function process(string $body): string
 workbox.recipes.offlineFallback({$options});
 OFFLINE_FALLBACK_STRATEGY;
 
-        return $body . PHP_EOL . PHP_EOL . trim($declaration);
+        return trim($declaration);
     }
 }
diff --git a/src/ServiceWorkerRule/ServiceWorkerRule.php b/src/ServiceWorkerRule/ServiceWorkerRule.php
@@ -6,5 +6,5 @@
 
 interface ServiceWorkerRule
 {
-    public function process(string $body): string;
+    public function process(): string;
 }
diff --git a/src/ServiceWorkerRule/SkipWaiting.php b/src/ServiceWorkerRule/SkipWaiting.php
@@ -5,7 +5,6 @@
 namespace SpomkyLabs\PwaBundle\ServiceWorkerRule;
 
 use SpomkyLabs\PwaBundle\Dto\ServiceWorker;
-use const PHP_EOL;
 
 final readonly class SkipWaiting implements ServiceWorkerRule
 {
@@ -14,10 +13,10 @@ public function __construct(
     ) {
     }
 
-    public function process(string $body): string
+    public function process(): string
     {
         if ($this->serviceWorker->skipWaiting === false) {
-            return $body;
+            return '';
         }
 
         $declaration = <<<SKIP_WAITING
@@ -29,6 +28,6 @@ public function process(string $body): string
 });
 SKIP_WAITING;
 
-        return $body . PHP_EOL . PHP_EOL . trim($declaration);
+        return trim($declaration);
     }
 }
diff --git a/src/ServiceWorkerRule/WindowsWidgets.php b/src/ServiceWorkerRule/WindowsWidgets.php
@@ -11,7 +11,6 @@
 use const JSON_THROW_ON_ERROR;
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
-use const PHP_EOL;
 
 final readonly class WindowsWidgets implements ServiceWorkerRule
 {
@@ -21,7 +20,7 @@ public function __construct(
     ) {
     }
 
-    public function process(string $body): string
+    public function process(): string
     {
         $tags = [];
         foreach ($this->manifest->widgets as $widget) {
@@ -30,7 +29,7 @@ public function process(string $body): string
             }
         }
         if (count($tags) === 0) {
-            return $body;
+            return '';
         }
         $data = $this->serializer->serialize($tags, 'json', [
             JsonEncode::OPTIONS => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_THROW_ON_ERROR,
@@ -96,6 +95,6 @@ public function process(string $body): string
 }
 OFFLINE_FALLBACK_STRATEGY;
 
-        return $body . PHP_EOL . PHP_EOL . trim($declaration);
+        return trim($declaration);
     }
 }
diff --git a/src/ServiceWorkerRule/WorkboxImport.php b/src/ServiceWorkerRule/WorkboxImport.php
@@ -6,7 +6,6 @@
 
 use SpomkyLabs\PwaBundle\Dto\ServiceWorker;
 use SpomkyLabs\PwaBundle\Dto\Workbox;
-use const PHP_EOL;
 
 final readonly class WorkboxImport implements ServiceWorkerRule
 {
@@ -18,10 +17,10 @@ public function __construct(
         $this->workbox = $serviceWorker->workbox;
     }
 
-    public function process(string $body): string
+    public function process(): string
     {
         if ($this->workbox->enabled === false) {
-            return $body;
+            return '';
         }
         if ($this->workbox->useCDN === true) {
             $declaration = <<<IMPORT_CDN_STRATEGY
@@ -35,10 +34,10 @@ public function process(string $body): string
 IMPORT_CDN_STRATEGY;
         }
 
-        return trim($declaration) . PHP_EOL . PHP_EOL . $body;
+        return trim($declaration);
     }
 
-    public static function getDefaultPriority(): int
+    public static function getPriority(): int
     {
         return 1024;
     }