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: const { Loader } = require("sdk/test/loader");
michael@0: const utils = require("sdk/tabs/utils");
michael@0: const { open, close } = require("sdk/window/helpers");
michael@0: const { getMostRecentBrowserWindow } = require("sdk/window/utils");
michael@0: const { events } = require("sdk/tab/events");
michael@0: const { on, off } = require("sdk/event/core");
michael@0: const { resolve, defer } = require("sdk/core/promise");
michael@0: 
michael@0: let isFennec = require("sdk/system/xul-app").is("Fennec");
michael@0: 
michael@0: function test(options) {
michael@0:   return function(assert, done) {
michael@0:     let tabEvents = [];
michael@0:     let tabs = [];
michael@0:     let { promise, resolve: resolveP } = defer();
michael@0:     let win = isFennec ? resolve(getMostRecentBrowserWindow()) :
michael@0:       open(null, {
michael@0:         features: { private: true, toolbar:true, chrome: true }
michael@0:       });
michael@0:     let window = null;
michael@0: 
michael@0:     // Firefox events are fired sync; Fennec events async
michael@0:     // this normalizes the tests
michael@0:     function handler (event) {
michael@0:       tabEvents.push(event);
michael@0:       runIfReady();
michael@0:     }
michael@0: 
michael@0:     function runIfReady () {
michael@0:       let releventEvents = getRelatedEvents(tabEvents, tabs);
michael@0:       if (options.readyWhen(releventEvents))
michael@0:         options.end({
michael@0:           tabs: tabs,
michael@0:           events: releventEvents,
michael@0:           assert: assert,
michael@0:           done: resolveP
michael@0:         });
michael@0:     }
michael@0: 
michael@0:     win.then(function(w) {
michael@0:       window = w;
michael@0:       on(events, "data", handler);
michael@0:       options.start({ tabs: tabs, window: window });
michael@0: 
michael@0:       // Execute here for synchronous FF events, as the handlers
michael@0:       // were called before tabs were pushed to `tabs`
michael@0:       runIfReady(); 
michael@0:       return promise;
michael@0:     }).then(function() {
michael@0:       off(events, "data", handler);
michael@0:       return isFennec ? null : close(window);
michael@0:     }).then(done, assert.fail);
michael@0:   };
michael@0: }
michael@0: 
michael@0: // Just making sure that tab events work for already opened tabs not only
michael@0: // for new windows.
michael@0: exports["test current window"] = test({
michael@0:   readyWhen: events => events.length === 3,
michael@0:   start: ({ tabs, window }) => {
michael@0:     let tab = utils.openTab(window, 'data:text/plain,open');
michael@0:     tabs.push(tab);
michael@0:     utils.closeTab(tab);
michael@0:   },
michael@0:   end: ({ tabs, events, assert, done }) => {
michael@0:     let [open, select, close] = events;
michael@0:     let tab = tabs[0];
michael@0: 
michael@0:     assert.equal(open.type, "TabOpen");
michael@0:     assert.equal(open.target, tab);
michael@0: 
michael@0:     assert.equal(select.type, "TabSelect");
michael@0:     assert.equal(select.target, tab);
michael@0: 
michael@0:     assert.equal(close.type, "TabClose");
michael@0:     assert.equal(close.target, tab);
michael@0:     done();
michael@0:   }
michael@0: });
michael@0: 
michael@0: exports["test open"] = test({
michael@0:   readyWhen: events => events.length === 2,
michael@0:   start: ({ tabs, window }) => {
michael@0:     tabs.push(utils.openTab(window, 'data:text/plain,open'));
michael@0:   },
michael@0:   end: ({ tabs, events, assert, done }) => {
michael@0:     let [open, select] = events;
michael@0:     let tab = tabs[0];
michael@0: 
michael@0:     assert.equal(open.type, "TabOpen");
michael@0:     assert.equal(open.target, tab);
michael@0: 
michael@0:     assert.equal(select.type, "TabSelect");
michael@0:     assert.equal(select.target, tab);
michael@0:     done();
michael@0:   }
michael@0: });
michael@0: 
michael@0: exports["test open -> close"] = test({
michael@0:   readyWhen: events => events.length === 3,
michael@0:   start: ({ tabs, window }) => {
michael@0:     // First tab is useless we just open it so that closing second tab won't
michael@0:     // close window on some platforms.
michael@0:     utils.openTab(window, 'data:text/plain,ignore');
michael@0:     let tab = utils.openTab(window, 'data:text/plain,open-close');
michael@0:     tabs.push(tab);
michael@0:     utils.closeTab(tab);
michael@0:   },
michael@0:   end: ({ tabs, events, assert, done }) => {
michael@0:     let [open, select, close] = events;
michael@0:     let tab = tabs[0];
michael@0: 
michael@0:     assert.equal(open.type, "TabOpen");
michael@0:     assert.equal(open.target, tab);
michael@0: 
michael@0:     assert.equal(select.type, "TabSelect");
michael@0:     assert.equal(select.target, tab);
michael@0: 
michael@0:     assert.equal(close.type, "TabClose");
michael@0:     assert.equal(close.target, tab);
michael@0:     done();
michael@0:   }
michael@0: });
michael@0: 
michael@0: exports["test open -> open -> select"] = test({
michael@0:   readyWhen: events => events.length === 5,
michael@0:   start: ({tabs, window}) => {
michael@0:     tabs.push(utils.openTab(window, 'data:text/plain,Tab-1'));
michael@0:     tabs.push(utils.openTab(window, 'data:text/plain,Tab-2'));
michael@0:     utils.activateTab(tabs[0], window);
michael@0:   },
michael@0:   end: ({ tabs, events, assert, done }) => {
michael@0:     let [ tab1, tab2 ] = tabs;
michael@0:     let tab1Events = 0;
michael@0:     getRelatedEvents(events, tab1).map(event => {
michael@0:       tab1Events++;
michael@0:       if (tab1Events === 1)
michael@0:         assert.equal(event.type, "TabOpen", "first tab opened");
michael@0:       else
michael@0:         assert.equal(event.type, "TabSelect", "first tab selected");
michael@0:       assert.equal(event.target, tab1);
michael@0:     });
michael@0:     assert.equal(tab1Events, 3, "first tab has 3 events");
michael@0: 
michael@0:     let tab2Opened;
michael@0:     getRelatedEvents(events, tab2).map(event => {
michael@0:       if (!tab2Opened)
michael@0:         assert.equal(event.type, "TabOpen", "second tab opened");
michael@0:       else
michael@0:         assert.equal(event.type, "TabSelect", "second tab selected");
michael@0:       tab2Opened = true;
michael@0:       assert.equal(event.target, tab2);
michael@0:     });
michael@0:     done();
michael@0:   }
michael@0: });
michael@0: 
michael@0: exports["test open -> pin -> unpin"] = test({
michael@0:   readyWhen: events => events.length === (isFennec ? 2 : 5),
michael@0:   start: ({ tabs, window }) => {
michael@0:     tabs.push(utils.openTab(window, 'data:text/plain,pin-unpin'));
michael@0:     utils.pin(tabs[0]);
michael@0:     utils.unpin(tabs[0]);
michael@0:   },
michael@0:   end: ({ tabs, events, assert, done }) => {
michael@0:     let [open, select, move, pin, unpin] = events;
michael@0:     let tab = tabs[0];
michael@0: 
michael@0:     assert.equal(open.type, "TabOpen");
michael@0:     assert.equal(open.target, tab);
michael@0: 
michael@0:     assert.equal(select.type, "TabSelect");
michael@0:     assert.equal(select.target, tab);
michael@0: 
michael@0:     if (isFennec) {
michael@0:       assert.pass("Tab pin / unpin is not supported by Fennec");
michael@0:     }
michael@0:     else {
michael@0:       assert.equal(move.type, "TabMove");
michael@0:       assert.equal(move.target, tab);
michael@0: 
michael@0:       assert.equal(pin.type, "TabPinned");
michael@0:       assert.equal(pin.target, tab);
michael@0: 
michael@0:       assert.equal(unpin.type, "TabUnpinned");
michael@0:       assert.equal(unpin.target, tab);
michael@0:     }
michael@0:     done();
michael@0:   }
michael@0: });
michael@0: 
michael@0: exports["test open -> open -> move "] = test({
michael@0:   readyWhen: events => events.length === (isFennec ? 4 : 5),
michael@0:   start: ({tabs, window}) => {
michael@0:     tabs.push(utils.openTab(window, 'data:text/plain,Tab-1'));
michael@0:     tabs.push(utils.openTab(window, 'data:text/plain,Tab-2'));
michael@0:     utils.move(tabs[0], 2);
michael@0:   },
michael@0:   end: ({ tabs, events, assert, done }) => {
michael@0:     let [ tab1, tab2 ] = tabs;
michael@0:     let tab1Events = 0;
michael@0:     getRelatedEvents(events, tab1).map(event => {
michael@0:       tab1Events++;
michael@0:       if (tab1Events === 1)
michael@0:         assert.equal(event.type, "TabOpen", "first tab opened");
michael@0:       else if (tab1Events === 2)
michael@0:         assert.equal(event.type, "TabSelect", "first tab selected");
michael@0:       else if (tab1Events === 3 && isFennec)
michael@0:         assert.equal(event.type, "TabMove", "first tab moved");
michael@0:       assert.equal(event.target, tab1);
michael@0:     });
michael@0:     assert.equal(tab1Events, isFennec ? 2 : 3,
michael@0:       "correct number of events for first tab");
michael@0: 
michael@0:     let tab2Events = 0;
michael@0:     getRelatedEvents(events, tab2).map(event => {
michael@0:       tab2Events++;
michael@0:       if (tab2Events === 1)
michael@0:         assert.equal(event.type, "TabOpen", "second tab opened");
michael@0:       else
michael@0:         assert.equal(event.type, "TabSelect", "second tab selected");
michael@0:       assert.equal(event.target, tab2);
michael@0:     });
michael@0:     done();
michael@0:   }
michael@0: });
michael@0: 
michael@0: function getRelatedEvents (events, tabs) {
michael@0:   return events.filter(({target}) => ~([].concat(tabs)).indexOf(target));
michael@0: }
michael@0: 
michael@0: require("sdk/test").run(exports);