From f594601d765d82178b41365d1d8e225a2eab1054 Mon Sep 17 00:00:00 2001
From: Peter Van der Beken <peterv@propagandism.org>
Date: Mon, 19 Apr 2021 12:39:21 +0000
Subject: [PATCH] Bug 1696158 - Move CanSavePresentation to the parent process.
 Add test. r=smaug

Differential Revision: https://phabricator.services.mozilla.com/D110235
---
 .../test/navigation/file_blockBFCache.html    |  33 +++
 docshell/test/navigation/mochitest.ini        |   4 +
 docshell/test/navigation/slow.sjs             |  14 ++
 .../test/navigation/test_blockBFCache.html    | 197 ++++++++++++++++++
 4 files changed, 248 insertions(+)
 create mode 100644 docshell/test/navigation/file_blockBFCache.html
 create mode 100644 docshell/test/navigation/slow.sjs
 create mode 100644 docshell/test/navigation/test_blockBFCache.html
diff --git a/docshell/test/navigation/file_blockBFCache.html b/docshell/test/navigation/file_blockBFCache.html
new file mode 100644
index 000000000000..dc743cdc673d
--- /dev/null
+++ b/docshell/test/navigation/file_blockBFCache.html
@@ -0,0 +1,33 @@
+<script>
+let keepAlive;
+window.onpageshow = (pageShow) => {
+  let bc = new BroadcastChannel("bfcache_blocking");
+
+  bc.onmessage = async function(m) {
+    switch(m.data.message) {
+      case "load":
+        bc.close();
+        location.href = m.data.url;
+        break;
+      case "runScript":
+        let test = new Function(`return ${m.data.fun};`)();
+        keepAlive = await test.call(window);
+        bc.postMessage({ type: "runScriptDone" });
+        break;
+      case "back":
+        bc.close();
+        history.back();
+        break;
+      case "forward":
+        bc.close();
+        history.forward();
+        break;
+      case "close":
+        window.close();
+        break;
+    }
+  };
+
+  bc.postMessage({ type: pageShow.type, persisted: pageShow.persisted })
+};
+</script>
diff --git a/docshell/test/navigation/mochitest.ini b/docshell/test/navigation/mochitest.ini
index 4d4e1ef5af61..98179ed35749 100644
--- a/docshell/test/navigation/mochitest.ini
+++ b/docshell/test/navigation/mochitest.ini
@@ -99,6 +99,10 @@ skip-if = (os == "android") # Bug 1560378
 [test_bug1375833.html]
 [test_bug1536471.html]
 support-files = file_bug1536471.html
+[test_blockBFCache.html]
+support-files =
+  file_blockBFCache.html
+  slow.sjs
 [test_child.html]
 [test_docshell_gotoindex.html]
 support-files = file_docshell_gotoindex.html
