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
/* eslint-env webextensions */
var { MailServices } = ChromeUtils.importESModule(
);
var { MessageGenerator } = ChromeUtils.importESModule(
);
const TEST_DOCUMENT_URL =
const TEST_MESSAGE_URL =
const TEST_IMAGE_URL =
let about3Pane, testFolder;
async function getImageArrayBuffer() {
const response = await fetch(TEST_IMAGE_URL);
const blob = await response.blob();
return new Promise(resolve => {
const reader = new FileReader();
reader.addEventListener("loadend", event => {
resolve(event.target.result);
});
reader.readAsArrayBuffer(blob);
});
}
function checkMenuitems(menu, ...expectedItems) {
if (expectedItems.length == 0) {
// Menu should not be shown.
Assert.equal(menu.state, "closed");
return;
}
Assert.notEqual(menu.state, "closed");
const actualItems = [];
for (const item of menu.children) {
if (
["menu", "menuitem", "menugroup"].includes(item.localName) &&
!item.hidden
) {
actualItems.push(item.id);
}
}
Assert.deepEqual(actualItems, expectedItems);
}
async function checkABrowser(browser, doc = browser.ownerDocument) {
if (
browser.webProgress?.isLoadingDocument ||
!browser.currentURI ||
browser.currentURI?.spec == "about:blank"
) {
await BrowserTestUtils.browserLoaded(
browser,
undefined,
url => url != "about:blank"
);
}
const browserContext = doc.getElementById("browserContext");
const isMacWithNativeContextMenus =
AppConstants.platform == "macosx" &&
Services.prefs.getBoolPref("widget.macos.native-context-menus", true);
const isWebPage =
browser.currentURI.schemeIs("http") || browser.currentURI.schemeIs("https");
const isExtensionPage = browser.currentURI.schemeIs("moz-extension");
// Just some text.
let shownPromise = BrowserTestUtils.waitForEvent(
browserContext,
"popupshown"
);
await BrowserTestUtils.synthesizeMouseAtCenter(
"p",
{ type: "contextmenu" },
browser
);
await shownPromise;
const expectedContextItems = [];
if (isWebPage || isExtensionPage) {
if (isMacWithNativeContextMenus) {
// Mac has the nav items directly in the context menu and not in the horizontal
// context-navigation menugroup.
expectedContextItems.push(
"browserContext-back",
"browserContext-forward",
"browserContext-reload"
);
} else {
expectedContextItems.push("context-navigation");
checkMenuitems(
doc.getElementById("context-navigation"),
"browserContext-back",
"browserContext-forward",
"browserContext-reload"
);
}
}
if (isWebPage) {
expectedContextItems.push("browserContext-openInBrowser");
}
expectedContextItems.push("browserContext-selectall");
checkMenuitems(browserContext, ...expectedContextItems);
browserContext.hidePopup();
// A link.
shownPromise = BrowserTestUtils.waitForEvent(browserContext, "popupshown");
await BrowserTestUtils.synthesizeMouseAtCenter(
"a",
{ type: "contextmenu" },
browser
);
await shownPromise;
checkMenuitems(
browserContext,
"browserContext-openLinkInBrowser",
"browserContext-selectall",
"browserContext-copylink",
"browserContext-savelink"
);
browserContext.hidePopup();
// A text input widget.
await BrowserTestUtils.synthesizeMouseAtCenter("input", {}, browser);
shownPromise = BrowserTestUtils.waitForEvent(browserContext, "popupshown");
await BrowserTestUtils.synthesizeMouseAtCenter(
"input",
{ type: "contextmenu" },
browser
);
await shownPromise;
checkMenuitems(
browserContext,
"browserContext-undo",
"browserContext-cut",
"browserContext-copy",
"browserContext-paste",
"browserContext-selectall",
"browserContext-spell-check-enabled"
);
browserContext.hidePopup();
// An image. Also checks Save Image As works.
shownPromise = BrowserTestUtils.waitForEvent(browserContext, "popupshown");
await BrowserTestUtils.synthesizeMouseAtCenter(
"img",
{ type: "contextmenu" },
browser
);
await shownPromise;
checkMenuitems(
browserContext,
"browserContext-selectall",
"browserContext-copyimage",
"browserContext-saveimage"
);
const pickerPromise = new Promise(resolve => {
SpecialPowers.MockFilePicker.init(window.browsingContext);
SpecialPowers.MockFilePicker.showCallback = picker => {
resolve(picker.defaultString);
return Ci.nsIFilePicker.returnCancel;
};
});
browserContext.activateItem(doc.getElementById("browserContext-saveimage"));
Assert.equal(await pickerPromise, "tb-logo.png");
SpecialPowers.MockFilePicker.cleanup();
}
add_setup(async function () {
const account = MailServices.accounts.createLocalMailAccount();
account.addIdentity(MailServices.accounts.createIdentity());
const rootFolder = account.incomingServer.rootFolder.QueryInterface(
Ci.nsIMsgLocalMailFolder
);
testFolder = rootFolder
.createLocalSubfolder("browserContextFolder")
.QueryInterface(Ci.nsIMsgLocalMailFolder);
const message = await fetch(TEST_MESSAGE_URL).then(r => r.text());
testFolder.addMessageBatch([message]);
const messages = new MessageGenerator().makeMessages({ count: 5 });
const messageStrings = messages.map(message => message.toMessageString());
testFolder.addMessageBatch(messageStrings);
about3Pane = document.getElementById("tabmail").currentAbout3Pane;
about3Pane.restoreState({
folderURI: testFolder.URI,
messagePaneVisible: true,
});
registerCleanupFunction(() => {
MailServices.accounts.removeAccount(account, false);
});
});
add_task(async function testMessagePane() {
about3Pane.messagePane.displayWebPage(TEST_DOCUMENT_URL);
await checkABrowser(about3Pane.webBrowser, document);
about3Pane.messagePane.clearWebPage();
});
add_task(async function testContentTab() {
const tab = window.openContentTab(TEST_DOCUMENT_URL);
await checkABrowser(tab.browser);
const tabmail = document.getElementById("tabmail");
tabmail.closeTab(tab);
});
add_task(async function testExtensionTab() {
const extension = ExtensionTestUtils.loadExtension({
background: async () => {
await browser.tabs.create({ url: "sampleContent.html" });
browser.test.notifyPass("ready");
},
files: {
"sampleContent.html": await fetch(TEST_DOCUMENT_URL).then(response =>
response.text()
),
"tb-logo.png": await getImageArrayBuffer(),
},
});
await extension.startup();
await extension.awaitFinish("ready");
const tabmail = document.getElementById("tabmail");
await checkABrowser(tabmail.tabInfo[1].browser);
tabmail.closeOtherTabs(tabmail.tabInfo[0]);
await extension.unload();
});
add_task(async function testExtensionPopupWindow() {
const extension = ExtensionTestUtils.loadExtension({
background: async () => {
await browser.windows.create({
url: "sampleContent.html",
type: "popup",
width: 800,
height: 500,
});
browser.test.notifyPass("ready");
},
files: {
"sampleContent.html": await fetch(TEST_DOCUMENT_URL).then(response =>
response.text()
),
"tb-logo.png": await getImageArrayBuffer(),
},
});
await extension.startup();
await extension.awaitFinish("ready");
const extensionPopup = Services.wm.getMostRecentWindow("mail:extensionPopup");
// extensionPopup.xhtml needs time to initialise properly.
await new Promise(resolve => extensionPopup.setTimeout(resolve, 500));
await checkABrowser(extensionPopup.document.getElementById("requestFrame"));
await BrowserTestUtils.closeWindow(extensionPopup);
await extension.unload();
});
add_task(async function testExtensionBrowserAction() {
const extension = ExtensionTestUtils.loadExtension({
files: {
"sampleContent.html": await fetch(TEST_DOCUMENT_URL).then(response =>
response.text()
),
"tb-logo.png": await getImageArrayBuffer(),
},
manifest: {
applications: {
gecko: {
id: "browsercontext@mochi.test",
},
},
browser_action: {
default_popup: "sampleContent.html",
},
},
});
await extension.startup();
const { panel, browser } = await openExtensionPopup(
window,
"ext-browsercontext@mochi.test"
);
await TestUtils.waitForCondition(
() => browser.clientWidth > 100,
"waiting for browser to resize"
);
await checkABrowser(browser);
panel.hidePopup();
await extension.unload();
});
add_task(async function testExtensionComposeAction() {
const extension = ExtensionTestUtils.loadExtension({
files: {
"sampleContent.html": await fetch(TEST_DOCUMENT_URL).then(response =>
response.text()
),
"tb-logo.png": await getImageArrayBuffer(),
},
manifest: {
applications: {
gecko: {
id: "browsercontext@mochi.test",
},
},
compose_action: {
default_popup: "sampleContent.html",
},
},
});
await extension.startup();
const params = Cc[
"@mozilla.org/messengercompose/composeparams;1"
].createInstance(Ci.nsIMsgComposeParams);
params.composeFields = Cc[
"@mozilla.org/messengercompose/composefields;1"
].createInstance(Ci.nsIMsgCompFields);
const composeWindowPromise = BrowserTestUtils.domWindowOpened();
MailServices.compose.OpenComposeWindowWithParams(null, params);
const composeWindow = await composeWindowPromise;
await BrowserTestUtils.waitForEvent(composeWindow, "load");
const { panel, browser } = await openExtensionPopup(
composeWindow,
"browsercontext_mochi_test-composeAction-toolbarbutton"
);
await checkABrowser(browser);
panel.hidePopup();
await extension.unload();
await BrowserTestUtils.closeWindow(composeWindow);
});
add_task(async function testExtensionMessageDisplayAction() {
const extension = ExtensionTestUtils.loadExtension({
files: {
"sampleContent.html": await fetch(TEST_DOCUMENT_URL).then(response =>
response.text()
),
"tb-logo.png": await getImageArrayBuffer(),
},
manifest: {
applications: {
gecko: {
id: "browsercontext@mochi.test",
},
},
message_display_action: {
default_popup: "sampleContent.html",
},
},
});
await extension.startup();
const messageWindowPromise = BrowserTestUtils.domWindowOpened();
window.MsgOpenNewWindowForMessage([...testFolder.messages][0]);
const messageWindow = await messageWindowPromise;
const { target: aboutMessage } = await BrowserTestUtils.waitForEvent(
messageWindow,
"aboutMessageLoaded"
);
const { panel, browser } = await openExtensionPopup(
aboutMessage,
"browsercontext_mochi_test-messageDisplayAction-toolbarbutton"
);
await checkABrowser(browser);
panel.hidePopup();
await extension.unload();
await BrowserTestUtils.closeWindow(messageWindow);
});