Add background fetch functionality.

assets/package.json

@@ -12,6 +12,13 @@
                 "fetch": "eager",
                 "enabled": true
             },
+            "backgroundfetch": {
+                "main": "src/backgroundfetch_controller.js",
+                "name": "pwa/backgroundfetch",
+                "webpackMode": "eager",
+                "fetch": "eager",
+                "enabled": true
+            },
             "backgroundsync-form": {
                 "main": "src/backgroundsync-form_controller.js",
                 "name": "pwa/backgroundsync-form",

assets/src/backgroundfetch_controller.js

@@ -0,0 +1,61 @@
+'use strict';
+
+import { Controller } from '@hotwired/stimulus';
+
+/* stimulusFetch: 'lazy' */
+export default class extends Controller {
+    download = async ({params}) => {
+        const { id, requests, title, icons, downloadTotal } = params;
+        if (!requests) {
+            return;
+        }
+        const processId = id || self.crypto.randomUUID();
+        await this.fetch(processId, requests, {
+            title,
+            icons,
+            downloadTotal
+        });
+    }
+
+    fetch = async (id, requests, options) => {
+        try {
+            const registration = await navigator.serviceWorker.ready;
+            const bgFetch = await registration.backgroundFetch.fetch(id, requests, options);
+            bgFetch.addEventListener('progress', () => this.dispatchStatus(bgFetch));
+
+        } catch (error) {
+            this.dispatchEvent('error', { error });
+        }
+    }
+
+    status = async () => {
+        const registration = await navigator.serviceWorker.ready;
+        const ids = await registration.backgroundFetch.getIds();
+        this.dispatchEvent('ids', ids);
+        const promises = ids.map(async (id) => {
+            const bgFetch = await registration.backgroundFetch.get(id);
+            if (!bgFetch) {
+                return;
+            }
+            bgFetch.addEventListener('progress', () => this.dispatchStatus(bgFetch));
+        });
+        await Promise.all(promises);
+    }
+
+    dispatchStatus = (bgFetch) => {
+        this.dispatchEvent('status', {
+            id: bgFetch.id,
+            uploadTotal: bgFetch.uploadTotal,
+            uploaded: bgFetch.uploaded,
+            downloadTotal: bgFetch.downloadTotal,
+            downloaded: bgFetch.downloaded,
+            result: bgFetch.result,
+            failureReason: bgFetch.failureReason,
+            recordsAvailable: bgFetch.recordsAvailable,
+        });
+    }
+
+    dispatchEvent = (name, payload) => {
+        this.dispatch(name, { detail: payload });
+    }
+}

src/CachingStrategy/AssetCache.php

@@ -16,6 +16,7 @@
 use Symfony\Component\Serializer\Encoder\JsonEncode;
 use Symfony\Component\Serializer\SerializerInterface;
 use function count;
+use function sprintf;
 use const JSON_PRETTY_PRINT;
 use const JSON_THROW_ON_ERROR;
 use const JSON_UNESCAPED_SLASHES;

src/CachingStrategy/ImageCache.php

@@ -11,6 +11,7 @@
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
 use Symfony\Component\AssetMapper\Path\PublicAssetsPathResolverInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use function sprintf;
 
 final class ImageCache implements HasCacheStrategiesInterface, CanLogInterface
 {

src/CachingStrategy/ManifestCache.php

@@ -10,6 +10,7 @@
 use SpomkyLabs\PwaBundle\Dto\Workbox;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use function sprintf;
 
 final class ManifestCache implements HasCacheStrategiesInterface, CanLogInterface
 {

src/CachingStrategy/PreloadUrlsGeneratorManager.php

@@ -10,6 +10,7 @@
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
 use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
 use function array_key_exists;
+use function sprintf;
 
 final class PreloadUrlsGeneratorManager implements CanLogInterface
 {

src/CachingStrategy/ResourceCaches.php

@@ -20,6 +20,7 @@
 use Symfony\Component\Serializer\Encoder\JsonEncode;
 use Symfony\Component\Serializer\SerializerInterface;
 use function count;
+use function sprintf;
 use const JSON_PRETTY_PRINT;
 use const JSON_THROW_ON_ERROR;
 use const JSON_UNESCAPED_SLASHES;

src/CachingStrategy/WorkboxCacheStrategy.php

@@ -6,6 +6,7 @@
 
 use SpomkyLabs\PwaBundle\WorkboxPlugin\CachePluginInterface;
 use function in_array;
+use function sprintf;
 use const JSON_PRETTY_PRINT;
 use const JSON_THROW_ON_ERROR;
 use const JSON_UNESCAPED_SLASHES;

src/Command/CreateIconsCommand.php

@@ -19,6 +19,7 @@
 use Symfony\Component\Mime\MimeTypes;
 use Symfony\Component\Yaml\Yaml;
 use function is_string;
+use function sprintf;
 
 #[AsCommand(name: 'pwa:create:icons', description: 'Generate icons for your PWA')]
 final class CreateIconsCommand extends Command

src/Command/CreateScreenshotCommand.php

@@ -24,6 +24,7 @@
 use function assert;
 use function is_int;
 use function is_string;
+use function sprintf;
 
 #[AsCommand(
     name: 'pwa:create:screenshot',

src/CompilerPass/PreloadUrlCompilerPass.php

@@ -17,6 +17,7 @@
 use Throwable;
 use function array_key_exists;
 use function is_string;
+use function sprintf;
 
 /**
  * @internal

src/Dto/BackgroundFetch.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SpomkyLabs\PwaBundle\Dto;
+
+use Symfony\Component\Serializer\Attribute\SerializedName;
+
+final class BackgroundFetch
+{
+    public bool $enabled;
+
+    #[SerializedName('cache_name')]
+    public string $cacheName;
+
+    #[SerializedName('progress_url')]
+    public null|Url $progressUrl = null;
+
+    #[SerializedName('success_url')]
+    public null|Url $successUrl = null;
+
+    #[SerializedName('success_message')]
+    public null|string $successMessage = null;
+
+    #[SerializedName('failure_message')]
+    public null|string $failureMessage = null;
+}

src/Dto/ServiceWorker.php

@@ -23,4 +23,7 @@ final class ServiceWorker
     public bool $skipWaiting = false;
 
     public Workbox $workbox;
+
+    #[SerializedName('background_fetch')]
+    public null|BackgroundFetch $backgroundFetch = null;
 }

src/ImageProcessor/Configuration.php

@@ -6,6 +6,7 @@
 
 use InvalidArgumentException;
 use Stringable;
+use function sprintf;
 
 final readonly class Configuration implements Stringable
 {

src/ImageProcessor/GDImageProcessor.php

@@ -121,11 +121,10 @@ private function createMainImage(string $image, Configuration $configuration): G
         }
 
         /*if ($configuration->width === $configuration->height) {
-            $mainImage = imagescale($mainImage, $configuration->width, $configuration->height);
-            assert($mainImage !== false);
-
-            return $mainImage;
-        }*/
+         * $mainImage = imagescale($mainImage, $configuration->width, $configuration->height);
+         * assert($mainImage !== false);
+         * return $mainImage;
+         * }*/
 
         $srcWidth = imagesx($mainImage);
         $srcHeight = imagesy($mainImage);

src/MatchCallbackHandler/DestinationMatchCallbackHandler.php

@@ -7,6 +7,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
+use function sprintf;
 
 final class DestinationMatchCallbackHandler implements MatchCallbackHandlerInterface, CanLogInterface
 {

src/MatchCallbackHandler/ExactPathnameMatchCallbackHandler.php

@@ -7,6 +7,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
+use function sprintf;
 
 final class ExactPathnameMatchCallbackHandler implements MatchCallbackHandlerInterface, CanLogInterface
 {

src/MatchCallbackHandler/OriginMatchCallbackHandler.php

@@ -7,6 +7,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
+use function sprintf;
 
 final class OriginMatchCallbackHandler implements MatchCallbackHandlerInterface, CanLogInterface
 {

src/MatchCallbackHandler/PathnameEndsWithMatchCallbackHandler.php

@@ -7,6 +7,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
+use function sprintf;
 
 final class PathnameEndsWithMatchCallbackHandler implements MatchCallbackHandlerInterface, CanLogInterface
 {

src/MatchCallbackHandler/PathnameStartsWithMatchCallbackHandler.php

@@ -7,6 +7,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
+use function sprintf;
 
 final class PathnameStartsWithMatchCallbackHandler implements MatchCallbackHandlerInterface, CanLogInterface
 {

src/MatchCallbackHandler/RouteMatchCallbackHandler.php

@@ -8,6 +8,7 @@
 use Psr\Log\NullLogger;
 use SpomkyLabs\PwaBundle\Service\CanLogInterface;
 use Symfony\Component\Routing\RouterInterface;
+use function sprintf;
 
 final class RouteMatchCallbackHandler implements MatchCallbackHandlerInterface, CanLogInterface
 {

src/Normalizer/ScreenshotNormalizer.php

@@ -13,6 +13,7 @@
 use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use function assert;
+use function sprintf;
 
 final class ScreenshotNormalizer implements NormalizerInterface, NormalizerAwareInterface
 {

src/Resources/config/definition/service_worker.php

@@ -42,6 +42,28 @@
                     ->defaultTrue()
                     ->info('Whether the service worker should use the cache.')
                 ->end()
+                ->arrayNode('background_fetch')
+                    ->canBeEnabled()
+                    ->children()
+                        ->scalarNode('cache_name')
+                            ->isRequired()
+                            ->info('The name of the cache where files should be saved.')
+                            ->example(['downloads'])
+                        ->end()
+                        ->append(getUrlNode('progress_url', 'The URL of the progress page.'))
+                        ->append(getUrlNode('success_url', 'The URL of the success page.'))
+                        ->scalarNode('success_message')
+                            ->info('The message to display on success. This message can be translated.')
+                            ->defaultNull()
+                            ->example(['The download is complete.'])
+                        ->end()
+                        ->scalarNode('failure_message')
+                            ->info('The message to display on success. This message can be translated.')
+                            ->defaultNull()
+                            ->example(['The download is complete.'])
+                        ->end()
+                    ->end()
+                ->end()
                 ->arrayNode('workbox')
                     ->info('The configuration of the workbox.')
                     ->canBeDisabled()

src/Service/FaviconsCompiler.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
 use function assert;
+use function sprintf;
 use const PHP_EOL;
 
 final class FaviconsCompiler implements FileCompilerInterface, CanLogInterface

src/Service/IconResolver.php

@@ -17,6 +17,7 @@
 use function assert;
 use function count;
 use function is_array;
+use function sprintf;
 
 final readonly class IconResolver
 {

src/Service/ServiceWorkerCompiler.php

@@ -17,6 +17,7 @@
 use function in_array;
 use function is_array;
 use function is_string;
+use function sprintf;
 
 final class ServiceWorkerCompiler implements FileCompilerInterface, CanLogInterface
 {

src/ServiceWorkerRule/AppendCacheStrategies.php

@@ -7,6 +7,7 @@
 use SpomkyLabs\PwaBundle\CachingStrategy\HasCacheStrategiesInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
+use function sprintf;
 use const PHP_EOL;
 
 final readonly class AppendCacheStrategies implements ServiceWorkerRuleInterface