async manifestTransforms (#2195)

Author: jeffposnick

packages/workbox-build/src/lib/get-file-manifest-entries.js

@@ -108,7 +108,7 @@ module.exports = async ({
     }
   }
 
-  const transformedManifest = transformManifest({
+  const transformedManifest = await transformManifest({
     additionalManifestEntries,
     dontCacheBustURLsMatching,
     fileDetails,

packages/workbox-build/src/lib/transform-manifest.js

@@ -28,7 +28,7 @@ const noRevisionForURLsMatchingTransform =
  * @example <caption>A transformation that prepended the origin of a CDN for any
  * URL starting with '/assets/' could be implemented as:</caption>
  *
- * const cdnTransform = (manifestEntries) => {
+ * const cdnTransform = async (manifestEntries) => {
  *   const manifest = manifestEntries.map(entry => {
  *     const cdnOrigin = 'https://example.com';
  *     if (entry.url.startsWith('/assets/')) {
@@ -43,7 +43,7 @@ const noRevisionForURLsMatchingTransform =
  * URL contains an 8-character hash surrounded by '.', indicating that it
  * already contains revision information:</caption>
  *
- * const removeRevisionTransform = (manifestEntries) => {
+ * const removeRevisionTransform = async (manifestEntries) => {
  *   const manifest = manifestEntries.map(entry => {
  *     const hashRegExp = /\.\w{8}\./;
  *     if (entry.url.match(hashRegExp)) {
@@ -59,14 +59,14 @@ const noRevisionForURLsMatchingTransform =
  * array of entries, prior to the current transformation.
  * @param {Object} [compilation] When used in the webpack plugins, this param
  * will be set to the current `compilation`.
- * @return {module:workbox-build.ManifestTransformResult}
+ * @return {Promise<module:workbox-build.ManifestTransformResult>}
  * The array of entries with the transformation applied, and optionally, any
  * warnings that should be reported back to the build tool.
  *
  * @memberof module:workbox-build
  */
 
-module.exports = ({
+module.exports = async ({
   additionalManifestEntries,
   dontCacheBustURLsMatching,
   fileDetails,
@@ -115,7 +115,7 @@ module.exports = ({
 
   let transformedManifest = normalizedManifest;
   for (const transform of transformsToApply) {
-    const result = transform(transformedManifest, transformParam);
+    const result = await transform(transformedManifest, transformParam);
     if (!('manifest' in result)) {
       throw new Error(errors['bad-manifest-transforms-return-value']);
     }

packages/workbox-webpack-plugin/src/generate-sw.js

@@ -108,7 +108,7 @@ class GenerateSW {
           .concat(scripts);
     }
 
-    config.manifestEntries = getManifestEntriesFromCompilation(
+    config.manifestEntries = await getManifestEntriesFromCompilation(
         compilation, config);
 
     const unbundledCode = populateSWTemplate(config);

packages/workbox-webpack-plugin/src/inject-manifest.js

@@ -152,7 +152,7 @@ class InjectManifest {
     const swAsset = compilation.assets[config.swDest];
     delete compilation.assets[config.swDest];
 
-    const manifestEntries = getManifestEntriesFromCompilation(
+    const manifestEntries = await getManifestEntriesFromCompilation(
         compilation, config);
 
     const manifestDeclaration = stringifyManifest(manifestEntries,

packages/workbox-webpack-plugin/src/lib/get-manifest-entries-from-compilation.js

@@ -150,7 +150,7 @@ function filterAssets(compilation, config) {
   return filteredAssets;
 }
 
-module.exports = (compilation, config) => {
+module.exports = async (compilation, config) => {
   const filteredAssets = filterAssets(compilation, config);
 
   const {publicPath} = compilation.options.output;
@@ -177,7 +177,7 @@ module.exports = (compilation, config) => {
   // We also get back `size` and `count`, and it would be nice to log that
   // somewhere, but... webpack doesn't offer info-level logs?
   // https://github.com/webpack/webpack/issues/3996
-  const {manifestEntries, warnings} = transformManifest({
+  const {manifestEntries, warnings} = await transformManifest({
     fileDetails,
     additionalManifestEntries: config.additionalManifestEntries,
     dontCacheBustURLsMatching: config.dontCacheBustURLsMatching,

test/workbox-build/node/lib/transform-manifest.js

@@ -30,7 +30,7 @@ describe(`[workbox-build] lib/transform-manifest.js`, function() {
   const FILE_DETAILS = [ENTRY1, ENTRY2, ENTRY3];
 
   it(`should filter out files above maximumFileSizeToCacheInBytes`, async function() {
-    const {size, count, manifestEntries} = transformManifest({
+    const {size, count, manifestEntries} = await transformManifest({
       maximumFileSizeToCacheInBytes: MAXIMUM_FILE_SIZE,
       fileDetails: FILE_DETAILS,
     });
@@ -47,7 +47,7 @@ describe(`[workbox-build] lib/transform-manifest.js`, function() {
   });
 
   it(`should remove revision info based on dontCacheBustURLsMatching`, async function() {
-    const {size, count, manifestEntries} = transformManifest({
+    const {size, count, manifestEntries} = await transformManifest({
       dontCacheBustURLsMatching: new RegExp(ENTRY1.file),
       fileDetails: FILE_DETAILS,
     });
@@ -68,7 +68,7 @@ describe(`[workbox-build] lib/transform-manifest.js`, function() {
   it(`should modify the URLs based on modifyURLPrefix`, async function() {
     const prefix = 'prefix/';
 
-    const {size, count, manifestEntries} = transformManifest({
+    const {size, count, manifestEntries} = await transformManifest({
       modifyURLPrefix: {
         '': prefix,
       },
@@ -89,7 +89,7 @@ describe(`[workbox-build] lib/transform-manifest.js`, function() {
     }]);
   });
 
-  it(`should use custom manifestTransforms`, function() {
+  it(`should use custom manifestTransforms`, async function() {
     const prefix1 = 'prefix1/';
     const prefix2 = 'prefix2/';
 
@@ -118,7 +118,7 @@ describe(`[workbox-build] lib/transform-manifest.js`, function() {
       return {manifest, warnings: [warning2]};
     };
 
-    const {size, count, manifestEntries, warnings} = transformManifest({
+    const {size, count, manifestEntries, warnings} = await transformManifest({
       fileDetails: FILE_DETAILS,
       manifestTransforms: [transform1, transform2],
       transformParam,
@@ -138,4 +138,30 @@ describe(`[workbox-build] lib/transform-manifest.js`, function() {
       revision: ENTRY3.hash,
     }]);
   });
+
+  it(`should support an async manifestTransform`, async function() {
+    const asyncTransform = async (manifest) => {
+      await Promise.resolve();
+      return {manifest, warnings: []};
+    };
+
+    const {size, count, manifestEntries, warnings} = await transformManifest({
+      fileDetails: FILE_DETAILS,
+      manifestTransforms: [asyncTransform],
+    });
+
+    expect(warnings).to.be.empty;
+    expect(size).to.eql(ENTRY1.size + ENTRY2.size + ENTRY3.size);
+    expect(count).to.eql(3);
+    expect(manifestEntries).to.deep.equal([{
+      url: ENTRY1.file,
+      revision: ENTRY1.hash,
+    }, {
+      url: ENTRY2.file,
+      revision: ENTRY2.hash,
+    }, {
+      url: ENTRY3.file,
+      revision: ENTRY3.hash,
+    }]);
+  });
 });