Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-02-25 20:01:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1755978 - Add support for runAt in scripting.RegisteredContentScript. r=robwu

Browse Source 
Depends on D136717

Differential Revision: https://phabricator.services.mozilla.com/D139586
This commit is contained in:
William Durand 2022-02-25 08:33:18 +00:00
parent b44cfc8676
commit c17a37f1e6
5 changed files with 209 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
toolkit/components/extensions/parent/ext-scripting.js
View File

@ -122,8 +122,7 @@ const makeInternalContentScript = details => {
matchAboutBlank: true,
matches: details.matches,
originAttributesPatterns: null,
// TODO: Bug 1755978 - Add support for `details.runAt`.
runAt: "document_idle",
runAt: details.runAt,
},
};
};
@ -261,6 +260,7 @@ this.scripting = class extends ExtensionAPI {
jsPath.replace(extension.baseURL, "")
),
matches: options.matches,
runAt: options.runAt,
};
})
.filter(script => script);

6
toolkit/components/extensions/schemas/scripting.json
View File

@ -170,6 +170,12 @@
"optional": true,
"description": "Specifies which pages this content script will be injected into. Must be specified for <code>registerContentScripts()</code>.",
"items": { "type": "string" }
},
"runAt": {
"$ref": "extensionTypes.RunAt",
"optional": true,
"default": "document_idle",
"description": "Specifies when JavaScript files are injected into the web page. The preferred and default value is <code>document_idle</code>."
}
}
}

5
toolkit/components/extensions/test/mochitest/test_ext_scripting_contentScripts.html
View File

@ -412,6 +412,7 @@ add_task(async function test_registerContentScripts_js() {
allFrames: false,
js: ["script-1.js"],
matches: ["*://test1.example.com/*"],
runAt: "document_idle",
},
{
id: "script-2",
@ -421,6 +422,7 @@ add_task(async function test_registerContentScripts_js() {
"*://test1.example.com/*",
"*://example.org/*",
],
runAt: "document_idle",
},
{
id: "script-3",
@ -431,12 +433,14 @@ add_task(async function test_registerContentScripts_js() {
"*://test1.example.com/*",
"*://example.org/*",
],
runAt: "document_idle",
},
{
id: "script-4",
allFrames: false,
js: ["script-4-1.js", "script-4-2.js"],
matches: ["*://test1.example.com/*"],
runAt: "document_idle",
},
{
id: "script-5",
@ -444,6 +448,7 @@ add_task(async function test_registerContentScripts_js() {
excludeMatches: [],
js: ["script-5.js"],
matches: ["*://test1.example.com/*"],
runAt: "document_idle",
},
]),
JSON.stringify(scripts),

195
toolkit/components/extensions/test/xpcshell/test_ext_scripting_contentScripts.js Normal file
View File

@ -0,0 +1,195 @@
"use strict";
const server = createHttpServer();
server.registerDirectory("/data/", do_get_file("data"));
const BASE_URL = `http://localhost:${server.identity.primaryPort}/data`;
// ExtensionContent.jsm needs to know when it's running from xpcshell, to use
// the right timeout for content scripts executed at document_idle.
ExtensionTestUtils.mockAppInfo();
Services.prefs.setBoolPref("extensions.manifestV3.enabled", true);
const makeExtension = ({ manifest: manifestProps, ...otherProps }) => {
return ExtensionTestUtils.loadExtension({
manifest: {
manifest_version: 3,
permissions: ["scripting"],
...manifestProps,
},
...otherProps,
});
};
add_task(async function test_registerContentScripts_runAt() {
let extension = makeExtension({
async background() {
const TEST_CASES = [
{
title: "runAt: document_idle",
params: [
{
id: "script-idle",
js: ["script-idle.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_idle",
},
],
},
{
title: "no runAt specified",
params: [
{
id: "script-idle-default",
js: ["script-idle-default.js"],
matches: ["http://*/*/file_sample.html"],
// `runAt` defaults to `document_idle`.
},
],
},
{
title: "runAt: document_end",
params: [
{
id: "script-end",
js: ["script-end.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_end",
},
],
},
{
title: "runAt: document_start",
params: [
{
id: "script-start",
js: ["script-start.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_start",
},
],
},
];
let scripts = await browser.scripting.getRegisteredContentScripts();
browser.test.assertEq(0, scripts.length, "expected no registered script");
for (const { title, params } of TEST_CASES) {
const res = await browser.scripting.registerContentScripts(params);
browser.test.assertEq(undefined, res, `${title} - expected no result`);
}
scripts = await browser.scripting.getRegisteredContentScripts();
browser.test.assertEq(
TEST_CASES.length,
scripts.length,
`expected ${TEST_CASES.length} registered scripts`
);
browser.test.assertEq(
JSON.stringify([
{
id: "script-idle",
allFrames: false,
js: ["script-idle.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_idle",
},
{
id: "script-idle-default",
allFrames: false,
js: ["script-idle-default.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_idle",
},
{
id: "script-end",
allFrames: false,
js: ["script-end.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_end",
},
{
id: "script-start",
allFrames: false,
js: ["script-start.js"],
matches: ["http://*/*/file_sample.html"],
runAt: "document_start",
},
]),
JSON.stringify(scripts),
"got expected scripts"
);
browser.test.sendMessage("background-ready");
},
files: {
"script-start.js": () => {
browser.test.assertEq(
"loading",
document.readyState,
"expected state 'loading' at document_start"
);
browser.test.sendMessage("script-ran", "script-start.js");
},
"script-end.js": () => {
browser.test.assertTrue(
["interactive", "complete"].includes(document.readyState),
`expected state 'interactive' or 'complete' at document_end, got: ${document.readyState}`
);
browser.test.sendMessage("script-ran", "script-end.js");
},
"script-idle.js": () => {
browser.test.assertEq(
"complete",
document.readyState,
"expected state 'complete' at document_idle"
);
browser.test.sendMessage("script-ran", "script-idle.js");
},
"script-idle-default.js": () => {
browser.test.assertEq(
"complete",
document.readyState,
"expected state 'complete' at document_idle"
);
browser.test.sendMessage("script-ran", "script-idle-default.js");
},
},
});
let scriptsRan = [];
let completePromise = new Promise(resolve => {
extension.onMessage("script-ran", result => {
scriptsRan.push(result);
// The value below should be updated when TEST_CASES above is changed.
if (scriptsRan.length === 4) {
resolve();
}
});
});
await extension.startup();
await extension.awaitMessage("background-ready");
let contentPage = await ExtensionTestUtils.loadContentPage(
`${BASE_URL}/file_sample.html`
);
await completePromise;
Assert.deepEqual(
[
"script-start.js",
"script-end.js",
"script-idle.js",
"script-idle-default.js",
],
scriptsRan,
"got expected executed scripts"
);
await contentPage.close();
await extension.unload();
});

1
toolkit/components/extensions/test/xpcshell/xpcshell-common.ini
View File

@ -185,6 +185,7 @@ skip-if = os == "android" # Android: Bug 1700482
[test_ext_sandboxed_resource.js]
[test_ext_schema.js]
[test_ext_script_filenames.js]
[test_ext_scripting_contentScripts.js]
[test_ext_scripting_contentScripts_file.js]
[test_ext_shared_workers.js]
[test_ext_shutdown_cleanup.js]