fix: cache invalidation

Author: evilebottnawi

package-lock.json

@@ -41,36 +41,36 @@
     "webpack": "^4.0.0 || ^5.0.0"
   },
   "dependencies": {
-    "cacache": "^15.0.3",
+    "cacache": "^15.0.5",
     "find-cache-dir": "^3.3.1",
-    "schema-utils": "^2.6.6",
-    "serialize-javascript": "^3.0.0",
+    "schema-utils": "^2.7.0",
+    "serialize-javascript": "^4.0.0",
     "webpack-sources": "^1.4.3"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.6",
-    "@babel/preset-env": "^7.9.6",
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
+    "@babel/cli": "^7.10.5",
+    "@babel/core": "^7.10.5",
+    "@babel/preset-env": "^7.10.4",
+    "@commitlint/cli": "^9.1.2",
+    "@commitlint/config-conventional": "^9.1.1",
     "@gfx/zopfli": "^1.0.14",
     "@webpack-contrib/defaults": "^6.3.0",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
-    "babel-jest": "^26.0.1",
+    "babel-jest": "^26.1.0",
     "cross-env": "^7.0.2",
     "del": "^5.1.0",
-    "del-cli": "^3.0.0",
-    "eslint": "^7.0.0",
+    "del-cli": "^3.0.1",
+    "eslint": "^7.4.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-import": "^2.22.0",
     "file-loader": "^6.0.0",
     "husky": "^4.2.5",
-    "jest": "^26.0.1",
-    "lint-staged": "^10.2.2",
-    "memfs": "^3.1.2",
+    "jest": "^26.1.0",
+    "lint-staged": "^10.2.11",
+    "memfs": "^3.2.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.0.5",
-    "standard-version": "^8.0.0",
+    "standard-version": "^8.0.2",
     "webpack": "^4.43.0"
   },
   "keywords": [

package.json

@@ -48,21 +48,27 @@ class CompressionPlugin {
       deleteOriginalAssets,
     };
 
-    if (typeof algorithm === 'string') {
+    this.algorithm = this.options.algorithm;
+    this.compressionOptions = this.options.compressionOptions;
+
+    if (typeof this.algorithm === 'string') {
       // eslint-disable-next-line global-require
       const zlib = require('zlib');
 
-      this.options.algorithm = zlib[this.options.algorithm];
+      this.algorithm = zlib[this.algorithm];
 
-      if (!this.options.algorithm) {
-        throw new Error('Algorithm not found in zlib');
+      if (!this.algorithm) {
+        throw new Error(
+          `Algorithm "${this.options.algorithm}" is not found in zlib`
+        );
       }
 
       const defaultCompressionOptions = { level: 9 };
 
-      this.options.compressionOptions = {
+      // TODO change this behaviour in the next major release
+      this.compressionOptions = {
         ...defaultCompressionOptions,
-        ...this.options.compressionOptions,
+        ...this.compressionOptions,
       };
     }
 
@@ -158,7 +164,7 @@ class CompressionPlugin {
 
   compress(input) {
     return new Promise((resolve, reject) => {
-      const { algorithm, compressionOptions } = this.options;
+      const { algorithm, compressionOptions } = this;
 
       algorithm(input, compressionOptions, (error, result) => {
         if (error) {
@@ -170,7 +176,7 @@ class CompressionPlugin {
     });
   }
 
-  async runTasks(assetNames) {
+  async runTasks(assetNames, getTaskForAsset, cache) {
     const scheduledTasks = [];
 
     for (const assetName of assetNames) {
@@ -185,8 +191,8 @@ class CompressionPlugin {
           taskResult = { error };
         }
 
-        if (this.cache.isEnabled() && !taskResult.error) {
-          taskResult = await this.cache.store(task, taskResult).then(
+        if (cache.isEnabled() && !taskResult.error) {
+          taskResult = await cache.store(task, taskResult).then(
             () => taskResult,
             () => taskResult
           );
@@ -199,14 +205,14 @@ class CompressionPlugin {
 
       scheduledTasks.push(
         new Promise((resolve) => {
-          const task = this.getTaskForAsset(assetName).next().value;
+          const task = getTaskForAsset(assetName).next().value;
 
           if (!task) {
             return resolve();
           }
 
-          if (this.cache.isEnabled()) {
-            return this.cache.get(task).then(
+          if (cache.isEnabled()) {
+            return cache.get(task).then(
               (taskResult) => {
                 task.callback(taskResult);
 
@@ -229,34 +235,42 @@ class CompressionPlugin {
   }
 
   apply(compiler) {
+    const matchObject = ModuleFilenameHelpers.matchObject.bind(
+      // eslint-disable-next-line no-undefined
+      undefined,
+      this.options
+    );
+
     compiler.hooks.emit.tapPromise(
       { name: 'CompressionPlugin' },
       async (compilation) => {
-        const assetNames = Object.keys(compilation.assets).filter((assetName) =>
-          ModuleFilenameHelpers.matchObject(this.options, assetName)
+        const { assets } = compilation;
+
+        const assetNames = Object.keys(assets).filter((assetName) =>
+          matchObject(assetName)
         );
 
         if (assetNames.length === 0) {
           return Promise.resolve();
         }
 
+        const getTaskForAsset = this.taskGenerator.bind(
+          this,
+          compiler,
+          compilation
+        );
         const CacheEngine = CompressionPlugin.isWebpack4()
           ? // eslint-disable-next-line global-require
             require('./Webpack4Cache').default
           : // eslint-disable-next-line global-require
             require('./Webpack5Cache').default;
-
-        this.cache = new CacheEngine(compilation, {
+        const cache = new CacheEngine(compilation, {
           cache: this.options.cache,
         });
 
-        this.getTaskForAsset = this.taskGenerator.bind(
-          this,
-          compiler,
-          compilation
-        );
+        await this.runTasks(assetNames, getTaskForAsset, cache);
 
-        return this.runTasks(assetNames);
+        return Promise.resolve();
       }
     );
   }

src/index.js

@@ -16,19 +16,19 @@ Array [
   ],
   Array [
     "async.async.735f6a02a2e820243759.js",
-    350,
+    269,
   ],
   Array [
     "async.async.735f6a02a2e820243759.js.gz",
-    205,
+    181,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js",
-    13052,
+    "main.29849e221d2dd6cc8f8e.js",
+    14182,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js.gz",
-    3195,
+    "main.29849e221d2dd6cc8f8e.js.gz",
+    3477,
   ],
 ]
 `;
@@ -45,11 +45,11 @@ Array [
   ],
   Array [
     "async.async.735f6a02a2e820243759.js",
-    350,
+    269,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js",
-    13052,
+    "main.29849e221d2dd6cc8f8e.js",
+    14182,
   ],
 ]
 `;
@@ -77,20 +77,20 @@ Array [
     393,
   ],
   Array [
-    "async.async.js.gz?ver=5f4efddfc3b0d0f33fc4",
-    205,
+    "async.async.js.gz?ver=e67b836a71a5cf62a680",
+    181,
   ],
   Array [
-    "async.async.js?ver=5f4efddfc3b0d0f33fc4",
-    350,
+    "async.async.js?ver=e67b836a71a5cf62a680",
+    269,
   ],
   Array [
-    "main.js.gz?var=5f4efddfc3b0d0f33fc4",
-    3222,
+    "main.js.gz?var=e67b836a71a5cf62a680",
+    3508,
   ],
   Array [
-    "main.js?var=5f4efddfc3b0d0f33fc4",
-    13211,
+    "main.js?var=e67b836a71a5cf62a680",
+    14341,
   ],
 ]
 `;

test/__snapshots__/CompressionPlugin.test.js.snap.webpack5

@@ -41,7 +41,7 @@ exports[`"algorithm" option matches snapshot for \`gzip\` value ({String}): erro
 
 exports[`"algorithm" option matches snapshot for \`gzip\` value ({String}): warnings 1`] = `Array []`;
 
-exports[`"algorithm" option matches snapshot for \`unknown\` value ({String}) 1`] = `"Algorithm not found in zlib"`;
+exports[`"algorithm" option matches snapshot for \`unknown\` value ({String}) 1`] = `"Algorithm \\"unknown\\" is not found in zlib"`;
 
 exports[`"algorithm" option matches snapshot for custom function ({Function}): assets 1`] = `
 Array [

test/__snapshots__/algorithm.test.js.snap.webpack4

@@ -20,19 +20,19 @@ Array [
   ],
   Array [
     "async.async.735f6a02a2e820243759.js",
-    350,
+    269,
   ],
   Array [
     "async.async.735f6a02a2e820243759.js.gz",
-    205,
+    181,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js",
-    13052,
+    "main.29849e221d2dd6cc8f8e.js",
+    14182,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js.gz",
-    3195,
+    "main.29849e221d2dd6cc8f8e.js.gz",
+    3477,
   ],
 ]
 `;
@@ -41,7 +41,7 @@ exports[`"algorithm" option matches snapshot for \`gzip\` value ({String}): erro
 
 exports[`"algorithm" option matches snapshot for \`gzip\` value ({String}): warnings 1`] = `Array []`;
 
-exports[`"algorithm" option matches snapshot for \`unknown\` value ({String}) 1`] = `"Algorithm not found in zlib"`;
+exports[`"algorithm" option matches snapshot for \`unknown\` value ({String}) 1`] = `"Algorithm \\"unknown\\" is not found in zlib"`;
 
 exports[`"algorithm" option matches snapshot for custom function ({Function}): assets 1`] = `
 Array [
@@ -63,19 +63,19 @@ Array [
   ],
   Array [
     "async.async.735f6a02a2e820243759.js",
-    350,
+    269,
   ],
   Array [
     "async.async.735f6a02a2e820243759.js.gz",
-    350,
+    269,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js",
-    13052,
+    "main.29849e221d2dd6cc8f8e.js",
+    14182,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js.gz",
-    13052,
+    "main.29849e221d2dd6cc8f8e.js.gz",
+    14182,
   ],
 ]
 `;
@@ -104,11 +104,11 @@ Array [
   ],
   Array [
     "async.async.735f6a02a2e820243759.js",
-    350,
+    269,
   ],
   Array [
-    "main.f210d52065e5e6030f3a.js",
-    13052,
+    "main.29849e221d2dd6cc8f8e.js",
+    14182,
   ],
 ]
 `;