gecko-dev/dom/base/test/browser_bug1303838.js

/* -*- Mode: JavaScript; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * Test for bug 1303838.
 * Load a tab with some links, emulate link clicks and check if the
 * browser would switch to the existing target tab opened by previous
 * link click if loadDivertedInBackground is set to true.
 */

"use strict";

const BASE_URL = "http://mochi.test:8888/browser/dom/base/test/";

add_task(async function() {
  // On Linux, in our test automation, the mouse cursor floats over
  // the first tab, which causes it to be warmed up when tab warming
  // is enabled. The TabSwitchDone event doesn't fire until the warmed
  // tab is evicted, which is after a few seconds. That means that
  // this test ends up taking longer than we'd like, since its waiting
  // for the TabSwitchDone event between tab switches.
  //
  // So now we make sure that warmed tabs are evicted very shortly
  // after warming to avoid the test running too long.
  await SpecialPowers.pushPrefEnv({
    set: [["browser.tabs.remote.warmup.unloadDelayMs", 50]],
  });
  await testLinkClick(false, false);
  await testLinkClick(false, true);
  await testLinkClick(true, false);
  await testLinkClick(true, true);
});

async function testLinkClick(withFrame, loadDivertedInBackground) {
  await SpecialPowers.pushPrefEnv({"set": [["browser.tabs.loadDivertedInBackground", loadDivertedInBackground]]});

  let tab = await BrowserTestUtils.openNewForegroundTab(gBrowser,
    BASE_URL + (withFrame ? "file_bug1303838_with_iframe.html" : "file_bug1303838.html"));
  is(gBrowser.tabs.length, 2, "check tabs.length");
  is(gBrowser.selectedTab, tab, "check selectedTab");

  info("Test normal links with loadDivertedInBackground=" + loadDivertedInBackground + ", withFrame=" + withFrame);

  let [testTab] = await clickLink(withFrame, "#link-1", tab.linkedBrowser);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#link-2", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#link-3", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#link-4", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground, 2);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  info("Test anchor links with loadDivertedInBackground=" + loadDivertedInBackground + ", withFrame=" + withFrame);

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#anchor-link-1", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#anchor-link-2", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#anchor-link-3", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  info("Test iframe links with loadDivertedInBackground=" + loadDivertedInBackground + ", withFrame=" + withFrame);

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#frame-link-1", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#frame-link-2", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  if (!loadDivertedInBackground) {
    await BrowserTestUtils.switchTab(gBrowser, tab);
  }
  await clickLink(withFrame, "#frame-link-3", tab.linkedBrowser, testTab.linkedBrowser, !loadDivertedInBackground);
  is(gBrowser.tabs.length, 3, "check tabs.length");
  is(gBrowser.selectedTab, loadDivertedInBackground ? tab : testTab, "check selectedTab");

  BrowserTestUtils.removeTab(testTab);
  BrowserTestUtils.removeTab(tab);
}

function clickLink(isFrame, linkId, browser, testBrowser, awaitTabSwitch = false, locationChangeNum = 1) {
  let promises = [];
  if (awaitTabSwitch) {
    promises.push(waitForTabSwitch(gBrowser));
  }
  promises.push(testBrowser ?
                waitForLocationChange(testBrowser, locationChangeNum) :
                BrowserTestUtils.waitForNewTab(gBrowser));
  promises.push(ContentTask.spawn(browser, [isFrame, linkId],
                                  ([contentIsFrame, contentLinkId]) => {
    let doc = content.document;
    if (contentIsFrame) {
      let frame = content.document.getElementById("frame");
      doc = frame.contentDocument;
    }
    info("Clicking " + contentLinkId);
    doc.querySelector(contentLinkId).click();
  }));
  return Promise.all(promises);
}

function waitForTabSwitch(tabbrowser) {
  info("Waiting for TabSwitch");
  return new Promise(resolve => {
    tabbrowser.addEventListener("TabSwitchDone", function onSwitch() {
      info("TabSwitch done");
      tabbrowser.removeEventListener("TabSwitchDone", onSwitch);
      resolve(tabbrowser.selectedTab);
    });
  });
}

// We need a longer lifetime reference to ensure the listener is alive when
// location change occurs.
let locationChangeListener;
function waitForLocationChange(browser, locationChangeNum) {
  info("Waiting for " + locationChangeNum + " LocationChange");
  return new Promise(resolve => {
    let seen = 0;
    locationChangeListener = {
      onLocationChange(aWebProgress, aRequest, aLocation, aFlags) {
        info("LocationChange: " + aLocation.spec);
        if (++seen == locationChangeNum) {
          browser.removeProgressListener(this);
          resolve();
        }
      },
      QueryInterface: ChromeUtils.generateQI([Ci.nsIWebProgressListener,
                                              Ci.nsISupportsWeakReference])
    };
    browser.addProgressListener(locationChangeListener);
  });
}