messageSkipWaiting() method for workbox-window

infra/testing/server/templates/sw-skip-waiting-on-mesage.js.njk → infra/testing/server/templates/sw-skip-waiting-on-message.js.njk

@@ -8,7 +8,7 @@
 
 // {{ version }}
 
-addEventListener('message', async (event) => {
+addEventListener('message', (event) => {
   if (event.data.type === 'SKIP_WAITING') {
     skipWaiting();
   }

packages/workbox-window/src/Workbox.ts

@@ -27,6 +27,10 @@ const WAITING_TIMEOUT_DURATION = 200;
 // that the registration didn't trigger an update.
 const REGISTRATION_TIMEOUT_DURATION = 60000;
 
+// The de facto standard message that a service worker should be listening for
+// to trigger a call to skipWaiting().
+const SKIP_WAITING_MESSAGE = {type: 'SKIP_WAITING'};
+
 /**
  * A class to aid in handling service worker registration, updates, and
  * reacting to service worker lifecycle events.
@@ -277,6 +281,19 @@ class Workbox extends WorkboxEventTarget {
     return messageSW(sw, data);
   }
 
+  /**
+   * Sends a `{type: 'SKIP_WAITING'}` message to the service worker that's
+   * currently in the `waiting` state associated with the current registration.
+   * 
+   * If there is no current registration or no service worker is `waiting`,
+   * calling this will have no effect.
+   */
+  messageSkipWaiting() {
+    if (this._registration && this._registration.waiting) {
+      messageSW(this._registration.waiting, SKIP_WAITING_MESSAGE);
+    }
+  }
+
   /**
    * Checks for a service worker already controlling the page and returns
    * it if its script URL matches.

test/workbox-window/window/test-Workbox.mjs

@@ -8,7 +8,6 @@
 
 import {Workbox} from '/__WORKBOX/buildFile/workbox-window';
 
-
 const isDev = () => {
   return self.process && self.process.env &&
       self.process.env.NODE_ENV !== 'production';
@@ -45,7 +44,6 @@ const uniq = (() => {
   };
 })();
 
-
 const stubAlreadyControllingSW = async (scriptURL) => {
   await navigator.serviceWorker.register(scriptURL);
   await waitUntil(() => {
@@ -518,6 +516,47 @@ describe(`[workbox-window] Workbox`, function() {
     });
   });
 
+  describe(`messageSkipWaiting`, function() {
+    it(`posts the expected message to the waiting service worker`, async function() {
+      const scriptURL = uniq('sw-skip-waiting-on-message.js.njk');
+      const wb = new Workbox(scriptURL);
+
+      const waitingSWPromise = new Promise((resolve) => {
+        wb.addEventListener('waiting', (event) => resolve(event.sw));
+      });
+
+      await wb.register();
+      const waitingSW = await waitingSWPromise;
+
+      const postMessageSpy = sandbox.spy(waitingSW, 'postMessage');
+
+      const controllingSWPromise = new Promise((resolve) => {
+        wb.addEventListener('controlling', (event) => resolve(event.sw));
+      });
+
+      wb.messageSkipWaiting();
+
+      // Confirm that the right postMessage() is sent.
+      expect(postMessageSpy.callCount).to.eql(1);
+      expect(postMessageSpy.firstCall.args[0]).to.eql({type: 'SKIP_WAITING'});
+      expect(postMessageSpy.firstCall.args[1][0]).to.be.instanceOf(MessagePort);
+
+      const controllingSW = await controllingSWPromise;
+
+      // Confirm that the service worker associated with this test takes control.
+      expect(controllingSW.scriptURL).to.eql(scriptURL);
+    });
+
+    it(`does nothing if there's no waiting service worker`, async function() {
+      const wb = new Workbox(uniq('sw-skip-waiting.js.njk'));
+      await wb.register();
+
+      // This should be a no-op.
+      // Just ensure that there's no exceptions thrown, etc.
+      wb.messageSkipWaiting();
+    });
+  });
+
   describe(`events`, function() {
     describe(`message`, function() {
       it(`fires when a postMessage is received from the SW`, async function() {
@@ -939,7 +978,7 @@ describe(`[workbox-window] Workbox`, function() {
           toFake: ['performance'],
         });
 
-        const scriptURL = uniq('sw-skip-waiting-on-mesage.js.njk');
+        const scriptURL = uniq('sw-skip-waiting-on-message.js.njk');
         const wb = new Workbox(scriptURL);
         const reg = await wb.register();