/* 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/. */
'use strict';
const { Loader, LoaderWithHookedConsole } = require("sdk/test/loader");
const { browserWindows } = require('sdk/windows');
const tabs = require('sdk/tabs');
const { isPrivate } = require('sdk/private-browsing');
const { openDialog } = require('sdk/window/utils');
const { isWindowPrivate } = require('sdk/window/utils');
const { setTimeout } = require('sdk/timers');
const { openWebpage } = require('./private-browsing/helper');
const { isTabPBSupported, isWindowPBSupported } = require('sdk/private-browsing/utils');
const app = require("sdk/system/xul-app");
const URL = 'data:text/html;charset=utf-8,#title#';
// TEST: tab count
exports.testTabCounts = function(test) {
test.waitUntilDone();
tabs.open({
url: 'about:blank',
onReady: function(tab) {
let count1 = 0,
count2 = 0;
for each(let window in browserWindows) {
count1 += window.tabs.length;
for each(let tab in window.tabs) {
count2 += 1;
}
}
test.assert(tabs.length > 1, 'tab count is > 1');
test.assertEqual(count1, tabs.length, 'tab count by length is correct');
test.assertEqual(count2, tabs.length, 'tab count by iteration is correct');
// end test
tab.close(function() test.done());
}
});
};
// TEST: tabs.activeTab getter
exports.testActiveTab_getter = function(test) {
test.waitUntilDone();
let evtCount = 0;
let activeTab = null;
function endTest(type, tab) {
if (type == 'activate') {
test.assertStrictEqual(tabs.activeTab, tab, 'the active tab is the opened tab');
activeTab = tabs.activeTab;
}
else {
test.assertEqual(tab.url, url, 'the opened tab has the correct url');
}
if (++evtCount != 2)
return;
test.assertStrictEqual(activeTab, tab, 'the active tab is the ready tab');
test.assertStrictEqual(tabs.activeTab, tab, 'the active tab is the ready tab');
tab.close(function() {
// end test
test.done();
});
}
let url = URL.replace("#title#", "testActiveTab_getter");
tabs.open({
url: url,
onReady: endTest.bind(null, 'ready'),
onActivate: endTest.bind(null, 'activate')
});
};
// TEST: tab.activate()
exports.testActiveTab_setter = function(test) {
test.waitUntilDone();
let url = URL.replace("#title#", "testActiveTab_setter");
let tab1URL = URL.replace("#title#", "tab1");
tabs.open({
url: tab1URL,
onReady: function(activeTab) {
let activeTabURL = tabs.activeTab.url;
tabs.open({
url: url,
inBackground: true,
onReady: function onReady(tab) {
test.assertEqual(tabs.activeTab.url, activeTabURL, "activeTab url has not changed");
test.assertEqual(tab.url, url, "url of new background tab matches");
tab.once('activate', function onActivate(eventTab) {
test.assertEqual(tabs.activeTab.url, url, "url after activeTab setter matches");
test.assertEqual(eventTab, tab, "event argument is the activated tab");
test.assertEqual(eventTab, tabs.activeTab, "the tab is the active one");
activeTab.close(function() {
tab.close(function() {
// end test
test.done();
});
});
});
tab.activate();
}
});
}
});
};
// TEST: tab.close()
exports.testTabClose_alt = function(test) {
test.waitUntilDone();
let url = URL.replace('#title#', 'TabClose_alt');
let tab1URL = URL.replace('#title#', 'tab1');
tabs.open({
url: tab1URL,
onReady: function(tab1) {
// make sure that our tab is not active first
test.assertNotEqual(tabs.activeTab.url, url, "tab is not the active tab");
tabs.open({
url: url,
onReady: function(tab) {
test.assertEqual(tab.url, url, "tab is now the active tab");
test.assertEqual(tabs.activeTab.url, url, "tab is now the active tab");
// another tab should be activated on close
tabs.once('activate', function() {
test.assertNotEqual(tabs.activeTab.url, url, "tab is no longer the active tab");
// end test
tab1.close(function() test.done());
});
tab.close();
}
});
}
});
};
exports.testAttachOnOpen_alt = function (test) {
// Take care that attach has to be called on tab ready and not on tab open.
test.waitUntilDone();
tabs.open({
url: "data:text/html;charset=utf-8,foobar",
onOpen: function (tab) {
let worker = tab.attach({
contentScript: 'self.postMessage(document.location.href); ',
onMessage: function (msg) {
test.assertEqual(msg, "about:blank",
"Worker document url is about:blank on open");
worker.destroy();
tab.close(function() test.done());
}
});
}
});
};
exports.testAttachOnMultipleDocuments_alt = function (test) {
// Example of attach that process multiple tab documents
test.waitUntilDone();
let firstLocation = "data:text/html;charset=utf-8,foobar";
let secondLocation = "data:text/html;charset=utf-8,bar";
let thirdLocation = "data:text/html;charset=utf-8,fox";
let onReadyCount = 0;
let worker1 = null;
let worker2 = null;
let detachEventCount = 0;
tabs.open({
url: firstLocation,
onReady: function (tab) {
onReadyCount++;
if (onReadyCount == 1) {
worker1 = tab.attach({
contentScript: 'self.on("message", ' +
' function () self.postMessage(document.location.href)' +
');',
onMessage: function (msg) {
test.assertEqual(msg, firstLocation,
"Worker url is equal to the 1st document");
tab.url = secondLocation;
},
onDetach: function () {
detachEventCount++;
test.pass("Got worker1 detach event");
test.assertRaises(function () {
worker1.postMessage("ex-1");
},
/Couldn't find the worker/,
"postMessage throw because worker1 is destroyed");
checkEnd();
}
});
worker1.postMessage("new-doc-1");
}
else if (onReadyCount == 2) {
worker2 = tab.attach({
contentScript: 'self.on("message", ' +
' function () self.postMessage(document.location.href)' +
');',
onMessage: function (msg) {
test.assertEqual(msg, secondLocation,
"Worker url is equal to the 2nd document");
tab.url = thirdLocation;
},
onDetach: function () {
detachEventCount++;
test.pass("Got worker2 detach event");
test.assertRaises(function () {
worker2.postMessage("ex-2");
},
/Couldn't find the worker/,
"postMessage throw because worker2 is destroyed");
checkEnd(tab);
}
});
worker2.postMessage("new-doc-2");
}
else if (onReadyCount == 3) {
tab.close();
}
}
});
function checkEnd(tab) {
if (detachEventCount != 2)
return;
test.pass("Got all detach events");
// end test
test.done();
}
};
exports.testAttachWrappers_alt = function (test) {
// Check that content script has access to wrapped values by default
test.waitUntilDone();
let document = "data:text/html;charset=utf-8,";
let count = 0;
tabs.open({
url: document,
onReady: function (tab) {
let worker = tab.attach({
contentScript: 'try {' +
' self.postMessage(!("globalJSVar" in window));' +
' self.postMessage(typeof window.globalJSVar == "undefined");' +
'} catch(e) {' +
' self.postMessage(e.message);' +
'}',
onMessage: function (msg) {
test.assertEqual(msg, true, "Worker has wrapped objects ("+count+")");
if (count++ == 1)
tab.close(function() test.done());
}
});
}
});
};
// TEST: activeWindow getter and activeTab getter on tab 'activate' event
exports.testActiveWindowActiveTabOnActivate_alt = function(test) {
test.waitUntilDone();
let activateCount = 0;
let newTabs = [];
let tabs = browserWindows.activeWindow.tabs;
tabs.on('activate', function onActivate(tab) {
test.assertEqual(tabs.activeTab, tab,
"the active window's active tab is the tab provided");
if (++activateCount == 2) {
tabs.removeListener('activate', onActivate);
newTabs.forEach(function(tab) {
tab.close(function() {
if (--activateCount == 0) {
// end test
test.done();
}
});
});
}
else if (activateCount > 2) {
test.fail("activateCount is greater than 2 for some reason..");
}
});
tabs.open({
url: URL.replace("#title#", "tabs.open1"),
onOpen: function(tab) newTabs.push(tab)
});
tabs.open({
url: URL.replace("#title#", "tabs.open2"),
onOpen: function(tab) newTabs.push(tab)
});
};
// TEST: tab properties
exports.testTabContentTypeAndReload = function(test) {
test.waitUntilDone();
let url = "data:text/html;charset=utf-8,foofoo";
let urlXML = "data:text/xml;charset=utf-8,bar";
tabs.open({
url: url,
onReady: function(tab) {
if (tab.url === url) {
test.assertEqual(tab.contentType, "text/html");
tab.url = urlXML;
}
else {
test.assertEqual(tab.contentType, "text/xml");
tab.close(function() {
test.done();
});
}
}
});
};
// test that it isn't possible to open a private tab without the private permission
exports.testTabOpenPrivate = function(test) {
test.waitUntilDone();
let url = 'about:blank';
tabs.open({
url: url,
isPrivate: true,
onReady: function(tab) {
test.assertEqual(tab.url, url, 'opened correct tab');
test.assertEqual(isPrivate(tab), false, 'private tabs are not supported by default');
tab.close(function() {
test.done();
});
}
});
}
// We need permission flag in order to see private window's tabs
exports.testPrivateAreNotListed = function (test) {
let originalTabCount = tabs.length;
let page = openWebpage("about:blank", true);
if (!page) {
test.pass("Private browsing isn't supported in this release");
return;
}
test.waitUntilDone();
page.ready.then(function (win) {
if (isTabPBSupported || isWindowPBSupported) {
test.assert(isWindowPrivate(win), "the window is private");
test.assertEqual(tabs.length, originalTabCount,
'but the tab is *not* visible in tabs list');
}
else {
test.assert(!isWindowPrivate(win), "the window isn't private");
test.assertEqual(tabs.length, originalTabCount + 1,
'so that the tab is visible is tabs list');
}
page.close().then(test.done.bind(test));
});
}
// If we close the tab while being in `onOpen` listener,
// we end up synchronously consuming TabOpen, closing the tab and still
// synchronously consuming the related TabClose event before the second
// loader have a change to process the first TabOpen event!
exports.testImmediateClosing = function (test) {
test.waitUntilDone();
let tabURL = 'data:text/html,foo';
let { loader, messages } = LoaderWithHookedConsole(module, onMessage);
let concurrentTabs = loader.require("sdk/tabs");
concurrentTabs.on("open", function (tab) {
// On Firefox, It shouldn't receive such event as the other loader will just
// open and destroy the tab without giving a chance to other loader to even
// know about the existance of this tab.
if (app.is("Firefox")) {
test.fail("Concurrent loader received a tabs `open` event");
}
else {
// On mobile, we can still receive an open event,
// but not the related ready event
tab.on("ready", function () {
test.fail("Concurrent loader received a tabs `ready` event");
});
}
});
function onMessage(type, msg) {
test.fail("Unexpected mesage on concurrent loader: " + msg);
}
tabs.open({
url: tabURL,
onOpen: function(tab) {
tab.close(function () {
test.pass("Tab succesfully removed");
// Let a chance to the concurrent loader to receive a TabOpen event
// on the next event loop turn
setTimeout(function () {
loader.unload();
test.done();
}, 0);
});
}
});
}
// TEST: tab.reload()
exports.testTabReload = function(test) {
test.waitUntilDone();
let url = "data:text/html;charset=utf-8,";
tabs.open({
url: url,
onReady: function onReady(tab) {
tab.removeListener('ready', onReady);
tab.once(
'ready',
function onReload() {
test.pass("the tab was loaded again");
test.assertEqual(tab.url, url, "the tab has the same URL");
// end test
tab.close(function() test.done());
}
);
tab.reload();
}
});
};
exports.testOnPageShowEvent = function (test) {
test.waitUntilDone();
let events = [];
let firstUrl = 'data:text/html;charset=utf-8,First';
let secondUrl = 'data:text/html;charset=utf-8,Second';
let counter = 0;
function onPageShow (tab, persisted) {
events.push('pageshow');
counter++;
if (counter === 1) {
test.assertEqual(persisted, false, 'page should not be cached on initial load');
tab.url = secondUrl;
}
else if (counter === 2) {
test.assertEqual(persisted, false, 'second test page should not be cached either');
tab.attach({
contentScript: 'setTimeout(function () { window.history.back(); }, 0)'
});
}
else {
test.assertEqual(persisted, true, 'when we get back to the fist page, it has to' +
'come from cache');
tabs.removeListener('pageshow', onPageShow);
tabs.removeListener('open', onOpen);
tabs.removeListener('ready', onReady);
tab.close(() => {
['open', 'ready', 'pageshow', 'ready',
'pageshow', 'pageshow'].map((type, i) => {
test.assertEqual(type, events[i], 'correct ordering of events');
});
test.done()
});
}
}
function onOpen () events.push('open');
function onReady () events.push('ready');
tabs.on('pageshow', onPageShow);
tabs.on('open', onOpen);
tabs.on('ready', onReady);
tabs.open({
url: firstUrl
});
};
exports.testOnPageShowEventDeclarative = function (test) {
test.waitUntilDone();
let events = [];
let firstUrl = 'data:text/html;charset=utf-8,First';
let secondUrl = 'data:text/html;charset=utf-8,Second';
let counter = 0;
function onPageShow (tab, persisted) {
events.push('pageshow');
counter++;
if (counter === 1) {
test.assertEqual(persisted, false, 'page should not be cached on initial load');
tab.url = secondUrl;
}
else if (counter === 2) {
test.assertEqual(persisted, false, 'second test page should not be cached either');
tab.attach({
contentScript: 'setTimeout(function () { window.history.back(); }, 0)'
});
}
else {
test.assertEqual(persisted, true, 'when we get back to the fist page, it has to' +
'come from cache');
tabs.removeListener('pageshow', onPageShow);
tabs.removeListener('open', onOpen);
tabs.removeListener('ready', onReady);
tab.close(() => {
['open', 'ready', 'pageshow', 'ready',
'pageshow', 'pageshow'].map((type, i) => {
test.assertEqual(type, events[i], 'correct ordering of events');
});
test.done()
});
}
}
function onOpen () events.push('open');
function onReady () events.push('ready');
tabs.open({
url: firstUrl,
onPageShow: onPageShow,
onOpen: onOpen,
onReady: onReady
});
};