Revision control
Copy as Markdown
Other Tools
/* 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
/**
* Checks that restoring the last browser window in session is actually
* working:
* 1.1) Open a new browser window
* 1.2) Add some tabs
* 1.3) Close that window
* 1.4) Opening another window
* --> State is restored
*
* 2.1) Open a new browser window
* 2.2) Add some tabs
* 2.4) Open some popups
* 2.5) Add another tab to one popup (so that it gets stored) and close it again
* 2.5) Close the browser window
* 2.6) Open another browser window
* --> State of the closed browser window, but not of the popup, is restored
*
* 3.1) Open a popup
* 3.2) Add another tab to the popup (so that it gets stored) and close it again
* 3.3) Open a window
* --> Nothing at all should be restored
*
* 4.1) Open two browser windows and close them again
* 4.2) undoCloseWindow() one
* 4.3) Open another browser window
* --> Nothing at all should be restored
*
* Checks the new notifications are correctly posted and processed, that is
* for each successful -requested a -granted is received, but omitted if
* -requested was cnceled
* Said notifications are:
* - browser-lastwindow-close-requested
* - browser-lastwindow-close-granted
* Tests are:
* 5) Cancel closing when first observe a -requested
* --> Window is kept open
* 6) Count the number of notifications
* --> count(-requested) == count(-granted) + 1
* --> (The first -requested was canceled, so off-by-one)
* 7) (Mac only) Mac version of Test 5 additionally preparing Test 6
*
* @note It is implicitly tested that restoring the last window works when
* non-browser windows are around. The "Run Tests" window as well as the main
* browser window (wherein the test code gets executed) won't be considered
* browser windows. To achiveve this said main browser window has it's windowtype
* attribute modified so that it's not considered a browser window any longer.
* This is crucial, because otherwise there would be two browser windows around,
* said main test window and the one opened by the tests, and hence the new
* logic wouldn't be executed at all.
* @note Mac only tests the new notifications, as restoring the last window is
* not enabled on that platform (platform shim; the application is kept running
* although there are no windows left)
* @note There is a difference when closing a browser window with
* BrowserTryToCloseWindow() as opposed to close(). The former will make
* nsSessionStore restore a window next time it gets a chance and will post
* notifications. The latter won't.
*/
function browserWindowsCount(expected, msg) {
if (typeof expected == "number")
expected = [expected, expected];
let count = 0;
let e = Services.wm.getEnumerator("navigator:browser");
while (e.hasMoreElements()) {
if (!e.getNext().closed)
++count;
}
is(count, expected[0], msg + " (nsIWindowMediator)");
let state = Cc["@mozilla.org/suite/sessionstore;1"]
.getService(Ci.nsISessionStore)
.getBrowserState();
is(JSON.parse(state).windows.length, expected[1], msg + " (getBrowserState)");
}
function test() {
browserWindowsCount(1, "Only one browser window should be open initially");
if (AppConstants.platform == "macosx") {
return;
}
waitForExplicitFinish();
// This test takes some time to run, and it could timeout randomly.
requestLongerTimeout(2);
// Some urls that might be opened in tabs and/or popups
// Do not use about:blank:
// That one is reserved for special purposes in the tests
const TEST_URLS = ["about:mozilla", "about:buildconfig"];
// Number of -request notifications to except
// remember to adjust when adding new tests
const NOTIFICATIONS_EXPECTED = 4;
// Window features of popup windows
const POPUP_FEATURES = "toolbar=no,resizable=no,status=no";
// Window features of browser windows
const CHROME_FEATURES = "chrome,all,dialog=no";
// Store the old window type for cleanup
var oldWinType = "";
// Store the old tabs.warnOnClose pref so that we may reset it during
// cleanup
var oldWarnTabsOnClose = Services.prefs.getBoolPref("browser.tabs.warnOnClose");
// Observe these, and also use to count the number of hits
var observing = {
"browser-lastwindow-close-requested": 0,
"browser-lastwindow-close-granted": 0
};
/**
* Helper: Will observe and handle the notifications for us
*/
var observer = {
hitCount: 0,
observe: function(aCancel, aTopic, aData) {
// count so that we later may compare
observing[aTopic]++;
// handle some tests
if (++this.hitCount == 1) {
// Test 6
aCancel.QueryInterface(Ci.nsISupportsPRBool).data = true;
}
}
};
/**
* Helper: Sets prefs as the testsuite requires
* @note Will be reset in cleanTestSuite just before finishing the tests
*/
function setPrefs() {
Services.prefs.setIntPref("browser.startup.page", 3);
Services.prefs.setBoolPref("browser.tabs.warnOnClose", false);
}
/**
* Helper: Sets up this testsuite
*/
function setupTestsuite(testFn) {
// Register our observers
for (let o in observing)
Services.obs.addObserver(observer, o);
// Make the main test window not count as a browser window any longer
oldWinType = document.documentElement.getAttribute("windowtype");
document.documentElement.setAttribute("windowtype", "navigator:testrunner");
}
/**
* Helper: Cleans up behind the testsuite
*/
function cleanupTestsuite(callback) {
// Finally remove observers again
for (let o in observing)
Services.obs.removeObserver(observer, o, false);
// Reset the prefs we touched
for (let pref of [
"browser.startup.page"
]) {
if (Services.prefs.prefHasUserValue(pref))
Services.prefs.clearUserPref(pref);
}
Services.prefs.setBoolPref("browser.tabs.warnOnClose", oldWarnTabsOnClose);
// Reset the window type
document.documentElement.setAttribute("windowtype", oldWinType);
}
/**
* Helper: sets the prefs and a new window with our test tabs
*/
function setupTestAndRun(testFn) {
// Prepare the prefs
setPrefs();
// Prepare a window; open it and add more tabs
let newWin = openDialog(location, "_blank", CHROME_FEATURES, "about:config");
newWin.addEventListener("load", function loadListener1(aEvent) {
newWin.removeEventListener("load", loadListener1);
newWin.getBrowser().addEventListener("pageshow", function pageshowListener2(aEvent) {
newWin.getBrowser().removeEventListener("pageshow", pageshowListener2, true);
for (let url of TEST_URLS) {
newWin.getBrowser().addTab(url);
}
executeSoon(() => testFn(newWin));
}, true);
});
}
/**
* Test 1: Normal in-session restore
* @note: Non-Mac only
*/
function testOpenCloseNormal(nextFn) {
setupTestAndRun(function(newWin) {
// Close the window
// window.close doesn't push any close events,
// so use BrowserTryToCloseWindow
newWin.BrowserTryToCloseWindow();
// The first request to close is denied by our observer (Test 6)
ok(!newWin.closed, "First close request was denied");
if (!newWin.closed) {
newWin.BrowserTryToCloseWindow();
ok(newWin.closed, "Second close request was granted");
}
// Open a new window
// The previously closed window should be restored
newWin = openDialog(location, "_blank", CHROME_FEATURES, "about:blank");
newWin.addEventListener("load", function loadListener3() {
newWin.removeEventListener("load", loadListener3);
executeSoon(function() {
is(newWin.getBrowser().browsers.length, TEST_URLS.length + 1,
"Restored window in-session with otherpopup windows around");
// Cleanup
newWin.close();
// Next please
executeSoon(nextFn);
});
}, true);
});
}
/**
* Test 2: Open some popup windows to check those aren't restored, but
* the browser window is
* @note: Non-Mac only
*/
function testOpenCloseWindowAndPopup(nextFn) {
setupTestAndRun(function(newWin) {
// open some popups
let popup = openDialog(location, "popup", POPUP_FEATURES, TEST_URLS[0]);
let popup2 = openDialog(location, "popup2", POPUP_FEATURES, TEST_URLS[1]);
popup2.addEventListener("load", function loadListener4() {
popup2.removeEventListener("load", loadListener4);
popup2.getBrowser().addEventListener("pageshow", function pageshowListener5() {
popup2.getBrowser().removeEventListener("pageshow", pageshowListener5, true);
popup2.getBrowser().addTab(TEST_URLS[0]);
// close the window
newWin.BrowserTryToCloseWindow();
// Close the popup window
// The test is successful when not this popup window is restored
// but instead newWin
popup2.close();
// open a new window the previously closed window should be restored to
newWin = openDialog(location, "_blank", CHROME_FEATURES, "about:blank");
newWin.addEventListener("load", function loadListener6() {
newWin.removeEventListener("load", loadListener6);
executeSoon(function() {
is(newWin.getBrowser().browsers.length, TEST_URLS.length + 1,
"Restored window and associated tabs in session");
// Cleanup
newWin.close();
popup.close();
// Next please
executeSoon(nextFn);
});
}, true);
}, true);
});
});
}
/**
* Test 3: Open some popup window to check it isn't restored.
* Instead nothing at all should be restored
* @note: Non-Mac only
*/
function testOpenCloseOnlyPopup(nextFn) {
// prepare the prefs
setPrefs();
// This will cause nsSessionStore to restore a window the next time it
// gets a chance.
let popup = openDialog(location, "popup", POPUP_FEATURES, TEST_URLS[1]);
popup.addEventListener("load", function loadListener7() {
popup.removeEventListener("load", loadListener7, true);
is(popup.getBrowser().browsers.length, 1,
"Did not restore the popup window (1)");
popup.BrowserTryToCloseWindow();
// Real tests
popup = openDialog(location, "popup", POPUP_FEATURES, TEST_URLS[1]);
popup.addEventListener("load", function loadListener8() {
popup.removeEventListener("load", loadListener8);
popup.getBrowser().addEventListener("pageshow", function pageshowListener9() {
popup.getBrowser().removeEventListener("pageshow", pageshowListener9, true);
popup.getBrowser().addTab(TEST_URLS[0]);
is(popup.getBrowser().browsers.length, 2,
"Did not restore to the popup window (2)");
// Close the popup window
// The test is successful when not this popup window is restored
// but instead a new window is opened without restoring anything
popup.close();
let newWin = openDialog(location, "_blank", CHROME_FEATURES, "about:blank");
newWin.addEventListener("load", function loadListener10() {
newWin.removeEventListener("load", loadListener10, true);
executeSoon(function() {
isnot(newWin.getBrowser().browsers.length, 2,
"Did not restore the popup window");
is(TEST_URLS.indexOf(newWin.getBrowser().browsers[0].currentURI.spec), -1,
"Did not restore the popup window (2)");
// Cleanup
newWin.close();
// Next please
executeSoon(nextFn);
});
}, true);
}, true);
});
}, true);
}
/**
* Test 4: Open some windows and do undoCloseWindow. This should prevent any
* restoring later in the test
* @note: Non-Mac only
*/
function testOpenCloseRestoreFromPopup(nextFn) {
setupTestAndRun(function(newWin) {
setupTestAndRun(function(newWin2) {
newWin.BrowserTryToCloseWindow();
newWin2.BrowserTryToCloseWindow();
browserWindowsCount([0, 1], "browser windows while running testOpenCloseRestoreFromPopup");
newWin = undoCloseWindow(0);
newWin2 = openDialog(location, "_blank", CHROME_FEATURES, "about:blank");
newWin2.addEventListener("load", function loadListener11() {
newWin2.removeEventListener("load", loadListener11, true);
executeSoon(function() {
is(newWin2.getBrowser().browsers.length, 1,
"Did not restore, as undoCloseWindow() was last called");
is(TEST_URLS.indexOf(newWin2.getBrowser().browsers[0].currentURI.spec), -1,
"Did not restore, as undoCloseWindow() was last called (2)");
browserWindowsCount([2, 3], "browser windows while running testOpenCloseRestoreFromPopup");
// Cleanup
newWin.close();
newWin2.close();
browserWindowsCount([0, 1], "browser windows while running testOpenCloseRestoreFromPopup");
// Next please
executeSoon(nextFn);
});
}, true);
});
});
}
/**
* Test 5: Check whether the right number of notifications was received during
* the tests
*/
function testNotificationCount(nextFn) {
is(observing["browser-lastwindow-close-requested"], NOTIFICATIONS_EXPECTED,
"browser-lastwindow-close-requested notifications observed");
// -request must be one more as we cancel the first one we hit,
// and hence won't produce a corresponding -grant
// @see observer.observe
is(observing["browser-lastwindow-close-requested"],
observing["browser-lastwindow-close-granted"] + 1,
"Notification count for -request and -grant matches");
executeSoon(nextFn);
}
/**
* Test 6: Test if closing can be denied on Mac
* Futhermore prepares the testNotificationCount test (Test 6)
* @note: Mac only
*/
function testMacNotifications(nextFn, iteration) {
iteration = iteration || 1;
setupTestAndRun(function(newWin) {
// close the window
// window.close doesn't push any close events,
// so use BrowserTryToCloseWindow
newWin.BrowserTryToCloseWindow();
if (iteration == 1) {
ok(!newWin.closed, "First close attempt denied");
if (!newWin.closed) {
newWin.BrowserTryToCloseWindow();
ok(newWin.closed, "Second close attempt granted");
}
}
if (iteration < NOTIFICATIONS_EXPECTED - 1) {
executeSoon(() => testMacNotifications(nextFn, ++iteration));
}
else {
executeSoon(nextFn);
}
});
}
// Execution starts here
setupTestsuite();
if (AppConstants.platform == "macosx") {
// Mac tests
testMacNotifications(function () {
testNotificationCount(function () {
cleanupTestsuite();
browserWindowsCount(1, "Only one browser window should be open eventually");
finish();
});
});
}
else {
// Non-Mac Tests
testOpenCloseNormal(function () {
browserWindowsCount([0, 1], "browser windows after testOpenCloseNormal");
testOpenCloseWindowAndPopup(function () {
browserWindowsCount([0, 1], "browser windows after testOpenCloseWindowAndPopup");
testOpenCloseOnlyPopup(function () {
browserWindowsCount([0, 1], "browser windows after testOpenCloseOnlyPopup");
testOpenCloseRestoreFromPopup(function () {
browserWindowsCount([0, 1], "browser windows after testOpenCloseRestoreFromPopup");
testNotificationCount(function () {
cleanupTestsuite();
browserWindowsCount(1, "browser windows after testNotificationCount");
finish();
});
});
});
});
});
}
}