diff --git a/docshell/test/navigation/slow.sjs b/docshell/test/navigation/slow.sjs
new file mode 100644
index 000000000000..89313e0534eb
--- /dev/null
+++ b/docshell/test/navigation/slow.sjs
@@ -0,0 +1,14 @@
+function handleRequest(request, response)
+{
+  response.processAsync();
+
+  timer = Components.classes["@mozilla.org/timer;1"].
+          createInstance(Components.interfaces.nsITimer);
+  timer.init(function() {
+    response.finish();
+  }, 5000, Components.interfaces.nsITimer.TYPE_ONE_SHOT);
+
+  response.setStatusLine(null, 200, "OK");
+  response.setHeader("Content-Type", "text/plain", false);
+  response.write("Start of the content.");
+}
diff --git a/docshell/test/navigation/test_blockBFCache.html b/docshell/test/navigation/test_blockBFCache.html
new file mode 100644
index 000000000000..707fd0b96ec7
--- /dev/null
+++ b/docshell/test/navigation/test_blockBFCache.html
@@ -0,0 +1,197 @@
+<!DOCTYPE HTML>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Blocking pages from entering BFCache</title>
+  <script src="/tests/SimpleTest/SimpleTest.js"></script>
+  <link rel="stylesheet" href="/tests/SimpleTest/test.css"/>
+</head>
+<body onload="">
+<script>
+
+const getUserMediaPrefs = {
+  set: [
+    ["media.devices.insecure.enabled", true],
+    ["media.getusermedia.insecure.enabled", true],
+    ["media.navigator.permission.disabled", true],
+  ],
+};
+const msePrefs = {
+  set: [
+    ["media.mediasource.enabled", true],
+    ["media.audio-max-decode-error", 0],
+    ["media.video-max-decode-error", 0],
+  ]
+};
+
+const blockBFCacheTests = [
+  {
+    name: "Request",
+    test: () => {
+      return new Promise((resolve) => {
+        const xhr = new XMLHttpRequest();
+        xhr.open("GET", "slow.sjs");
+        xhr.addEventListener("progress", () => { resolve(xhr); }, { once: true });
+        xhr.send();
+      });
+    },
+  },
+  {
+    name: "getUserMedia",
+    prefs: getUserMediaPrefs,
+    test: () => {
+      return navigator.mediaDevices.getUserMedia({ audio: true, fake: true });
+    },
+  },
+  {
+    name: "RTCPeerConnection",
+    test: () => {
+      let pc = new RTCPeerConnection();
+      return pc.createOffer();
+    },
+  },
+  {
+    name: "MSE",
+    prefs: msePrefs,
+    test: () => {
+      const ms = new MediaSource();
+      const el = document.createElement("video");
+      el.src = URL.createObjectURL(ms);
+      el.preload = "auto";
+      return el;
+    },
+  },
+  {
+    name: "WebSpeech",
+    test: () => {
+      return new Promise((resolve) => {
+        const utterance = new SpeechSynthesisUtterance('bfcache');
+        utterance.lang = 'it-IT-noend';
+        utterance.addEventListener('start', () => { resolve(utterance); })
+        speechSynthesis.speak(utterance);
+      });
+    },
+  },
+  {
+    name: "WebVR",
+    prefs: {
+      set: [
+        ["dom.vr.test.enabled", true],
+        ["dom.vr.puppet.enabled", true],
+        ["dom.vr.require-gesture", false],
+      ],
+    },
+    test: () => {
+      return navigator.requestVRServiceTest();
+    }
+  },
+];
+
+const dontBlockBFCacheTests = [
+  {
+    name: "getUserMedia",
+    prefs: getUserMediaPrefs,
+    test: () => {
+      return navigator.mediaDevices.getUserMedia({ video: true, fake: true }).then(stream => {
+        stream.getTracks().forEach(track => track.stop());
+        return stream;
+      });
+    },
+  },
+/*
+  Disabled because MediaKeys rely on being destroyed by the CC before they
+  notify their window, so the test would intermittently fail depending on
+  when the CC runs.
+
+  {
+    name: "MSE",
+    prefs: msePrefs,
+    test: () => {
+      return new Promise((resolve) => {
+        const ms = new MediaSource();
+        const el = document.createElement("video");
+        ms.addEventListener("sourceopen", () => { resolve(el) }, { once: true });
+        el.src = URL.createObjectURL(ms);
+        el.preload = "auto";
+      }).then(el => {
+        el.src = ""; 
+        return el;
+      });
+    },
+  },
+*/
+];
+
+let bc = new BroadcastChannel("bfcache_blocking");
+
+function promiseMessage(type) {
+  return new Promise((resolve, reject) => {
+    bc.addEventListener("message", (e) => {
+      if (e.data.type == type) {
+        resolve(e.data);
+      }
+    }, { once: true });
+  });
+}
+
+function promisePageShow(shouldBePersisted) {
+  return promiseMessage("pageshow").then(data => data.persisted == shouldBePersisted);
+}
+
+function promisePageShowFromBFCache(e) {
+  return promisePageShow(true);
+}
+
+function promisePageShowNotFromBFCache(e) {
+  return promisePageShow(false);
+}
+
+function runTests(testArray, shouldBlockBFCache) {
+  for (const { name, prefs = {}, test } of testArray) {
+    add_task(async function() {
+      await SpecialPowers.pushPrefEnv(prefs, async function() {
+        // Load a mostly blank page that we can communicate with over
+        // BroadcastChannel (though it will close the BroadcastChannel after
+        // receiving the next "load" message, to avoid blocking BFCache).
+        let loaded = promisePageShowNotFromBFCache();
+        window.open("file_blockBFCache.html", "", "noopener");
+        await loaded;
+
+        // Load the same page with a different URL.
+        loaded = promisePageShowNotFromBFCache();
+        bc.postMessage({ message: "load", url: `file_blockBFCache.html?${name}_${shouldBlockBFCache}` });
+        await loaded;
+
+        // Run test script in the second page.
+        bc.postMessage({ message: "runScript", fun: test.toString() });
+        await promiseMessage("runScriptDone");
+
+        // Go back to the first page (this should just come from the BFCache).
+        let goneBack = promisePageShowFromBFCache();
+        bc.postMessage({ message: "back" });
+        await goneBack;
+
+        // Go forward again to the second page and check that it does/doesn't come
+        // from the BFCache.
+        let goneForward = promisePageShow(!shouldBlockBFCache);
+        bc.postMessage({ message: "forward" });
+        let result = await goneForward;
+        ok(result, `Page ${shouldBlockBFCache ? "should" : "should not"} have been blocked from going into the BFCache (${name})`);
+
+        bc.postMessage({ message: "close" });
+
+        SpecialPowers.popPrefEnv();
+      });
+    });
+  }
+}
+
+// If Fission is disabled, the pref is no-op.
+SpecialPowers.pushPrefEnv({set: [["fission.bfcacheInParent", true]]}, () => {
+  runTests(blockBFCacheTests, true);
+  runTests(dontBlockBFCacheTests, false);
+});
+
+</script>
+</body>
+</html>
