Attachment 8866279 Details for Bug 1217544

[patch] Multi-origin tests

. (text/plain), 7.06 KB, created by Andrew Sutherland [:asuth] (he/him)

(hide)

Description:

Filename:

MIME Type:

Creator: Andrew Sutherland [:asuth] (he/him)

Size: 7.06 KB

patch

obsolete

># HG changeset patch
># User Andrew Sutherland <asutherland@asutherland.org>
># Date 1494379256 14400
>#      Tue May 09 21:20:56 2017 -0400
># Node ID de18553a54d9d874c4673e99ad73dd7f4dd54866
># Parent  5162b0647a4d3be8516af5e3d189236b042e1e86
>Bug 1217544 - Multi-origin tests.
>
>diff --git a/dom/backgroundsync/moz.build b/dom/backgroundsync/moz.build
>--- a/dom/backgroundsync/moz.build
>+++ b/dom/backgroundsync/moz.build
>@@ -31,16 +31,20 @@ IPDL_SOURCES += [
>     'BackgroundSyncIPCTypes.ipdlh',
>     'PBackgroundSync.ipdl'
> ]
> 
> MOCHITEST_MANIFESTS += [
>     'tests/mochitest.ini'
> ]
> 
>+BROWSER_CHROME_MANIFESTS += [
>+    'tests/browser.ini'
>+]
>+
> LOCAL_INCLUDES += [
>     '/dom/workers',
>     '/netwerk/base'
> ]
> 
> include('/ipc/chromium/chromium-config.mozbuild')
> 
> FINAL_LIBRARY = 'xul'
>diff --git a/dom/backgroundsync/tests/browser.ini b/dom/backgroundsync/tests/browser.ini
>new file mode 100644
>--- /dev/null
>+++ b/dom/backgroundsync/tests/browser.ini
>@@ -0,0 +1,6 @@
>+[DEFAULT]
>+support-files =
>+  page_multiple_origins.html
>+  worker_multiple_origins.js
>+
>+[browser_multiple_origins.js]
>diff --git a/dom/backgroundsync/tests/browser_multiple_origins.js b/dom/backgroundsync/tests/browser_multiple_origins.js
>new file mode 100644
>--- /dev/null
>+++ b/dom/backgroundsync/tests/browser_multiple_origins.js
>@@ -0,0 +1,100 @@
>+/**
>+ * Test that we fire sync notifications for multiple origins correctly.
>+ *
>+ * This cannot be a web platform test at the current time because we lack the
>+ * ability to toggle online/offline state.  Bug 1362916 tracks progress.
>+ *
>+ * This is a browser chrome test rather than a standard mochitest because:
>+ * - Using multiple origins from a single mochitest page depends on iframes that
>+ *   may run afoul of various privacy protections in the future.
>+ * - We may need to deal with e10s complications for this test or similar tests
>+ *   in the future and it is only practical at this time to do so from browser
>+ *   chrome tests.
>+ **/
>+"use strict";
>+
>+// Although the dom.serviceWorkers.testing.enabled pref enables SWs on
>+// non-https origins, we don't need to fake it.
>+const TEST_ORIGINS = ['https://example.com', 'https://example.org'];
>+
>+add_task(async function test_multiple_origins() {
>+  await SpecialPowers.pushPrefEnv({
>+    set: [
>+      ["dom.backgroundSync.enabled", true],
>+      ["dom.serviceWorkers.enabled", true],
>+      // necessary to use nsIQuotaManagerService API's like clear.
>+      ["dom.quotaManager.testing", true],
>+    ]
>+  });
>+
>+  /**
>+   * In event of failure, we want to ensure our SW registrations are removed and
>+   * the backgroundsync registrations are also removed.
>+   */
>+  registerCleanupFunction(function clear_service_workers_and_bgsync() {
>+    Services.io.offline = false;
>+    return new Promise((resolve) => {
>+      Services.qms.clear().callback = resolve;
>+    });
>+  });
>+
>+  info("opening tabs for all origins; they will autoregister SW");
>+  const tabs = await(Promise.all(TEST_ORIGINS.map((origin) => {
>+    return BrowserTestUtils.openNewForegroundTab(
>+      gBrowser,
>+      `${origin}/browser/dom/backgroundsync/tests/page_multiple_origins.html`);
>+  })));
>+
>+  info("waiting for all serviceworkers to register and activate");
>+  await(Promise.all(tabs.map((tab) => {
>+    return ContentTask.spawn(tab.linkedBrowser, null, function() {
>+      if (!content.wrappedJSObject.swActivationPromise) {
>+        throw new Error("Page failed to attempt to register SW.")
>+      }
>+      return content.wrappedJSObject.swActivationPromise.then(() => true);
>+    });
>+  })));
>+
>+  const desiredSyncTags = TEST_ORIGINS.map((origin, i) => "tag" + i)
>+
>+  info("going offline and waiting for each origin to register their sync tag");
>+  Services.io.offline = true;
>+  await(Promise.all(tabs.map((tab, i) => {
>+    return ContentTask.spawn(
>+      tab.linkedBrowser,
>+      desiredSyncTags[i],
>+      function(useTag) {
>+        return content.wrappedJSObject.swActivationPromise.then((r) => {
>+          return r.sync.register(useTag); // resolves with null, safe to return.
>+      });
>+    });
>+  })));
>+
>+  info("going online, waiting for each origin's sync to trigger");
>+  // The page listens on a dedicated BroadcastChannel for a report from *any*
>+  // ServiceWorker for the given scope that it received the sync event.  Until
>+  // bug 1231213 is addressed and backgroundsync updated so that it's impossible
>+  // for there to be multiple instances of a particular SW, it's expected /
>+  // possible that the SW that receives the "sync" event will be in a different
>+  // process and be a fresh SW with a distinct global from the one registered by
>+  // the page (in a different process).  In that case, communication between the
>+  // page and "sync"-servicing SW is only possible via BroadcastChannel, at
>+  // least until bug 1293277 and possibly follow-ons are fixed.
>+  Services.io.offline = false;
>+  const triggeredSyncTags = await(Promise.all(tabs.map((tab) => {
>+    return ContentTask.spawn(tab.linkedBrowser, null, function() {
>+      if (!content.wrappedJSObject.heardSyncEventPromise) {
>+        throw new Error("Page somehow not listening for sync event.");
>+      }
>+      // resolves with the received tag
>+      return content.wrappedJSObject.heardSyncEventPromise;
>+    });
>+  })));
>+  is(triggeredSyncTags.toString(), desiredSyncTags.toString(),
>+     "sync tags match");
>+
>+  info("closing all tabs");
>+  await(Promise.all(tabs.map((tab) => {
>+    return BrowserTestUtils.removeTab(tab);
>+  })));
>+});
>diff --git a/dom/backgroundsync/tests/page_multiple_origins.html b/dom/backgroundsync/tests/page_multiple_origins.html
>new file mode 100644
>--- /dev/null
>+++ b/dom/backgroundsync/tests/page_multiple_origins.html
>@@ -0,0 +1,34 @@
>+<!doctype html>
>+<html>
>+<head>
>+  <meta charset="utf-8">
>+<script>
>+
>+// Register the SW and wait for it to activate.  (Step 2 of SyncManager.register
>+// waits for there to be an active worker.  We want to hang during the SW
>+// registration phase rather than during the sync registration phase if there's
>+// a problem related to SW registration/activation.)
>+window.swActivationPromise = navigator.serviceWorker.register(
>+  "worker_multiple_origins.js", { scope: "./multiple_origins/" }).then((r) => {
>+    return new Promise((resolve) => {
>+      const worker = r.installing;
>+      worker.addEventListener("statechange", () => {
>+        if (worker.state === "activated") {
>+          resolve(r);
>+        }
>+      });
>+    });
>+  });
>+
>+window.heardSyncEventPromise = new Promise((resolve) => {
>+  const channel = new BroadcastChannel("multiple_origins");
>+  channel.onmessage = function(event) {
>+    if (event.data.type === 'sync-event-received') {
>+      resolve(event.data.tag);
>+    }
>+  };
>+});
>+</script>
>+</head>
>+<body></body>
>+</html>
>diff --git a/dom/backgroundsync/tests/worker_multiple_origins.js b/dom/backgroundsync/tests/worker_multiple_origins.js
>new file mode 100644
>--- /dev/null
>+++ b/dom/backgroundsync/tests/worker_multiple_origins.js
>@@ -0,0 +1,7 @@
>+self.addEventListener("sync", function(event) {
>+  const channel = new BroadcastChannel("multiple_origins");
>+  channel.postMessage({
>+    type: "sync-event-received",
>+    tag: event.tag
>+  });
>+});

Actions: View | Diff | Review

Attachments on bug 1217544: 8705632 | 8705633 | 8705634 | 8707035 | 8712697 | 8712699 | 8712744 | 8712745 | 8712746 | 8721385 | 8721387 | 8721388 | 8721389 | 8721408 | 8727182 | 8731368 | 8731371 | 8731374 | 8731377 | 8733495 | 8733497 | 8736435 | 8736438 | 8743357 | 8743359 | 8743360 | 8743362 | 8743363 | 8743364 | 8743365 | 8743366 | 8759773 | 8763785 | 8763788 | 8763790 | 8763791 | 8763794 | 8763795 | 8763796 | 8763797 | 8763799 | 8777369 | 8777370 | 8777373 | 8777386 | 8777388 | 8777390 | 8777844 | 8788555 | 8788558 | 8788560 | 8788562 | 8788567 | 8788569 | 8788571 | 8788574 | 8788575 | 8788576 | 8832151 | 8832152 | 8832153 | 8832154 | 8832155 | 8832156 | 8832157 | 8832158 | 8832159 | 8832167 | 8832450 | 8866279 | 8866280 | 9053609