Adding extra logic to wait for controller change on top of activate

GoogleChrome · Mar 5, 2018 · 99ae898 · 99ae898
1 parent 297b10a
commit 99ae898
Show file tree

Hide file tree

Showing 17 changed files with 49 additions and 34 deletions.
diff --git a/infra/testing/activate-sw.js → infra/testing/activate-and-control.js b/infra/testing/activate-sw.js → infra/testing/activate-and-control.js
@@ -41,6 +41,21 @@ module.exports = async (swUrl) => {
     .then((registration) => {
       return _onStateChangePromise(registration, 'activated');
     })
+    .then(() => {
+      // Ensure the page is being controlled by the SW.
+      if (navigator.serviceWorker.controller &&
+        navigator.serviceWorker.controller.scriptURL === swUrl) {
+        return;
+      } else {
+        return new Promise((resolve) => {
+          navigator.serviceWorker.addEventListener('controllerchange', () => {
+            if (navigator.serviceWorker.controller.scriptURL === swUrl) {
+              resolve();
+            }
+          });
+        });
+      }
+    })
     .then(() => cb())
     .catch((err) => cb(err));
   }, swUrl);

diff --git a/test/workbox-background-sync/integration/test-bg-sync.js b/test/workbox-background-sync/integration/test-bg-sync.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-background-sync] Load and use Background Sync`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -27,7 +27,7 @@ describe(`[workbox-background-sync] Load and use Background Sync`, function() {
   it(`should load a page with service worker`, async function() {
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     const err = await global.__workbox.webdriver.executeAsyncScript((testingUrl, cb) => {
       return fetch(`${testingUrl}example.txt`)

diff --git a/test/workbox-broadcast-cache-update/integration/broadcast-cache-update-plugin.js b/test/workbox-broadcast-cache-update/integration/broadcast-cache-update-plugin.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`broadcastCacheUpdate.Plugin`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -10,7 +10,7 @@ describe(`broadcastCacheUpdate.Plugin`, function() {
 
   it(`should broadcast a message on the expected channel when there's a cache update`, async function() {
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     const supported = await global.__workbox.webdriver.executeScript(() => {
       return 'BroadcastChannel' in window;

diff --git a/test/workbox-cache-expiration/integration/expiration-plugin.js b/test/workbox-cache-expiration/integration/expiration-plugin.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 const cleanSWEnv = require('../../../infra/testing/clean-sw');
 
 describe(`expiration.Plugin`, function() {
@@ -30,7 +30,7 @@ describe(`expiration.Plugin`, function() {
     const swUrl = `${testingUrl}sw-max-entries.js`;
 
     // Wait for the service worker to register and activate.
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     await global.__workbox.webdriver.executeAsyncScript((testingUrl, cb) => {
       fetch(`${testingUrl}example-1.txt`).then(() => cb()).catch((err) => cb(err.message));
@@ -86,7 +86,7 @@ describe(`expiration.Plugin`, function() {
 
     // Load the page and wait for the service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     await global.__workbox.webdriver.executeAsyncScript((testingUrl, cb) => {
       fetch(`${testingUrl}example-1.txt`).then(() => cb()).catch((err) => cb(err.message));

diff --git a/test/workbox-cacheable-response/integration/test-cacheable-response-plugin.js b/test/workbox-cacheable-response/integration/test-cacheable-response-plugin.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`cacheableResponse.Plugin`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -33,7 +33,7 @@ describe(`cacheableResponse.Plugin`, function() {
 
   it(`should load a page and cache entries`, async function() {
     // Wait for the service worker to register and activate.
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     await global.__workbox.webdriver.executeAsyncScript((testingUrl, cb) => {
       fetch(`${testingUrl}example-1.txt`).then(() => cb()).catch((err) => cb(err.message));

diff --git a/test/workbox-core/integration/test-core.js b/test/workbox-core/integration/test-core.js
@@ -1,4 +1,4 @@
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-core] Load core in the browser`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -7,7 +7,7 @@ describe(`[workbox-core] Load core in the browser`, function() {
 
   it(`should load workbox-core in a service worker.`, async function() {
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     // If the service worker activated, it meant the assertions in sw.js were
     // met and workbox-core exposes the expected API and defaults that were

diff --git a/test/workbox-google-analytics/integration/basic-example.js b/test/workbox-google-analytics/integration/basic-example.js
@@ -1,7 +1,7 @@
 const expect = require('chai').expect;
 const qs = require('qs');
 const {By} = require('selenium-webdriver');
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-google-analytics] Load and use Google Analytics`,
     function() {
@@ -31,7 +31,7 @@ describe(`[workbox-google-analytics] Load and use Google Analytics`,
     // Load the page and wait for the first service worker to activate.
     await driver.get(testingUrl);
 
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
   });
 
   beforeEach(async function() {

diff --git a/test/workbox-precaching/integration/precache-and-update.js b/test/workbox-precaching/integration/precache-and-update.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 const cleanSWEnv = require('../../../infra/testing/clean-sw');
 
 describe(`[workbox-precaching] Precache and Update`, function() {
@@ -45,7 +45,7 @@ describe(`[workbox-precaching] Precache and Update`, function() {
     global.__workbox.server.reset();
 
     // Register the first service worker.
-    await activateSW(SW_1_URL);
+    await activateAndControlSW(SW_1_URL);
 
     // Check that only the precache cache was created.
     const keys = await global.__workbox.webdriver.executeAsyncScript((cb) => {
@@ -106,7 +106,7 @@ describe(`[workbox-precaching] Precache and Update`, function() {
     }
 
     // Activate the second service worker
-    await activateSW(SW_2_URL);
+    await activateAndControlSW(SW_2_URL);
 
     // Ensure that the new assets were requested and cache busted.
     requestsMade = global.__workbox.server.getRequests();

diff --git a/test/workbox-range-requests/integration/range-requests-plugin.js b/test/workbox-range-requests/integration/range-requests-plugin.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 const cleanSWEnv = require('../../../infra/testing/clean-sw');
 
 describe(`rangeRequests.Plugin`, function() {
@@ -18,7 +18,7 @@ describe(`rangeRequests.Plugin`, function() {
     const dummyBody = '0123456789';
 
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     const partialResponseBody = await global.__workbox.webdriver.executeAsyncScript((dummyUrl, dummyBody, cb) => {
       const dummyResponse = new Response(dummyBody);

diff --git a/test/workbox-routing/integration/navigation-route.js b/test/workbox-routing/integration/navigation-route.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-routing] Route via NavigationRoute`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -10,7 +10,7 @@ describe(`[workbox-routing] Route via NavigationRoute`, function() {
   it(`should load a page and route requests`, async function() {
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     const nestedUrl = `${testingUrl}TestNavigationURL`;
 

diff --git a/test/workbox-routing/integration/routing-basic.js b/test/workbox-routing/integration/routing-basic.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-routing] Basic Route`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -9,7 +9,7 @@ describe(`[workbox-routing] Basic Route`, function() {
 
   before(async function() {
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
   });
 
   it(`should honor a route created by a Route object`, async function() {

diff --git a/test/workbox-routing/integration/routing-regex.js b/test/workbox-routing/integration/routing-regex.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-routing] Route via RegExp`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -10,7 +10,7 @@ describe(`[workbox-routing] Route via RegExp`, function() {
   it(`should load a page and route requests`, async function() {
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     let testCounter = 0;
 

diff --git a/test/workbox-strategies/integration/test-cacheFirst.js b/test/workbox-strategies/integration/test-cacheFirst.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-strategies] CacheFirst Requests`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -10,7 +10,7 @@ describe(`[workbox-strategies] CacheFirst Requests`, function() {
   it(`should respond with cached and non-cached entry`, async function() {
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     let response = await global.__workbox.webdriver.executeAsyncScript((cb) => {
       fetch(new URL(`/test/workbox-strategies/static/cache-first/example.txt`, location).href)

diff --git a/test/workbox-strategies/integration/test-cacheOnly.js b/test/workbox-strategies/integration/test-cacheOnly.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-strategies] CacheOnly Requests`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -10,7 +10,7 @@ describe(`[workbox-strategies] CacheOnly Requests`, function() {
   it(`should respond with cached and non-cached entry`, async function() {
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     let response = await global.__workbox.webdriver.executeAsyncScript((cb) => {
       fetch(new URL(`/CacheOnly/InCache/`, location).href)

diff --git a/test/workbox-strategies/integration/test-networkFirst.js b/test/workbox-strategies/integration/test-networkFirst.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe.only(`[workbox-strategies] NetworkFirst Requests`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -50,7 +50,7 @@ describe.only(`[workbox-strategies] NetworkFirst Requests`, function() {
 
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     let response = await global.__workbox.webdriver.executeAsyncScript((cb) => {
       fetch(new URL(`/test/uniqueValue`, location).href)

diff --git a/test/workbox-strategies/integration/test-networkOnly.js b/test/workbox-strategies/integration/test-networkOnly.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe.only(`[workbox-strategies] NetworkOnly Requests`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -12,7 +12,7 @@ describe.only(`[workbox-strategies] NetworkOnly Requests`, function() {
 
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     let response = await global.__workbox.webdriver.executeAsyncScript((cb) => {
       fetch(new URL(`/test/uniqueValue`, location).href)

diff --git a/test/workbox-strategies/integration/test-staleWhileRevalidate.js b/test/workbox-strategies/integration/test-staleWhileRevalidate.js
@@ -1,6 +1,6 @@
 const expect = require('chai').expect;
 
-const activateSW = require('../../../infra/testing/activate-sw');
+const activateAndControlSW = require('../../../infra/testing/activate-and-control');
 
 describe(`[workbox-strategies] StaleWhileRevalidate Requests`, function() {
   const testServerAddress = global.__workbox.server.getAddress();
@@ -50,7 +50,7 @@ describe(`[workbox-strategies] StaleWhileRevalidate Requests`, function() {
 
     // Load the page and wait for the first service worker to register and activate.
     await global.__workbox.webdriver.get(testingUrl);
-    await activateSW(swUrl);
+    await activateAndControlSW(swUrl);
 
     let response = await global.__workbox.webdriver.executeAsyncScript((cb) => {
       fetch(new URL(`/test/uniqueValue`, location).href)