diff options
Diffstat (limited to 'comm/mail/components/extensions/test/browser/browser_ext_clickHandler.js')
| -rw-r--r-- | comm/mail/components/extensions/test/browser/browser_ext_clickHandler.js | 614 |
1 files changed, 614 insertions, 0 deletions
diff --git a/comm/mail/components/extensions/test/browser/browser_ext_clickHandler.js b/comm/mail/components/extensions/test/browser/browser_ext_clickHandler.js new file mode 100644 index 0000000000..504de75218 --- /dev/null +++ b/comm/mail/components/extensions/test/browser/browser_ext_clickHandler.js @@ -0,0 +1,614 @@ +/* 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/. */ + +let { MockRegistrar } = ChromeUtils.importESModule( + "resource://testing-common/MockRegistrar.sys.mjs" +); + +/** @implements {nsIExternalProtocolService} */ +let mockExternalProtocolService = { + _loadedURLs: [], + externalProtocolHandlerExists(protocolScheme) {}, + getApplicationDescription(scheme) {}, + getProtocolHandlerInfo(protocolScheme) {}, + getProtocolHandlerInfoFromOS(protocolScheme, found) {}, + isExposedProtocol(protocolScheme) {}, + loadURI(uri, windowContext) { + this._loadedURLs.push(uri.spec); + }, + setProtocolHandlerDefaults(handlerInfo, osHandlerExists) {}, + urlLoaded(url) { + let rv = this._loadedURLs.length == 1 && this._loadedURLs[0] == url; + this._loadedURLs = []; + return rv; + }, + hasAnyUrlLoaded() { + let rv = this._loadedURLs.length > 0; + this._loadedURLs = []; + return rv; + }, + QueryInterface: ChromeUtils.generateQI(["nsIExternalProtocolService"]), +}; +let mockExternalProtocolServiceCID = MockRegistrar.register( + "@mozilla.org/uriloader/external-protocol-service;1", + mockExternalProtocolService +); + +registerCleanupFunction(() => { + MockRegistrar.unregister(mockExternalProtocolServiceCID); +}); + +const getCommonFiles = async () => { + return { + "utils.js": await getUtilsJS(), + "common.js": () => { + window.CreateTabPromise = class { + constructor() { + this.promise = new Promise(resolve => { + let createListener = tab => { + browser.tabs.onCreated.removeListener(createListener); + resolve(tab); + }; + browser.tabs.onCreated.addListener(createListener); + }); + } + async done() { + return this.promise; + } + }; + + window.UpdateTabPromise = class { + constructor() { + this.promise = new Promise(resolve => { + let log = {}; + let updateListener = (tabId, changes, tab) => { + if (changes.url == "about:blank") { + // Reset whatever we have seen so far. + log = {}; + } else { + if (changes.url) { + log.url = changes.url; + } + if (changes.status == "loading") { + log.loading = true; + } + // The complete is only valid, if we seen a url (which was not + // "about:blank") + if (log.url && changes.status == "complete") { + log.complete = true; + } + } + if (log.id && log.id != tabId) { + browser.test.fail( + "Should not receive update events for multiple tabs" + ); + } + log.id = tabId; + + if (log.url && log.loading && log.complete) { + browser.tabs.onUpdated.removeListener(updateListener); + resolve(log); + } + }; + browser.tabs.onUpdated.addListener(updateListener); + }); + } + async verify(id, url) { + // The updatePromise resolves after we have seen both states (loading + // and complete) and a url. + let updateLog = await this.promise; + browser.test.assertEq( + id, + updateLog.id, + "Updates must belong to the current tab" + ); + browser.test.assertEq( + url, + updateLog.url, + "Should have seen the correct url loaded." + ); + } + }; + }, + "background.js": async () => { + let expectedLinkHandler = await window.sendMessage("expectedLinkHandler"); + + // Open local file and click link to a different site. + await window.expectLinkOpenInExternalBrowser( + browser.runtime.getURL("test.html"), + "#link1", + "https://www.example.de/" + ); + + // Open local file and click same site link (no target). + await window.expectLinkOpenInSameTab( + browser.runtime.getURL("test.html"), + "#link2", + browser.runtime.getURL("example.html") + ); + + // Open local file and click same site link ("_self" target). + await window.expectLinkOpenInSameTab( + browser.runtime.getURL("test.html"), + "#link3", + browser.runtime.getURL("example.html#self") + ); + + // Open local file and click same site link ("_blank" target). + await window.expectLinkOpenInNewTab( + browser.runtime.getURL("test.html"), + "#link4", + browser.runtime.getURL("example.html#blank") + ); + + // Open local file and click same site link ("_other" target). + await window.expectLinkOpenInNewTab( + browser.runtime.getURL("test.html"), + "#link5", + browser.runtime.getURL("example.html#other") + ); + + // Open a remote page and click link on same site. + if (expectedLinkHandler == "single-page") { + await window.expectLinkOpenInExternalBrowser( + "https://example.org/browser/comm/mail/components/extensions/test/browser/data/linktest.html", + "#linkExt1", + "https://example.org/browser/comm/mail/components/extensions/test/browser/data/content.html" + ); + } else { + await window.expectLinkOpenInSameTab( + "https://example.org/browser/comm/mail/components/extensions/test/browser/data/linktest.html", + "#linkExt1", + "https://example.org/browser/comm/mail/components/extensions/test/browser/data/content.html" + ); + } + + // Open a remote page and click link to a different site. + await window.expectLinkOpenInExternalBrowser( + "https://example.org/browser/comm/mail/components/extensions/test/browser/data/linktest.html", + "#linkExt2", + "https://mozilla.org/" + ); + + browser.test.notifyPass(); + }, + "example.html": `<!DOCTYPE HTML> + <html> + <head> + <title>EXAMPLE</title> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + </head> + <body> + <p>This is an example page</p> + </body> + </html>`, + "test.html": `<!DOCTYPE HTML> + <html> + <head> + <title>TEST</title> + <meta http-equiv="content-type" content="text/html; charset=utf-8"> + </head> + <body> + <ul> + <li><a id="link1" href="https://www.example.de/">external</a> + <li><a id="link2" href="example.html">no target</a> + <li><a id="link3" href="example.html#self" target = "_self">_self target</a> + <li><a id="link4" href="example.html#blank" target = "_blank">_blank target</a> + <li><a id="link5" href="example.html#other" target = "_other">_other target</a> + </ul> + </body> + </html>`, + }; +}; + +const subtest_clickInBrowser = async ( + extension, + expectedLinkHandler, + getBrowser +) => { + async function clickLink(linkId, browser) { + await awaitBrowserLoaded(browser, url => url != "about:blank"); + await synthesizeMouseAtCenterAndRetry(linkId, {}, browser); + } + + await extension.startup(); + + await extension.awaitMessage("expectedLinkHandler"); + extension.sendMessage(expectedLinkHandler); + + // Wait for click on #link1 (external) + { + let { linkId, expectedUrl } = await extension.awaitMessage("click"); + Assert.equal("#link1", linkId, `Test should click on the correct link.`); + Assert.equal( + "https://www.example.de/", + expectedUrl, + `Test should open the correct link.` + ); + await clickLink(linkId, getBrowser()); + Assert.ok( + mockExternalProtocolService.urlLoaded(expectedUrl), + `Link should have correctly been opened in external browser.` + ); + await extension.sendMessage(); + } + + // Wait for click on #link2 (same tab) + { + let { linkId } = await extension.awaitMessage("click"); + Assert.equal("#link2", linkId, `Test should click on the correct link.`); + await clickLink(linkId, getBrowser()); + Assert.ok( + !mockExternalProtocolService.hasAnyUrlLoaded(), + `Link should not have been opened in external browser.` + ); + await extension.sendMessage(); + } + + // Wait for click on #link3 (same tab) + { + let { linkId } = await extension.awaitMessage("click"); + Assert.equal("#link3", linkId, `Test should click on the correct link.`); + await clickLink(linkId, getBrowser()); + Assert.ok( + !mockExternalProtocolService.hasAnyUrlLoaded(), + `Link should not have been opened in external browser.` + ); + await extension.sendMessage(); + } + + // Wait for click on #link4 (new tab) + { + let { linkId } = await extension.awaitMessage("click"); + Assert.equal("#link4", linkId, `Test should click on the correct link.`); + await clickLink(linkId, getBrowser()); + Assert.ok( + !mockExternalProtocolService.hasAnyUrlLoaded(), + `Link should not have been opened in external browser.` + ); + await extension.sendMessage(); + } + + // Wait for click on #link5 (new tab) + { + let { linkId } = await extension.awaitMessage("click"); + Assert.equal("#link5", linkId, `Test should click on the correct link.`); + await clickLink(linkId, getBrowser()); + Assert.ok( + !mockExternalProtocolService.hasAnyUrlLoaded(), + `Link should not have been opened in external browser.` + ); + await extension.sendMessage(); + } + + // Wait for click on #linkExt1 + if (expectedLinkHandler == "single-page") { + // Should open extern with single-page link handler. + let { linkId, expectedUrl } = await extension.awaitMessage("click"); + Assert.equal("#linkExt1", linkId, `Test should click on the correct link.`); + Assert.equal( + "https://example.org/browser/comm/mail/components/extensions/test/browser/data/content.html", + expectedUrl, + `Test should open the correct link.` + ); + await clickLink(linkId, getBrowser()); + Assert.ok( + mockExternalProtocolService.urlLoaded(expectedUrl), + `Link should have correctly been opened in external browser.` + ); + await extension.sendMessage(); + } else { + // Should open in same tab with single-site link handler. + let { linkId } = await extension.awaitMessage("click"); + Assert.equal("#linkExt1", linkId, `Test should click on the correct link.`); + await clickLink(linkId, getBrowser()); + Assert.ok( + !mockExternalProtocolService.hasAnyUrlLoaded(), + `Link should not have been opened in external browser.` + ); + await extension.sendMessage(); + } + + // Wait for click on #linkExt2 (external) + { + let { linkId, expectedUrl } = await extension.awaitMessage("click"); + Assert.equal("#linkExt2", linkId, `Test should click on the correct link.`); + Assert.equal( + "https://mozilla.org/", + expectedUrl, + `Test should open the correct link.` + ); + await clickLink(linkId, getBrowser()); + Assert.ok( + mockExternalProtocolService.urlLoaded(expectedUrl), + `Link should have correctly been opened in external browser.` + ); + await extension.sendMessage(); + } + + await extension.awaitFinish(); + await extension.unload(); +}; + +add_task(async function test_tabs() { + let extension = ExtensionTestUtils.loadExtension({ + files: { + "tabFunctions.js": async () => { + let openTestTab = async url => { + let createdTestTab = new window.CreateTabPromise(); + let updatedTestTab = new window.UpdateTabPromise(); + let testTab = await browser.tabs.create({ url }); + await createdTestTab.done(); + await updatedTestTab.verify(testTab.id, url); + return testTab; + }; + + window.expectLinkOpenInNewTab = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await openTestTab(testUrl); + + // Click a link in testTab to open a new tab. + let createdNewTab = new window.CreateTabPromise(); + let updatedNewTab = new window.UpdateTabPromise(); + await window.sendMessage("click", { linkId }); + let createdTab = await createdNewTab.done(); + await updatedNewTab.verify(createdTab.id, expectedUrl); + + await browser.tabs.remove(createdTab.id); + await browser.tabs.remove(testTab.id); + }; + + window.expectLinkOpenInSameTab = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await openTestTab(testUrl); + + // Click a link in testTab to open in self. + let updatedTab = new window.UpdateTabPromise(); + await window.sendMessage("click", { linkId }); + await updatedTab.verify(testTab.id, expectedUrl); + + await browser.tabs.remove(testTab.id); + }; + + window.expectLinkOpenInExternalBrowser = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await openTestTab(testUrl); + await window.sendMessage("click", { linkId, expectedUrl }); + await browser.tabs.remove(testTab.id); + }; + }, + ...(await getCommonFiles()), + }, + manifest: { + background: { + scripts: ["utils.js", "common.js", "tabFunctions.js", "background.js"], + }, + permissions: ["tabs"], + }, + }); + + await subtest_clickInBrowser( + extension, + "single-site", + () => document.getElementById("tabmail").currentTabInfo.browser + ); +}).skip(AppConstants.DEBUG); // Disabled until Bug 1770105 is fully fixed. + +add_task(async function test_windows() { + let extension = ExtensionTestUtils.loadExtension({ + files: { + "windowFunctions.js": async () => { + let openTestTab = async url => { + let createdTestTab = new window.CreateTabPromise(); + let updatedTestTab = new window.UpdateTabPromise(); + let testWindow = await browser.windows.create({ type: "popup", url }); + await createdTestTab.done(); + + let [testTab] = await browser.tabs.query({ windowId: testWindow.id }); + await updatedTestTab.verify(testTab.id, url); + return testTab; + }; + + window.expectLinkOpenInNewTab = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await openTestTab(testUrl); + + // Click a link in testWindow to open a new tab. + let createdNewTab = new window.CreateTabPromise(); + let updatedNewTab = new window.UpdateTabPromise(); + await window.sendMessage("click", { linkId }); + let createdTab = await createdNewTab.done(); + await updatedNewTab.verify(createdTab.id, expectedUrl); + + await browser.tabs.remove(createdTab.id); + await browser.tabs.remove(testTab.id); + }; + + window.expectLinkOpenInSameTab = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await openTestTab(testUrl); + + // Click a link in testWindow to open in self. + let updatedTab = new window.UpdateTabPromise(); + await window.sendMessage("click", { linkId }); + await updatedTab.verify(testTab.id, expectedUrl); + await browser.tabs.remove(testTab.id); + }; + + window.expectLinkOpenInExternalBrowser = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await openTestTab(testUrl); + await window.sendMessage("click", { linkId, expectedUrl }); + await browser.tabs.remove(testTab.id); + }; + }, + ...(await getCommonFiles()), + }, + manifest: { + background: { + scripts: [ + "utils.js", + "common.js", + "windowFunctions.js", + "background.js", + ], + }, + permissions: ["tabs"], + }, + }); + + await subtest_clickInBrowser( + extension, + "single-site", + () => Services.wm.getMostRecentWindow("mail:extensionPopup").browser + ); +}).skip(AppConstants.DEBUG); // Disabled until Bug 1770105 is fully fixed. + +add_task(async function test_mail3pane() { + let account = createAccount(); + let subFolders = account.incomingServer.rootFolder.subFolders; + createMessages(subFolders[0], 1); + + let about3Pane = document.getElementById("tabmail").currentAbout3Pane; + Assert.ok(Boolean(about3Pane), "about:3pane should be the current tab"); + about3Pane.restoreState({ + folderPaneVisible: true, + folderURI: subFolders[0], + messagePaneVisible: true, + }); + let loadedPromise = BrowserTestUtils.browserLoaded( + about3Pane.messageBrowser.contentWindow.getMessagePaneBrowser() + ); + about3Pane.threadTree.selectedIndex = 0; + await loadedPromise; + let extension = ExtensionTestUtils.loadExtension({ + files: { + "mail3paneFunctions.js": async () => { + let updateTestTab = async url => { + let updatedTestTab = new window.UpdateTabPromise(); + let mailTabs = await browser.tabs.query({ type: "mail" }); + browser.test.assertEq( + 1, + mailTabs.length, + "Should find a single mailTab" + ); + await browser.tabs.update(mailTabs[0].id, { url }); + await updatedTestTab.verify(mailTabs[0].id, url); + return mailTabs[0]; + }; + + window.expectLinkOpenInNewTab = async ( + testUrl, + linkId, + expectedUrl + ) => { + await updateTestTab(testUrl); + + // Click a link in testTab to open a new tab. + let createdNewTab = new window.CreateTabPromise(); + let updatedNewTab = new window.UpdateTabPromise(); + await window.sendMessage("click", { linkId }); + let createdTab = await createdNewTab.done(); + await updatedNewTab.verify(createdTab.id, expectedUrl); + + await browser.tabs.remove(createdTab.id); + }; + + window.expectLinkOpenInSameTab = async ( + testUrl, + linkId, + expectedUrl + ) => { + let testTab = await updateTestTab(testUrl); + + // Click a link in testTab to open in self. + let updatedTab = new window.UpdateTabPromise(); + await window.sendMessage("click", { linkId }); + await updatedTab.verify(testTab.id, expectedUrl); + }; + + window.expectLinkOpenInExternalBrowser = async ( + testUrl, + linkId, + expectedUrl + ) => { + await updateTestTab(testUrl); + await window.sendMessage("click", { linkId, expectedUrl }); + }; + }, + ...(await getCommonFiles()), + }, + manifest: { + background: { + scripts: [ + "utils.js", + "common.js", + "mail3paneFunctions.js", + "background.js", + ], + }, + permissions: ["tabs"], + }, + }); + + await subtest_clickInBrowser( + extension, + "single-page", + () => document.getElementById("tabmail").currentTabInfo.browser + ); +}).skip(AppConstants.DEBUG); // Disabled until Bug 1770105 is fully fixed. + +// This is actually not an extension test, but everything we need is here already +// and we only want to simulate a click on a link in a message. +add_task(async function test_message() { + let gAccount = createAccount(); + let gRootFolder = gAccount.incomingServer.rootFolder; + gRootFolder.createSubfolder("test0", null); + + let subFolders = {}; + for (let folder of gRootFolder.subFolders) { + subFolders[folder.name] = folder; + } + await createMessageFromFile( + subFolders.test0, + getTestFilePath("messages/messageWithLink.eml") + ); + + // Select the message which has a link. + let gFolder = subFolders.test0; + let about3Pane = document.getElementById("tabmail").currentAbout3Pane; + about3Pane.displayFolder(gFolder.URI); + let messagePane = + about3Pane.messageBrowser.contentWindow.getMessagePaneBrowser(); + let loadedPromise = BrowserTestUtils.browserLoaded(messagePane); + about3Pane.threadTree.selectedIndex = 0; + await loadedPromise; + + // Click the link. + await synthesizeMouseAtCenterAndRetry("#link", {}, messagePane); + Assert.ok( + mockExternalProtocolService.urlLoaded( + "https://www.example.de/messageLink.html" + ), + `Link should have correctly been opened in external browser.` + ); +}); |