1 files changed, 258 insertions, 0 deletions
diff --git a/browser/components/sessionstore/test/browser_scrollPositions.js b/browser/components/sessionstore/test/browser_scrollPositions.js
new file mode 100644
index 0000000000..094aa11325
--- /dev/null
+++ b/browser/components/sessionstore/test/browser_scrollPositions.js
@@ -0,0 +1,258 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+const BASE = "http://example.com/browser/browser/components/sessionstore/test/";
+const URL2 = BASE + "browser_scrollPositions_sample2.html";
+const URL_FRAMESET = BASE + "browser_scrollPositions_sample_frameset.html";
+
+// Randomized set of scroll positions we will use in this test.
+const SCROLL_X = Math.round(100 * (1 + Math.random()));
+const SCROLL_Y = Math.round(200 * (1 + Math.random()));
+const SCROLL_STR = SCROLL_X + "," + SCROLL_Y;
+
+const SCROLL2_X = Math.round(300 * (1 + Math.random()));
+const SCROLL2_Y = Math.round(400 * (1 + Math.random()));
+const SCROLL2_STR = SCROLL2_X + "," + SCROLL2_Y;
+
+requestLongerTimeout(10);
+
+add_task(test_scroll_nested);
+
+if (gFissionBrowser) {
+  addCoopTask("browser_scrollPositions_sample.html", test_scroll, HTTPSROOT);
+}
+addNonCoopTask("browser_scrollPositions_sample.html", test_scroll, HTTPROOT);
+addNonCoopTask("browser_scrollPositions_sample.html", test_scroll, HTTPSROOT);
+
+addCoopTask(
+  "browser_scrollPositions_sample.html",
+  test_scroll_background_tabs,
+  HTTPSROOT
+);
+addNonCoopTask(
+  "browser_scrollPositions_sample.html",
+  test_scroll_background_tabs,
+  HTTPROOT
+);
+
+addNonCoopTask(
+  "browser_scrollPositions_sample.html",
+  test_scroll_background_tabs,
+  HTTPSROOT
+);
+
+function getScrollPosition(bc) {
+  return SpecialPowers.spawn(bc, [], () => {
+    let x = {},
+      y = {};
+    content.windowUtils.getVisualViewportOffset(x, y);
+    return { x: x.value, y: y.value };
+  });
+}
+
+/**
+ * This test ensures that we properly serialize and restore scroll positions
+ * for an average page without any frames.
+ */
+async function test_scroll(aURL) {
+  let tab = BrowserTestUtils.addTab(gBrowser, aURL);
+  let browser = tab.linkedBrowser;
+  await promiseBrowserLoaded(browser);
+
+  // Scroll down a little.
+  await setScrollPosition(browser, SCROLL_X, SCROLL_Y);
+  await checkScroll(tab, { scroll: SCROLL_STR }, "scroll is fine");
+
+  // Duplicate and check that the scroll position is restored.
+  let tab2 = ss.duplicateTab(window, tab);
+  let browser2 = tab2.linkedBrowser;
+  await promiseTabRestored(tab2);
+
+  let scroll = await getScrollPosition(browser2);
+  is(
+    JSON.stringify(scroll),
+    JSON.stringify({ x: SCROLL_X, y: SCROLL_Y }),
+    "scroll position has been duplicated correctly"
+  );
+
+  // Check that reloading retains the scroll positions.
+  browser2.reload();
+  await promiseBrowserLoaded(browser2);
+  await checkScroll(
+    tab2,
+    { scroll: SCROLL_STR },
+    "reloading retains scroll positions"
+  );
+
+  // Check that a force-reload resets scroll positions.
+  browser2.reloadWithFlags(Ci.nsIWebNavigation.LOAD_FLAGS_BYPASS_CACHE);
+  await promiseBrowserLoaded(browser2);
+  await checkScroll(tab2, null, "force-reload resets scroll positions");
+
+  // Scroll back to the top and check that the position has been reset. We
+  // expect the scroll position to be "null" here because there is no data to
+  // be stored if the frame is in its default scroll position.
+  await setScrollPosition(browser, 0, 0);
+  await checkScroll(tab, null, "no scroll stored");
+
+  // Cleanup.
+  BrowserTestUtils.removeTab(tab);
+  BrowserTestUtils.removeTab(tab2);
+}
+
+/**
+ * This tests ensures that we properly serialize and restore scroll positions
+ * for multiple frames of pages with framesets.
+ */
+async function test_scroll_nested() {
+  let tab = BrowserTestUtils.addTab(gBrowser, URL_FRAMESET);
+  let browser = tab.linkedBrowser;
+  await promiseBrowserLoaded(browser);
+
+  // Scroll the first child frame down a little.
+  await setScrollPosition(
+    browser.browsingContext.children[0],
+    SCROLL_X,
+    SCROLL_Y
+  );
+  await checkScroll(
+    tab,
+    { children: [{ scroll: SCROLL_STR }] },
+    "scroll is fine"
+  );
+
+  // Scroll the second child frame down a little.
+  await setScrollPosition(
+    browser.browsingContext.children[1],
+    SCROLL2_X,
+    SCROLL2_Y
+  );
+  await checkScroll(
+    tab,
+    { children: [{ scroll: SCROLL_STR }, { scroll: SCROLL2_STR }] },
+    "scroll is fine"
+  );
+
+  // Duplicate and check that the scroll position is restored.
+  let tab2 = ss.duplicateTab(window, tab);
+  let browser2 = tab2.linkedBrowser;
+  await promiseTabRestored(tab2);
+
+  let scroll = await getScrollPosition(browser2.browsingContext.children[0]);
+  is(
+    JSON.stringify(scroll),
+    JSON.stringify({ x: SCROLL_X, y: SCROLL_Y }),
+    "scroll position #1 has been duplicated correctly"
+  );
+
+  scroll = await getScrollPosition(browser2.browsingContext.children[1]);
+  is(
+    JSON.stringify(scroll),
+    JSON.stringify({ x: SCROLL2_X, y: SCROLL2_Y }),
+    "scroll position #2 has been duplicated correctly"
+  );
+
+  // Check that resetting one frame's scroll position removes it from the
+  // serialized value.
+  await setScrollPosition(browser.browsingContext.children[0], 0, 0);
+  await checkScroll(
+    tab,
+    { children: [null, { scroll: SCROLL2_STR }] },
+    "scroll is fine"
+  );
+
+  // Check the resetting all frames' scroll positions nulls the stored value.
+  await setScrollPosition(browser.browsingContext.children[1], 0, 0);
+  await checkScroll(tab, null, "no scroll stored");
+
+  // Cleanup.
+  BrowserTestUtils.removeTab(tab);
+  BrowserTestUtils.removeTab(tab2);
+}
+
+/**
+ * Test that scroll positions persist after restoring background tabs in
+ * a restored window (bug 1228518).
+ * Also test that scroll positions for previous session history entries
+ * are preserved as well (bug 1265818).
+ */
+async function test_scroll_background_tabs(aURL) {
+  await pushPrefs(["browser.sessionstore.restore_on_demand", true]);
+
+  let newWin = await BrowserTestUtils.openNewBrowserWindow();
+  let tab = BrowserTestUtils.addTab(newWin.gBrowser, aURL);
+  let browser = tab.linkedBrowser;
+  await BrowserTestUtils.browserLoaded(browser);
+
+  // Scroll down a little.
+  await setScrollPosition(browser, SCROLL_X, SCROLL_Y);
+  await checkScroll(
+    tab,
+    { scroll: SCROLL_STR },
+    "scroll on first page is fine"
+  );
+
+  // Navigate to a different page and scroll there as well.
+  let browser2loaded = BrowserTestUtils.browserLoaded(browser, false, URL2);
+  BrowserTestUtils.loadURIString(browser, URL2);
+  await browser2loaded;
+
+  // Scroll down a little.
+  await setScrollPosition(browser, SCROLL2_X, SCROLL2_Y);
+  await checkScroll(
+    tab,
+    { scroll: SCROLL2_STR },
+    "scroll on second page is fine"
+  );
+
+  // Close the window
+  await BrowserTestUtils.closeWindow(newWin);
+
+  await forceSaveState();
+
+  // Now restore the window
+  newWin = ss.undoCloseWindow(0);
+
+  // Make sure to wait for the window to be restored.
+  await BrowserTestUtils.waitForEvent(newWin, "SSWindowStateReady");
+
+  is(newWin.gBrowser.tabs.length, 2, "There should be two tabs");
+
+  // The second tab should be the one we loaded aURL at still
+  tab = newWin.gBrowser.tabs[1];
+
+  ok(tab.hasAttribute("pending"), "Tab should be pending");
+  browser = tab.linkedBrowser;
+
+  // Ensure there are no pending queued messages in the child.
+  await TabStateFlusher.flush(browser);
+
+  // Now check to see if the background tab remembers where it
+  // should be scrolled to.
+  newWin.gBrowser.selectedTab = tab;
+  await promiseTabRestored(tab);
+
+  await checkScroll(
+    tab,
+    { scroll: SCROLL2_STR },
+    "scroll is correct for restored tab"
+  );
+
+  // Now go back in history and check that the scroll position
+  // is restored there as well.
+  is(browser.canGoBack, true, "can go back");
+  browser.goBack();
+
+  await BrowserTestUtils.browserLoaded(browser);
+  await TabStateFlusher.flush(browser);
+
+  await checkScroll(
+    tab,
+    { scroll: SCROLL_STR },
+    "scroll is correct after navigating back within the restored tab"
+  );
+
+  await BrowserTestUtils.closeWindow(newWin);
+}