michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: "use strict";
michael@0: 
michael@0: // Avoid leaks by using tmp for imports...
michael@0: let tmp = {};
michael@0: Cu.import("resource://gre/modules/Promise.jsm", tmp);
michael@0: Cu.import("resource:///modules/CustomizableUI.jsm", tmp);
michael@0: let {Promise, CustomizableUI} = tmp;
michael@0: 
michael@0: let ChromeUtils = {};
michael@0: Services.scriptloader.loadSubScript("chrome://mochikit/content/tests/SimpleTest/ChromeUtils.js", ChromeUtils);
michael@0: 
michael@0: Services.prefs.setBoolPref("browser.uiCustomization.skipSourceNodeCheck", true);
michael@0: registerCleanupFunction(() => Services.prefs.clearUserPref("browser.uiCustomization.skipSourceNodeCheck"));
michael@0: 
michael@0: let {synthesizeDragStart, synthesizeDrop} = ChromeUtils;
michael@0: 
michael@0: const kNSXUL = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
michael@0: const kTabEventFailureTimeoutInMs = 20000;
michael@0: 
michael@0: function createDummyXULButton(id, label) {
michael@0:   let btn = document.createElementNS(kNSXUL, "toolbarbutton");
michael@0:   btn.id = id;
michael@0:   btn.setAttribute("label", label || id);
michael@0:   btn.className = "toolbarbutton-1 chromeclass-toolbar-additional";
michael@0:   window.gNavToolbox.palette.appendChild(btn);
michael@0:   return btn;
michael@0: }
michael@0: 
michael@0: let gAddedToolbars = new Set();
michael@0: 
michael@0: function createToolbarWithPlacements(id, placements = []) {
michael@0:   gAddedToolbars.add(id);
michael@0:   let tb = document.createElementNS(kNSXUL, "toolbar");
michael@0:   tb.id = id;
michael@0:   tb.setAttribute("customizable", "true");
michael@0:   CustomizableUI.registerArea(id, {
michael@0:     type: CustomizableUI.TYPE_TOOLBAR,
michael@0:     defaultPlacements: placements
michael@0:   });
michael@0:   gNavToolbox.appendChild(tb);
michael@0:   return tb;
michael@0: }
michael@0: 
michael@0: function createOverflowableToolbarWithPlacements(id, placements) {
michael@0:   gAddedToolbars.add(id);
michael@0: 
michael@0:   let tb = document.createElementNS(kNSXUL, "toolbar");
michael@0:   tb.id = id;
michael@0:   tb.setAttribute("customizationtarget", id + "-target");
michael@0: 
michael@0:   let customizationtarget = document.createElementNS(kNSXUL, "hbox");
michael@0:   customizationtarget.id = id + "-target";
michael@0:   customizationtarget.setAttribute("flex", "1");
michael@0:   tb.appendChild(customizationtarget);
michael@0: 
michael@0:   let overflowPanel = document.createElementNS(kNSXUL, "panel");
michael@0:   overflowPanel.id = id + "-overflow";
michael@0:   document.getElementById("mainPopupSet").appendChild(overflowPanel);
michael@0: 
michael@0:   let overflowList = document.createElementNS(kNSXUL, "vbox");
michael@0:   overflowList.id = id + "-overflow-list";
michael@0:   overflowPanel.appendChild(overflowList);
michael@0: 
michael@0:   let chevron = document.createElementNS(kNSXUL, "toolbarbutton");
michael@0:   chevron.id = id + "-chevron";
michael@0:   tb.appendChild(chevron);
michael@0: 
michael@0:   CustomizableUI.registerArea(id, {
michael@0:     type: CustomizableUI.TYPE_TOOLBAR,
michael@0:     defaultPlacements: placements,
michael@0:     overflowable: true,
michael@0:   });
michael@0: 
michael@0:   tb.setAttribute("customizable", "true");
michael@0:   tb.setAttribute("overflowable", "true");
michael@0:   tb.setAttribute("overflowpanel", overflowPanel.id);
michael@0:   tb.setAttribute("overflowtarget", overflowList.id);
michael@0:   tb.setAttribute("overflowbutton", chevron.id);
michael@0: 
michael@0:   gNavToolbox.appendChild(tb);
michael@0:   return tb;
michael@0: }
michael@0: 
michael@0: function removeCustomToolbars() {
michael@0:   CustomizableUI.reset();
michael@0:   for (let toolbarId of gAddedToolbars) {
michael@0:     CustomizableUI.unregisterArea(toolbarId, true);
michael@0:     let tb = document.getElementById(toolbarId);
michael@0:     if (tb.hasAttribute("overflowpanel")) {
michael@0:       let panel = document.getElementById(tb.getAttribute("overflowpanel"));
michael@0:       if (panel)
michael@0:         panel.remove();
michael@0:     }
michael@0:     tb.remove();
michael@0:   }
michael@0:   gAddedToolbars.clear();
michael@0: }
michael@0: 
michael@0: function getToolboxCustomToolbarId(toolbarName) {
michael@0:   return "__customToolbar_" + toolbarName.replace(" ", "_");
michael@0: }
michael@0: 
michael@0: function resetCustomization() {
michael@0:   return CustomizableUI.reset();
michael@0: }
michael@0: 
michael@0: function isInWin8() {
michael@0:   if (!Services.metro)
michael@0:     return false;
michael@0:   return Services.metro.supported;
michael@0: }
michael@0: 
michael@0: function addSwitchToMetroButtonInWindows8(areaPanelPlacements) {
michael@0:   if (isInWin8()) {
michael@0:     areaPanelPlacements.push("switch-to-metro-button");
michael@0:   }
michael@0: }
michael@0: 
michael@0: function assertAreaPlacements(areaId, expectedPlacements) {
michael@0:   let actualPlacements = getAreaWidgetIds(areaId);
michael@0:   placementArraysEqual(areaId, actualPlacements, expectedPlacements);
michael@0: }
michael@0: 
michael@0: function placementArraysEqual(areaId, actualPlacements, expectedPlacements) {
michael@0:   is(actualPlacements.length, expectedPlacements.length,
michael@0:      "Area " + areaId + " should have " + expectedPlacements.length + " items.");
michael@0:   let minItems = Math.min(expectedPlacements.length, actualPlacements.length);
michael@0:   for (let i = 0; i < minItems; i++) {
michael@0:     if (typeof expectedPlacements[i] == "string") {
michael@0:       is(actualPlacements[i], expectedPlacements[i],
michael@0:          "Item " + i + " in " + areaId + " should match expectations.");
michael@0:     } else if (expectedPlacements[i] instanceof RegExp) {
michael@0:       ok(expectedPlacements[i].test(actualPlacements[i]),
michael@0:          "Item " + i + " (" + actualPlacements[i] + ") in " +
michael@0:          areaId + " should match " + expectedPlacements[i]); 
michael@0:     } else {
michael@0:       ok(false, "Unknown type of expected placement passed to " +
michael@0:                 " assertAreaPlacements. Is your test broken?");
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: function todoAssertAreaPlacements(areaId, expectedPlacements) {
michael@0:   let actualPlacements = getAreaWidgetIds(areaId);
michael@0:   let isPassing = actualPlacements.length == expectedPlacements.length;
michael@0:   let minItems = Math.min(expectedPlacements.length, actualPlacements.length);
michael@0:   for (let i = 0; i < minItems; i++) {
michael@0:     if (typeof expectedPlacements[i] == "string") {
michael@0:       isPassing = isPassing && actualPlacements[i] == expectedPlacements[i];
michael@0:     } else if (expectedPlacements[i] instanceof RegExp) {
michael@0:       isPassing = isPassing && expectedPlacements[i].test(actualPlacements[i]);
michael@0:     } else {
michael@0:       ok(false, "Unknown type of expected placement passed to " +
michael@0:                 " assertAreaPlacements. Is your test broken?");
michael@0:     }
michael@0:   }
michael@0:   todo(isPassing, "The area placements for " + areaId +
michael@0:                   " should equal the expected placements.");
michael@0: }
michael@0: 
michael@0: function getAreaWidgetIds(areaId) {
michael@0:   return CustomizableUI.getWidgetIdsInArea(areaId);
michael@0: }
michael@0: 
michael@0: function simulateItemDrag(toDrag, target) {
michael@0:   let docId = toDrag.ownerDocument.documentElement.id;
michael@0:   let dragData = [[{type: 'text/toolbarwrapper-id/' + docId,
michael@0:                     data: toDrag.id}]];
michael@0:   synthesizeDragStart(toDrag.parentNode, dragData);
michael@0:   synthesizeDrop(target, target, dragData);
michael@0: }
michael@0: 
michael@0: function endCustomizing(aWindow=window) {
michael@0:   if (aWindow.document.documentElement.getAttribute("customizing") != "true") {
michael@0:     return true;
michael@0:   }
michael@0:   Services.prefs.setBoolPref("browser.uiCustomization.disableAnimation", true);
michael@0:   let deferredEndCustomizing = Promise.defer();
michael@0:   function onCustomizationEnds() {
michael@0:     Services.prefs.setBoolPref("browser.uiCustomization.disableAnimation", false);
michael@0:     aWindow.gNavToolbox.removeEventListener("aftercustomization", onCustomizationEnds);
michael@0:     deferredEndCustomizing.resolve();
michael@0:   }
michael@0:   aWindow.gNavToolbox.addEventListener("aftercustomization", onCustomizationEnds);
michael@0:   aWindow.gCustomizeMode.exit();
michael@0: 
michael@0:   return deferredEndCustomizing.promise.then(function() {
michael@0:     let deferredLoadNewTab = Promise.defer();
michael@0: 
michael@0:     //XXXgijs so some tests depend on this tab being about:blank. Make it so.
michael@0:     let newTabBrowser = aWindow.gBrowser.selectedBrowser;
michael@0:     newTabBrowser.stop();
michael@0: 
michael@0:     // If we stop early enough, this might actually be about:blank.
michael@0:     if (newTabBrowser.contentDocument.location.href == "about:blank") {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // Otherwise, make it be about:blank, and wait for that to be done.
michael@0:     function onNewTabLoaded(e) {
michael@0:       newTabBrowser.removeEventListener("load", onNewTabLoaded, true);
michael@0:       deferredLoadNewTab.resolve();
michael@0:     }
michael@0:     newTabBrowser.addEventListener("load", onNewTabLoaded, true);
michael@0:     newTabBrowser.contentDocument.location.replace("about:blank");
michael@0:     return deferredLoadNewTab.promise;
michael@0:   });
michael@0: }
michael@0: 
michael@0: function startCustomizing(aWindow=window) {
michael@0:   if (aWindow.document.documentElement.getAttribute("customizing") == "true") {
michael@0:     return;
michael@0:   }
michael@0:   Services.prefs.setBoolPref("browser.uiCustomization.disableAnimation", true);
michael@0:   let deferred = Promise.defer();
michael@0:   function onCustomizing() {
michael@0:     aWindow.gNavToolbox.removeEventListener("customizationready", onCustomizing);
michael@0:     Services.prefs.setBoolPref("browser.uiCustomization.disableAnimation", false);
michael@0:     deferred.resolve();
michael@0:   }
michael@0:   aWindow.gNavToolbox.addEventListener("customizationready", onCustomizing);
michael@0:   aWindow.gCustomizeMode.enter();
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function openAndLoadWindow(aOptions, aWaitForDelayedStartup=false) {
michael@0:   let deferred = Promise.defer();
michael@0:   let win = OpenBrowserWindow(aOptions);
michael@0:   if (aWaitForDelayedStartup) {
michael@0:     Services.obs.addObserver(function onDS(aSubject, aTopic, aData) {
michael@0:       if (aSubject != win) {
michael@0:         return;
michael@0:       }
michael@0:       Services.obs.removeObserver(onDS, "browser-delayed-startup-finished");
michael@0:       deferred.resolve(win);
michael@0:     }, "browser-delayed-startup-finished", false);
michael@0: 
michael@0:   } else {
michael@0:     win.addEventListener("load", function onLoad() {
michael@0:       win.removeEventListener("load", onLoad);
michael@0:       deferred.resolve(win);
michael@0:     });
michael@0:   }
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function promiseWindowClosed(win) {
michael@0:   let deferred = Promise.defer();
michael@0:   win.addEventListener("unload", function onunload() {
michael@0:     win.removeEventListener("unload", onunload);
michael@0:     deferred.resolve();
michael@0:   });
michael@0:   win.close();
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function promisePanelShown(win) {
michael@0:   let panelEl = win.PanelUI.panel;
michael@0:   return promisePanelElementShown(win, panelEl);
michael@0: }
michael@0: 
michael@0: function promiseOverflowShown(win) {
michael@0:   let panelEl = win.document.getElementById("widget-overflow");
michael@0:   return promisePanelElementShown(win, panelEl);
michael@0: }
michael@0: 
michael@0: function promisePanelElementShown(win, aPanel) {
michael@0:   let deferred = Promise.defer();
michael@0:   let timeoutId = win.setTimeout(() => {
michael@0:     deferred.reject("Panel did not show within 20 seconds.");
michael@0:   }, 20000);
michael@0:   function onPanelOpen(e) {
michael@0:     aPanel.removeEventListener("popupshown", onPanelOpen);
michael@0:     win.clearTimeout(timeoutId);
michael@0:     deferred.resolve();
michael@0:   };
michael@0:   aPanel.addEventListener("popupshown", onPanelOpen);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function promisePanelHidden(win) {
michael@0:   let panelEl = win.PanelUI.panel;
michael@0:   return promisePanelElementHidden(win, panelEl);
michael@0: }
michael@0: 
michael@0: function promiseOverflowHidden(win) {
michael@0:   let panelEl = document.getElementById("widget-overflow");
michael@0:   return promisePanelElementHidden(win, panelEl);
michael@0: }
michael@0: 
michael@0: function promisePanelElementHidden(win, aPanel) {
michael@0:   let deferred = Promise.defer();
michael@0:   let timeoutId = win.setTimeout(() => {
michael@0:     deferred.reject("Panel did not hide within 20 seconds.");
michael@0:   }, 20000);
michael@0:   function onPanelClose(e) {
michael@0:     aPanel.removeEventListener("popuphidden", onPanelClose);
michael@0:     win.clearTimeout(timeoutId);
michael@0:     deferred.resolve();
michael@0:   }
michael@0:   aPanel.addEventListener("popuphidden", onPanelClose);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function isPanelUIOpen() {
michael@0:   return PanelUI.panel.state == "open" || PanelUI.panel.state == "showing";
michael@0: }
michael@0: 
michael@0: function subviewShown(aSubview) {
michael@0:   let deferred = Promise.defer();
michael@0:   let win = aSubview.ownerDocument.defaultView;
michael@0:   let timeoutId = win.setTimeout(() => {
michael@0:     deferred.reject("Subview (" + aSubview.id + ") did not show within 20 seconds.");
michael@0:   }, 20000);
michael@0:   function onViewShowing(e) {
michael@0:     aSubview.removeEventListener("ViewShowing", onViewShowing);
michael@0:     win.clearTimeout(timeoutId);
michael@0:     deferred.resolve();
michael@0:   };
michael@0:   aSubview.addEventListener("ViewShowing", onViewShowing);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function subviewHidden(aSubview) {
michael@0:   let deferred = Promise.defer();
michael@0:   let win = aSubview.ownerDocument.defaultView;
michael@0:   let timeoutId = win.setTimeout(() => {
michael@0:     deferred.reject("Subview (" + aSubview.id + ") did not hide within 20 seconds.");
michael@0:   }, 20000);
michael@0:   function onViewHiding(e) {
michael@0:     aSubview.removeEventListener("ViewHiding", onViewHiding);
michael@0:     win.clearTimeout(timeoutId);
michael@0:     deferred.resolve();
michael@0:   };
michael@0:   aSubview.addEventListener("ViewHiding", onViewHiding);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function waitForCondition(aConditionFn, aMaxTries=50, aCheckInterval=100) {
michael@0:   function tryNow() {
michael@0:     tries++;
michael@0:     if (aConditionFn()) {
michael@0:       deferred.resolve();
michael@0:     } else if (tries < aMaxTries) {
michael@0:       tryAgain();
michael@0:     } else {
michael@0:       deferred.reject("Condition timed out: " + aConditionFn.toSource());
michael@0:     }
michael@0:   }
michael@0:   function tryAgain() {
michael@0:     setTimeout(tryNow, aCheckInterval);
michael@0:   }
michael@0:   let deferred = Promise.defer();
michael@0:   let tries = 0;
michael@0:   tryAgain();
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function waitFor(aTimeout=100) {
michael@0:   let deferred = Promise.defer();
michael@0:   setTimeout(function() deferred.resolve(), aTimeout);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Starts a load in an existing tab and waits for it to finish (via some event).
michael@0:  *
michael@0:  * @param aTab       The tab to load into.
michael@0:  * @param aUrl       The url to load.
michael@0:  * @param aEventType The load event type to wait for.  Defaults to "load".
michael@0:  * @return {Promise} resolved when the event is handled.
michael@0:  */
michael@0: function promiseTabLoadEvent(aTab, aURL, aEventType="load") {
michael@0:   let deferred = Promise.defer();
michael@0:   info("Wait for tab event: " + aEventType);
michael@0: 
michael@0:   let timeoutId = setTimeout(() => {
michael@0:     aTab.linkedBrowser.removeEventListener(aEventType, onTabLoad, true);
michael@0:     deferred.reject("TabSelect did not happen within " + kTabEventFailureTimeoutInMs + "ms");
michael@0:   }, kTabEventFailureTimeoutInMs);
michael@0: 
michael@0:   function onTabLoad(event) {
michael@0:     if (event.originalTarget != aTab.linkedBrowser.contentDocument ||
michael@0:         event.target.location.href == "about:blank") {
michael@0:       info("skipping spurious load event");
michael@0:       return;
michael@0:     }
michael@0:     clearTimeout(timeoutId);
michael@0:     aTab.linkedBrowser.removeEventListener(aEventType, onTabLoad, true);
michael@0:     info("Tab event received: " + aEventType);
michael@0:     deferred.resolve();
michael@0:   }
michael@0:   aTab.linkedBrowser.addEventListener(aEventType, onTabLoad, true, true);
michael@0:   aTab.linkedBrowser.loadURI(aURL);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Navigate back or forward in tab history and wait for it to finish.
michael@0:  *
michael@0:  * @param aDirection   Number to indicate to move backward or forward in history.
michael@0:  * @param aConditionFn Function that returns the result of an evaluated condition
michael@0:  *                     that needs to be `true` to resolve the promise.
michael@0:  * @return {Promise} resolved when navigation has finished.
michael@0:  */
michael@0: function promiseTabHistoryNavigation(aDirection = -1, aConditionFn) {
michael@0:   let deferred = Promise.defer();
michael@0: 
michael@0:   let timeoutId = setTimeout(() => {
michael@0:     gBrowser.removeEventListener("pageshow", listener, true);
michael@0:     deferred.reject("Pageshow did not happen within " + kTabEventFailureTimeoutInMs + "ms");
michael@0:   }, kTabEventFailureTimeoutInMs);
michael@0: 
michael@0:   function listener(event) {
michael@0:     gBrowser.removeEventListener("pageshow", listener, true);
michael@0:     clearTimeout(timeoutId);
michael@0: 
michael@0:     if (aConditionFn) {
michael@0:       waitForCondition(aConditionFn).then(() => deferred.resolve(),
michael@0:                                           aReason => deferred.reject(aReason));
michael@0:     } else {
michael@0:       deferred.resolve();
michael@0:     }
michael@0:   }
michael@0:   gBrowser.addEventListener("pageshow", listener, true);
michael@0: 
michael@0:   content.history.go(aDirection);
michael@0: 
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: function popupShown(aPopup) {
michael@0:   return promisePopupEvent(aPopup, "shown");
michael@0: }
michael@0: 
michael@0: function popupHidden(aPopup) {
michael@0:   return promisePopupEvent(aPopup, "hidden");
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Returns a Promise that resolves when aPopup fires an event of type
michael@0:  * aEventType. Times out and rejects after 20 seconds.
michael@0:  *
michael@0:  * @param aPopup the popup to monitor for events.
michael@0:  * @param aEventSuffix the _suffix_ for the popup event type to watch for.
michael@0:  *
michael@0:  * Example usage:
michael@0:  *   let popupShownPromise = promisePopupEvent(somePopup, "shown");
michael@0:  *   // ... something that opens a popup
michael@0:  *   yield popupShownPromise;
michael@0:  *
michael@0:  *  let popupHiddenPromise = promisePopupEvent(somePopup, "hidden");
michael@0:  *  // ... something that hides a popup
michael@0:  *  yield popupHiddenPromise;
michael@0:  */
michael@0: function promisePopupEvent(aPopup, aEventSuffix) {
michael@0:   let deferred = Promise.defer();
michael@0:   let win = aPopup.ownerDocument.defaultView;
michael@0:   let eventType = "popup" + aEventSuffix;
michael@0: 
michael@0:   let timeoutId = win.setTimeout(() => {
michael@0:     deferred.reject("Context menu (" + aPopup.id + ") did not fire "
michael@0:                     + eventType + " within 20 seconds.");
michael@0:   }, 20000);
michael@0: 
michael@0:   function onPopupEvent(e) {
michael@0:     win.clearTimeout(timeoutId);
michael@0:     aPopup.removeEventListener(eventType, onPopupEvent);
michael@0:     deferred.resolve();
michael@0:   };
michael@0: 
michael@0:   aPopup.addEventListener(eventType, onPopupEvent);
michael@0:   return deferred.promise;
michael@0: }
michael@0: 
michael@0: // This is a simpler version of the context menu check that
michael@0: // exists in contextmenu_common.js.
michael@0: function checkContextMenu(aContextMenu, aExpectedEntries, aWindow=window) {
michael@0:   let childNodes = aContextMenu.childNodes;
michael@0:   for (let i = 0; i < childNodes.length; i++) {
michael@0:     let menuitem = childNodes[i];
michael@0:     try {
michael@0:       if (aExpectedEntries[i][0] == "---") {
michael@0:         is(menuitem.localName, "menuseparator", "menuseparator expected");
michael@0:         continue;
michael@0:       }
michael@0: 
michael@0:       let selector = aExpectedEntries[i][0];
michael@0:       ok(menuitem.mozMatchesSelector(selector), "menuitem should match " + selector + " selector");
michael@0:       let commandValue = menuitem.getAttribute("command");
michael@0:       let relatedCommand = commandValue ? aWindow.document.getElementById(commandValue) : null;
michael@0:       let menuItemDisabled = relatedCommand ?
michael@0:                                relatedCommand.getAttribute("disabled") == "true" :
michael@0:                                menuitem.getAttribute("disabled") == "true";
michael@0:       is(menuItemDisabled, !aExpectedEntries[i][1], "disabled state for " + selector);
michael@0:     } catch (e) {
michael@0:       ok(false, "Exception when checking context menu: " + e);
michael@0:     }
michael@0:   }
michael@0: }