Call bind() to get the right this in precaching's plugins (#1928)

* Call bind() to get the right this * Added a unit test, too. * Use thisValues
GoogleChrome · Feb 28, 2019 · b6b1506 · b6b1506
1 parent d76e770
commit b6b1506
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 3 deletions.
diff --git a/packages/workbox-precaching/PrecacheController.mjs b/packages/workbox-precaching/PrecacheController.mjs
@@ -177,7 +177,7 @@ class PrecacheController {
     let cacheWillUpdateCallback;
     for (const plugin of (plugins || [])) {
       if ('cacheWillUpdate' in plugin) {
-        cacheWillUpdateCallback = plugin.cacheWillUpdate;
+        cacheWillUpdateCallback = plugin.cacheWillUpdate.bind(plugin);
       }
     }
 

diff --git a/test/workbox-precaching/node/test-PrecacheController.mjs b/test/workbox-precaching/node/test-PrecacheController.mjs
@@ -441,6 +441,28 @@ describe(`[workbox-precaching] PrecacheController`, function() {
       expect(cacheWrapper.put.args[1][0].plugins).to.equal(testPlugins);
     });
 
+    it(`it should use the proper 'this' when calling a cacheWillUpdate plugin`, async function() {
+      const precacheController = new PrecacheController();
+      const cacheList = [
+        '/index.1234.html',
+      ];
+      precacheController.addToCacheList(cacheList);
+
+      class TestPlugin {
+        cacheWillUpdate({response}) {
+          return response;
+        }
+      }
+      const pluginInstance = new TestPlugin();
+      const cacheWillUpdateSpy = sandbox.spy(pluginInstance, 'cacheWillUpdate');
+
+      await precacheController.install({
+        plugins: [pluginInstance],
+      });
+
+      expect(cacheWillUpdateSpy.thisValues[0]).to.be.an.instanceof(TestPlugin);
+    });
+
     it(`it should set credentials: 'same-origin' on the precaching requests`, async function() {
       sandbox.spy(fetchWrapper, 'fetch');
 

diff --git a/test/workbox-precaching/static/precache-and-update/sw-1.js b/test/workbox-precaching/static/precache-and-update/sw-1.js
@@ -6,10 +6,17 @@
   https://opensource.org/licenses/MIT.
 */
 
-importScripts('/__WORKBOX/buildFile/workbox-core');
-importScripts('/__WORKBOX/buildFile/workbox-precaching');
+importScripts('/__WORKBOX/buildFile/workbox-sw');
 importScripts('/infra/testing/comlink/sw-interface.js');
 
+workbox.setConfig({modulePathPrefix: '/__WORKBOX/buildFile/'});
+
+workbox.precaching.addPlugins([
+  new workbox.cacheableResponse.Plugin({
+    statuses: [200],
+  }),
+]);
+
 workbox.precaching.precache([
   {
     url: 'styles/index.css',