rangeRequests option in runtimeCaching (#2871)

* rangeRequests runtime caching option * Spaces for a better JSON diff
GoogleChrome · Jul 7, 2021 · 9f36ebe · 9f36ebe
1 parent 0b5d9d8
commit 9f36ebe
Show file tree

Hide file tree

Showing 10 changed files with 4,086 additions and 6 deletions.
diff --git a/gulp-tasks/build-node-packages.js b/gulp-tasks/build-node-packages.js
@@ -72,7 +72,7 @@ async function generateWorkboxBuildJSONSchema(packagePath) {
       schema.definitions.RouteMatchCallback.typeof = 'function';
     }
     await fse.writeJSON(upath.join(packagePath, 'src', 'schema',
-        `${optionType}.json`), schema);
+        `${optionType}.json`), schema, {spaces: 2});
   }
 }
 

diff --git a/packages/workbox-build/src/_types.js b/packages/workbox-build/src/_types.js
@@ -99,6 +99,10 @@ import './_version.mjs';
  * property to use when creating the
  * [`PrecacheFallbackPlugin`]{@link module:workbox-precaching.PrecacheFallbackPlugin}.
  *
+ * @property {boolean} [options.rangeRequests] Set to `true` to add the
+ * [`RangeRequestsPlugin`]{@link module:workbox-range-requests.RangeRequestsPlugin}
+ * for the strategy being configured.
+ *
  * @property {Object} [options.matchOptions] The `matchOptions` property value
  * to use when constructing one of the
  * [Workbox strategy classes]{@link module:workbox-strategies}.

diff --git a/packages/workbox-build/src/lib/runtime-caching-converter.ts b/packages/workbox-build/src/lib/runtime-caching-converter.ts
@@ -101,6 +101,15 @@ function getOptionsString(moduleRegistry: ModuleRegistry, options: RuntimeCachin
         break;
       }
 
+      case 'rangeRequests': {
+        const plugin = moduleRegistry.use(
+            'workbox-range-requests', 'RangeRequestsPlugin');
+
+        // There are no configuration options for the constructor.
+        plugins.push(`new ${plugin}()`);
+        break;
+      }
+
       default: {
         throw new Error(errors['bad-runtime-caching-config'] + optionName);
       }

diff --git a/packages/workbox-build/src/schema/GenerateSWOptions.json b/packages/workbox-build/src/schema/GenerateSWOptions.json
diff --git a/packages/workbox-build/src/schema/GetManifestOptions.json b/packages/workbox-build/src/schema/GetManifestOptions.json
diff --git a/packages/workbox-build/src/schema/InjectManifestOptions.json b/packages/workbox-build/src/schema/InjectManifestOptions.json
diff --git a/packages/workbox-build/src/schema/WebpackGenerateSWOptions.json b/packages/workbox-build/src/schema/WebpackGenerateSWOptions.json
diff --git a/packages/workbox-build/src/schema/WebpackInjectManifestOptions.json b/packages/workbox-build/src/schema/WebpackInjectManifestOptions.json
diff --git a/packages/workbox-build/src/types.ts b/packages/workbox-build/src/types.ts
@@ -39,6 +39,7 @@ export interface RuntimeCaching {
     precacheFallback?: {
       fallbackURL: string;
     };
+    rangeRequests?: boolean;
     fetchOptions?: RequestInit;
     matchOptions?: CacheQueryOptions;
   };

diff --git a/test/workbox-build/node/lib/runtime-caching-converter.js b/test/workbox-build/node/lib/runtime-caching-converter.js
@@ -32,6 +32,7 @@ function validate(runtimeCachingOptions, convertedOptions) {
     workbox_background_sync_BackgroundSyncPlugin: sinon.spy(),
     workbox_broadcast_update_BroadcastUpdatePlugin: sinon.spy(),
     workbox_precaching_PrecacheFallbackPlugin: sinon.spy(),
+    workbox_range_requests_RangeRequestsPlugin: sinon.spy(),
     workbox_routing_registerRoute: sinon.spy(),
     workbox_strategies_CacheFirst: sinon.spy(),
     workbox_strategies_CacheOnly: sinon.spy(),
@@ -102,6 +103,10 @@ function validate(runtimeCachingOptions, convertedOptions) {
         expect(globalScope.workbox_precaching_PrecacheFallbackPlugin.calledWith(options.precacheFallback)).to.be.true;
       }
 
+      if (options.rangeRequests) {
+        expect(globalScope.workbox_range_requests_RangeRequestsPlugin.calledWith()).to.be.true;
+      }
+
       if (options.backgroundSync) {
         if ('options' in options.backgroundSync) {
           expect(
@@ -190,6 +195,7 @@ describe(`[workbox-build] src/lib/utils/runtime-caching-converter.js`, function(
         precacheFallback: {
           fallbackURL: '/test1',
         },
+        rangeRequests: false,
         fetchOptions: {
           headers: {
             'Custom': 'Header',
@@ -218,6 +224,7 @@ describe(`[workbox-build] src/lib/utils/runtime-caching-converter.js`, function(
             maxRetentionTime: 123,
           },
         },
+        rangeRequests: true,
         precacheFallback: {
           fallbackURL: '/test2',
         },