Bug 1894618 - Add support for browser.runtime.getContexts(). r=mkmelin
This is adding the required changes to make `runtime.getContexts()` work in Thunderbird. This also adds a mochitest, which is based on this m-c test: /browser/components/extensions/test/browser/browser_ext_runtime_getContexts.js Differential Revision: https://phabricator.services.mozilla.com/D209794 --HG-- extra : rebase_source : 8c0c71071c77eb7bacd06fa5c5a5ef787c163e2b
This commit is contained in:
John Bieling
Родитель
6d571ac575
Коммит
eb89a158bd
|
|
@ -838,6 +838,16 @@ var specialTabs = {
|
|||
if (aArgs.userContextId) {
|
||||
aTab.browser.setAttribute("usercontextid", aArgs.userContextId);
|
||||
}
|
||||
|
||||
// Ensure the browser will initially load in the same group as other
|
||||
// browsers from the same extension.
|
||||
if (aArgs.initialBrowsingContextGroupId) {
|
||||
aTab.browser.setAttribute(
|
||||
"initialBrowsingContextGroupId",
|
||||
aArgs.initialBrowsingContextGroupId
|
||||
);
|
||||
}
|
||||
|
||||
aTab.panel.setAttribute("id", "contentTabWrapper" + this.lastBrowserId);
|
||||
aTab.panel.appendChild(clone);
|
||||
aTab.root = clone;
|
||||
|
|
|
|||
|
|
@ -972,12 +972,43 @@ class TabTracker extends TabTrackerBase {
|
|||
* @returns {{ tabId:Integer, windowId:Integer }} The browsing data for the element
|
||||
*/
|
||||
getBrowserData(browser) {
|
||||
const window = browser.ownerGlobal;
|
||||
if (window?.top.document.documentURI === "about:addons") {
|
||||
// When we're loaded into a <browser> inside about:addons, we need to go up
|
||||
// one more level.
|
||||
browser = window.docShell.chromeEventHandler;
|
||||
}
|
||||
// Detect windowless windows, mostly for the background page and xpcshell
|
||||
// tests, where m-c expects -1.
|
||||
if (
|
||||
!window ||
|
||||
window.location.href == "chrome://extensions/content/dummy.xhtml"
|
||||
) {
|
||||
return { tabId: -1, windowId: -1 };
|
||||
}
|
||||
|
||||
let windowId = windowTracker.getId(browser.ownerGlobal);
|
||||
// Do not return invalid windowIds. windowTracker.getId() just pulls the
|
||||
// outerWindowID, while windowTracker.getWindow() does more checks on the
|
||||
// validity.
|
||||
try {
|
||||
windowTracker.getWindow(windowId);
|
||||
} catch (ex) {
|
||||
windowId = -1;
|
||||
}
|
||||
return {
|
||||
tabId: this.getBrowserTabId(browser),
|
||||
windowId: windowTracker.getId(browser.ownerGlobal),
|
||||
windowId,
|
||||
};
|
||||
}
|
||||
|
||||
getBrowserDataForContext(context) {
|
||||
if (["background", "tab", "popup"].includes(context.viewType)) {
|
||||
return this.getBrowserData(context.xulBrowser);
|
||||
}
|
||||
return { tabId: -1, windowId: -1 };
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the active tab info for the given window
|
||||
*
|
||||
|
|
|
|||
|
|
@ -125,6 +125,7 @@ support-files = messages/attachedMessageSample.eml
|
|||
[browser_ext_messageDisplayScripts.js]
|
||||
[browser_ext_messages_open_attachment.js]
|
||||
[browser_ext_quickFilter.js]
|
||||
[browser_ext_runtime_getContexts.js]
|
||||
[browser_ext_sessions.js]
|
||||
[browser_ext_spaces.js]
|
||||
[browser_ext_spacesToolbar.js]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,453 @@
|
|||
/* Any copyright is dedicated to the Public Domain.
|
||||
* http://creativecommons.org/publicdomain/zero/1.0/ */
|
||||
|
||||
"use strict";
|
||||
|
||||
async function genericChecker() {
|
||||
const params = new URLSearchParams(window.location.search);
|
||||
const kind = params.get("kind");
|
||||
|
||||
browser.test.onMessage.addListener(async (msg, ...args) => {
|
||||
if (msg == "open-browser-action") {
|
||||
await browser.action.openPopup();
|
||||
browser.test.sendMessage(`${msg}:done`);
|
||||
} else if (msg == `${kind}-get-contexts-invalid-params`) {
|
||||
browser.test.assertThrows(
|
||||
() => browser.runtime.getContexts({ unknownParamName: true }),
|
||||
/Type error for parameter filter \(Unexpected property "unknownParamName"\)/,
|
||||
"Got the expected error on unexpected filter property"
|
||||
);
|
||||
browser.test.sendMessage(`${msg}:done`);
|
||||
} else if (msg == `${kind}-get-contexts`) {
|
||||
const filter = args[0];
|
||||
try {
|
||||
const result = await browser.runtime.getContexts(filter);
|
||||
browser.test.sendMessage(`${msg}:result`, result);
|
||||
} catch (err) {
|
||||
// In case of unexpected errors, log a failure and let the test
|
||||
// to continue to avoid it to only fail after timing out.
|
||||
browser.test.fail(`browser.runtime.getContexts call rejected: ${err}`);
|
||||
browser.test.sendMessage(`${msg}:result`, []);
|
||||
}
|
||||
} else if (msg == `${kind}-history-push-state`) {
|
||||
const pushStateURL = args[0];
|
||||
window.history.pushState({}, "", pushStateURL);
|
||||
browser.test.sendMessage(`${msg}:done`);
|
||||
} else if (msg == `${kind}-create-iframe`) {
|
||||
const iframeUrl = args[0];
|
||||
const iframe = document.createElement("iframe");
|
||||
iframe.src = iframeUrl;
|
||||
document.body.appendChild(iframe);
|
||||
} else if (msg == `${kind}-open-options-page`) {
|
||||
browser.runtime.openOptionsPage();
|
||||
}
|
||||
});
|
||||
|
||||
browser.test.log(`${kind} extension page loaded`);
|
||||
browser.test.sendMessage(`${kind}-loaded`);
|
||||
}
|
||||
|
||||
const byWindowId = (a, b) => a.windowId - b.windowId;
|
||||
const byTabId = (a, b) => a.tabId - b.tabId;
|
||||
const byFrameId = (a, b) => a.frameId - b.frameId;
|
||||
const byContextType = (a, b) => a.contextType.localeCompare(b.contextType);
|
||||
|
||||
const assertValidContextId = contextId => {
|
||||
Assert.equal(
|
||||
typeof contextId,
|
||||
"string",
|
||||
"contextId should be set to a string"
|
||||
);
|
||||
Assert.notEqual(
|
||||
contextId.length,
|
||||
0,
|
||||
"contextId should be set to a non-zero length string"
|
||||
);
|
||||
};
|
||||
|
||||
const assertGetContextsResult = (
|
||||
actual,
|
||||
expected,
|
||||
msg,
|
||||
{ assertContextId = false } = {}
|
||||
) => {
|
||||
const actualCopy = assertContextId ? actual : actual.map(it => ({ ...it }));
|
||||
if (!assertContextId) {
|
||||
actualCopy.forEach(it => delete it.contextId);
|
||||
}
|
||||
for (const [idx, expectedProps] of expected.entries()) {
|
||||
Assert.deepEqual(actualCopy[idx], expectedProps, msg);
|
||||
}
|
||||
Assert.equal(
|
||||
actualCopy.length,
|
||||
expected.length,
|
||||
"Got the expected number of extension contexts"
|
||||
);
|
||||
};
|
||||
|
||||
add_task(async function test_runtime_getContexts() {
|
||||
const EXT_ID = "runtime-getContexts@mochitest";
|
||||
const extension = ExtensionTestUtils.loadExtension({
|
||||
useAddonManager: "temporary",
|
||||
manifest: {
|
||||
manifest_version: 3,
|
||||
browser_specific_settings: { gecko: { id: EXT_ID } },
|
||||
|
||||
action: {
|
||||
default_popup: "page.html?kind=action",
|
||||
},
|
||||
|
||||
options_ui: {
|
||||
page: "page.html?kind=options",
|
||||
},
|
||||
|
||||
background: {
|
||||
page: "page.html?kind=background",
|
||||
},
|
||||
},
|
||||
|
||||
files: {
|
||||
"page.html": `
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head><meta charset="utf-8"></head>
|
||||
<body>
|
||||
<script src="page.js"></script>
|
||||
</body></html>
|
||||
`,
|
||||
|
||||
"page.js": genericChecker,
|
||||
},
|
||||
});
|
||||
|
||||
const {
|
||||
Management: {
|
||||
global: { tabTracker, windowTracker },
|
||||
},
|
||||
} = ChromeUtils.importESModule("resource://gre/modules/Extension.sys.mjs");
|
||||
|
||||
const firstWin = window;
|
||||
// let secondWin = await BrowserTestUtils.openNewBrowserWindow();
|
||||
|
||||
await extension.startup();
|
||||
await extension.awaitMessage("background-loaded");
|
||||
|
||||
const firstWinId = windowTracker.getId(firstWin);
|
||||
//let secondWinId = windowTracker.getId(secondWin);
|
||||
|
||||
const getGetContextsResults = async ({ filter, sortBy }) => {
|
||||
extension.sendMessage("background-get-contexts", filter);
|
||||
const results = await extension.awaitMessage(
|
||||
"background-get-contexts:result"
|
||||
);
|
||||
if (sortBy) {
|
||||
results.sort(sortBy);
|
||||
}
|
||||
return results;
|
||||
};
|
||||
|
||||
const resolveExtPageUrl = urlPath =>
|
||||
WebExtensionPolicy.getByID(EXT_ID).extension.baseURI.resolve(urlPath);
|
||||
|
||||
const documentOrigin = resolveExtPageUrl("/").slice(0, -1);
|
||||
|
||||
const getExpectedExtensionContext = ({
|
||||
contextId,
|
||||
contextType,
|
||||
documentUrl,
|
||||
incognito = false,
|
||||
frameId = 0,
|
||||
tabId = -1,
|
||||
windowId = -1,
|
||||
}) => {
|
||||
const props = {
|
||||
contextType,
|
||||
documentOrigin,
|
||||
documentUrl,
|
||||
incognito,
|
||||
frameId,
|
||||
tabId,
|
||||
windowId,
|
||||
};
|
||||
if (contextId) {
|
||||
props.contextId = contextId;
|
||||
}
|
||||
return props;
|
||||
};
|
||||
|
||||
const expected = [
|
||||
getExpectedExtensionContext({
|
||||
contextType: "BACKGROUND",
|
||||
documentUrl: resolveExtPageUrl("page.html?kind=background"),
|
||||
}),
|
||||
].sort(byWindowId);
|
||||
|
||||
// Check background page.
|
||||
{
|
||||
info("Test getContexts error on unsupported getContexts filter property");
|
||||
extension.sendMessage("background-get-contexts-invalid-params");
|
||||
await extension.awaitMessage("background-get-contexts-invalid-params:done");
|
||||
|
||||
info("Test getContexts with a valid empty filter");
|
||||
const actual = await getGetContextsResults({
|
||||
filter: {},
|
||||
sortBy: byWindowId,
|
||||
});
|
||||
|
||||
assertGetContextsResult(
|
||||
actual,
|
||||
expected,
|
||||
"Got the expected results from runtime.getContexts (with an empty filter)"
|
||||
);
|
||||
|
||||
for (const ctx of actual) {
|
||||
info(
|
||||
`Validate contextId for context ${ctx.contextType} ${ctx.contextId}`
|
||||
);
|
||||
assertValidContextId(ctx.contextId);
|
||||
}
|
||||
}
|
||||
|
||||
// Open tab in firstWin.
|
||||
{
|
||||
info("Test tab in window");
|
||||
const tabmail = firstWin.document.getElementById("tabmail");
|
||||
const url = resolveExtPageUrl("page.html?kind=tab");
|
||||
const nativeTab = tabmail.openTab("contentTab", { url });
|
||||
await extension.awaitMessage("tab-loaded");
|
||||
const tabId = tabTracker.getId(nativeTab);
|
||||
const expectedTabContext = getExpectedExtensionContext({
|
||||
contextType: "TAB",
|
||||
documentUrl: resolveExtPageUrl("page.html?kind=tab"),
|
||||
windowId: firstWinId,
|
||||
tabId,
|
||||
incognito: false,
|
||||
});
|
||||
info("Test getContexts with contextTypes TAB filter");
|
||||
let actual = await getGetContextsResults({
|
||||
filter: { contextTypes: ["TAB"] },
|
||||
});
|
||||
assertGetContextsResult(
|
||||
actual,
|
||||
[expectedTabContext],
|
||||
"Got the expected results from runtime.getContexts (with contextTypes TAB filter)"
|
||||
);
|
||||
assertValidContextId(actual[0].contextId);
|
||||
const initialTabContextId = actual[0].contextId;
|
||||
|
||||
info("Test getContexts with contextTypes TabIds filter");
|
||||
actual = await getGetContextsResults({
|
||||
filter: { tabIds: [tabId] },
|
||||
});
|
||||
assertGetContextsResult(
|
||||
actual,
|
||||
[expectedTabContext],
|
||||
"Got the expected results from runtime.getContexts (with tabIds filter)"
|
||||
);
|
||||
|
||||
info("Test getContexts with contextTypes WindowIds filter");
|
||||
actual = await getGetContextsResults({
|
||||
filter: { windowIds: [firstWinId] },
|
||||
sortBy: byTabId,
|
||||
});
|
||||
console.log({ actual });
|
||||
assertGetContextsResult(
|
||||
actual,
|
||||
[expectedTabContext].sort(byTabId),
|
||||
"Got the expected results from runtime.getContexts (with windowIds filter)"
|
||||
);
|
||||
|
||||
info("Test getContexts after navigating the tab");
|
||||
const newTabURL = resolveExtPageUrl("page.html?kind=tab&navigated=true");
|
||||
nativeTab.browser.loadURI(Services.io.newURI(newTabURL), {
|
||||
triggeringPrincipal: Services.scriptSecurityManager.getSystemPrincipal(),
|
||||
});
|
||||
await extension.awaitMessage("tab-loaded");
|
||||
|
||||
actual = await getGetContextsResults({
|
||||
filter: {
|
||||
contextTypes: ["TAB"],
|
||||
windowIds: [firstWinId],
|
||||
},
|
||||
});
|
||||
Assert.equal(actual.length, 1, "Expect 1 tab extension context");
|
||||
Assert.equal(
|
||||
actual[0].documentUrl,
|
||||
newTabURL,
|
||||
"Expect documentUrl to match the new loaded url"
|
||||
);
|
||||
Assert.equal(actual[0].frameId, 0, "Got expected frameId");
|
||||
Assert.equal(
|
||||
actual[0].tabId,
|
||||
expectedTabContext.tabId,
|
||||
"Got expected tabId"
|
||||
);
|
||||
Assert.notEqual(
|
||||
actual[0].contextId,
|
||||
initialTabContextId,
|
||||
"Expect contextId to change on navigated tab"
|
||||
);
|
||||
|
||||
tabmail.closeTab(nativeTab);
|
||||
}
|
||||
|
||||
// Test action popup.
|
||||
{
|
||||
info("Wait the extension page to be fully loaded in the action popup");
|
||||
await focusWindow(firstWin);
|
||||
extension.sendMessage("open-browser-action");
|
||||
await extension.awaitMessage("open-browser-action:done");
|
||||
await extension.awaitMessage("action-loaded");
|
||||
|
||||
const expectedPopupContext = getExpectedExtensionContext({
|
||||
contextType: "POPUP",
|
||||
documentUrl: resolveExtPageUrl("page.html?kind=action"),
|
||||
windowId: firstWinId,
|
||||
tabId: -1,
|
||||
incognito: false,
|
||||
});
|
||||
|
||||
info("Test getContexts with contextTypes POPUP filter");
|
||||
const actual = await getGetContextsResults({
|
||||
filter: {
|
||||
contextTypes: ["POPUP"],
|
||||
},
|
||||
});
|
||||
assertGetContextsResult(
|
||||
actual,
|
||||
[expectedPopupContext],
|
||||
"Got the expected results from runtime.getContexts (with contextTypes POPUP filter)"
|
||||
);
|
||||
|
||||
/*info("Test getContexts with incognito true filter");
|
||||
actual = await getGetContextsResults({
|
||||
filter: { incognito: true },
|
||||
sortBy: byContextType,
|
||||
});
|
||||
assertGetContextsResult(
|
||||
actual.sort(byContextType),
|
||||
[expectedPopupContext, ...expected.filter(it => it.incognito)].sort(
|
||||
byContextType
|
||||
),
|
||||
"Got the expected results from runtime.getContexts (with contextTypes incognito true filter)"
|
||||
);*/
|
||||
|
||||
await closeBrowserAction(extension, firstWin);
|
||||
}
|
||||
|
||||
// Test iframes in background page.
|
||||
{
|
||||
info("Test getContexts with existing background iframes");
|
||||
extension.sendMessage(
|
||||
`background-create-iframe`,
|
||||
resolveExtPageUrl("page.html?kind=background-subframe")
|
||||
);
|
||||
await extension.awaitMessage(`background-subframe-loaded`);
|
||||
|
||||
let actual = await getGetContextsResults({
|
||||
filter: { contextTypes: ["BACKGROUND"] },
|
||||
});
|
||||
|
||||
Assert.equal(
|
||||
actual.length,
|
||||
2,
|
||||
"Expect 2 background extension contexts to be found"
|
||||
);
|
||||
const bgTopFrame = actual.find(
|
||||
it => it.documentUrl === resolveExtPageUrl("page.html?kind=background")
|
||||
);
|
||||
const bgSubFrame = actual.find(
|
||||
it =>
|
||||
it.documentUrl ===
|
||||
resolveExtPageUrl("page.html?kind=background-subframe")
|
||||
);
|
||||
|
||||
assertValidContextId(bgTopFrame.contextId);
|
||||
assertValidContextId(bgSubFrame.contextId);
|
||||
Assert.notEqual(
|
||||
bgTopFrame.contextId,
|
||||
bgSubFrame.contextId,
|
||||
"Expect background top and sub frame to have different contextIds"
|
||||
);
|
||||
|
||||
Assert.equal(
|
||||
bgTopFrame.frameId,
|
||||
0,
|
||||
"Expect background top frame to have frameId 0"
|
||||
);
|
||||
ok(
|
||||
typeof bgSubFrame.frameId === "number" && bgSubFrame.frameId > 0,
|
||||
"Expect background sub frame to have a non zero frameId"
|
||||
);
|
||||
Assert.equal(
|
||||
bgSubFrame.windowId,
|
||||
bgSubFrame.windowId,
|
||||
"Expect background top frame to have same windowId as the top frame"
|
||||
);
|
||||
Assert.equal(
|
||||
bgSubFrame.tabId,
|
||||
bgTopFrame.tabId,
|
||||
"Expect background top frame to have same tabId as the top frame"
|
||||
);
|
||||
|
||||
info("Test getContexts after background history push state");
|
||||
const pushStateURLPath = "/page.html?kind=background&pushedState=1";
|
||||
extension.sendMessage("background-history-push-state", pushStateURLPath);
|
||||
await extension.awaitMessage("background-history-push-state:done");
|
||||
|
||||
actual = await getGetContextsResults({
|
||||
filter: { contextTypes: ["BACKGROUND"], frameIds: [0] },
|
||||
});
|
||||
Assert.equal(
|
||||
actual.length,
|
||||
1,
|
||||
"Expect 1 top level background context to be found"
|
||||
);
|
||||
Assert.equal(
|
||||
actual[0].contextId,
|
||||
bgTopFrame.contextId,
|
||||
"Expect top level background contextId to NOT be changed"
|
||||
);
|
||||
Assert.equal(
|
||||
actual[0].documentUrl,
|
||||
resolveExtPageUrl(pushStateURLPath),
|
||||
"Expect top level background documentUrl to change due to history.pushState"
|
||||
);
|
||||
}
|
||||
|
||||
// Test the options page.
|
||||
{
|
||||
info(
|
||||
"Test getContexts after opening an options page embedded in an about:addons tab"
|
||||
);
|
||||
const tabmail = firstWin.document.getElementById("tabmail");
|
||||
const nativeTab = tabmail.openTab("contentTab", { url: "about:addons" });
|
||||
await awaitBrowserLoaded(nativeTab.browser, "about:addons");
|
||||
extension.sendMessage("background-open-options-page");
|
||||
await extension.awaitMessage("options-loaded");
|
||||
Assert.equal(
|
||||
nativeTab.browser.currentURI.spec,
|
||||
"about:addons",
|
||||
"Expect an about:addons tab to be current active tab"
|
||||
);
|
||||
const optionsTabId = tabTracker.getId(nativeTab);
|
||||
const actual = await getGetContextsResults({
|
||||
filter: { windowIds: [firstWinId], tabIds: [optionsTabId] },
|
||||
});
|
||||
assertGetContextsResult(
|
||||
actual,
|
||||
[
|
||||
getExpectedExtensionContext({
|
||||
contextType: "TAB",
|
||||
documentUrl: resolveExtPageUrl("page.html?kind=options"),
|
||||
windowId: firstWinId,
|
||||
tabId: optionsTabId,
|
||||
}),
|
||||
],
|
||||
"Got the expected results from runtime.getContexts for an options_page"
|
||||
);
|
||||
tabmail.closeTab(nativeTab);
|
||||
}
|
||||
|
||||
await extension.unload();
|
||||
});
|
||||
Загрузка…
Ссылка в новой задаче