Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: browser.devtools.inspectedWindow.eval promise should always resolve to an array #175

Merged
merged 3 commits into from
Feb 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,8 @@
"inspectedWindow": {
"eval": {
"minArgs": 1,
"maxArgs": 2
"maxArgs": 2,
"singleCallbackArg": false
}
},
"panels": {
Expand Down
3 changes: 2 additions & 1 deletion src/browser-polyfill.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ if (typeof browser === "undefined" || Object.getPrototypeOf(browser) !== Object.
return (...callbackArgs) => {
if (extensionAPIs.runtime.lastError) {
promise.reject(extensionAPIs.runtime.lastError);
} else if (metadata.singleCallbackArg || callbackArgs.length <= 1) {
} else if (metadata.singleCallbackArg ||
(callbackArgs.length <= 1 && metadata.singleCallbackArg !== false)) {
promise.resolve(callbackArgs[0]);
} else {
promise.resolve(callbackArgs);
Expand Down
12 changes: 12 additions & 0 deletions test/fixtures/devtools-extension/background.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
let onDevToolsPageLoaded = new Promise(resolve => {
const listener = () => {
browser.runtime.onConnect.removeListener(listener);
resolve();
};
browser.runtime.onConnect.addListener(listener);
});

browser.runtime.onMessage.addListener(async msg => {
await onDevToolsPageLoaded;
return browser.runtime.sendMessage(msg);
});
30 changes: 30 additions & 0 deletions test/fixtures/devtools-extension/content.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
test("devtools.inspectedWindow.eval resolved with an error result", async (t) => {
const {evalResult} = await browser.runtime.sendMessage({
apiMethod: "devtools.inspectedWindow.eval",
params: ["throw new Error('fake error');"],
});

t.ok(Array.isArray(evalResult), "devtools.inspectedWindow.eval should resolve to an array");

t.equal(evalResult[0], navigator.userAgent.includes("Firefox/") ? undefined : null,
"the first element should be null (on chrome) or undefined (on firefox)");

t.ok(evalResult[1].isException, "the second element should represent an exception");
t.ok(evalResult[1].value && evalResult[1].value.includes("fake error"),
"the second element value property should include the expected error message");
});

test("devtools.inspectedWindow.eval resolved without an error result", async (t) => {
const {evalResult} = await browser.runtime.sendMessage({
apiMethod: "devtools.inspectedWindow.eval",
params: ["[document.documentElement.localName]"],
});

t.ok(Array.isArray(evalResult), "devtools.inspectedWindow.eval should resolve to an array");

if (navigator.userAgent.includes("Firefox/")) {
t.deepEqual(evalResult, [["html"], undefined], "got the expected values in the array");
} else {
t.deepEqual(evalResult, [["html"]], "got the expected values in the array");
}
});
7 changes: 7 additions & 0 deletions test/fixtures/devtools-extension/devtools_page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<script src="browser-polyfill.js"></script>
<script src="devtools_page.js"></script>
</head>
</html>
14 changes: 14 additions & 0 deletions test/fixtures/devtools-extension/devtools_page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
console.log("devtools page loaded");

browser.runtime.onMessage.addListener(async msg => {
switch (msg.apiMethod) {
case "devtools.inspectedWindow.eval": {
const evalResult = await browser.devtools.inspectedWindow.eval(...msg.params);
return {evalResult};
}
}

throw new Error(`devtools_page received an unxpected message: ${msg}`);
});

browser.runtime.connect({name: "devtools_page"});
27 changes: 27 additions & 0 deletions test/fixtures/devtools-extension/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"manifest_version": 2,
"name": "test-extension-devtools-api",
"version": "0.1",
"description": "test-extension-devtools-api",
"content_scripts": [
{
"matches": [
"http://localhost/*"
],
"js": [
"browser-polyfill.js",
"tape.js",
"content.js"
],
"run_at": "document_end"
}
],
"permissions": [],
"background": {
"scripts": [
"browser-polyfill.js",
"background.js"
]
},
"devtools_page": "devtools_page.html"
}
13 changes: 11 additions & 2 deletions test/integration/setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const TEST_TIMEOUT = 5000;
const launchBrowser = async (launchOptions) => {
const browser = launchOptions.browser;
const extensionPath = launchOptions.extensionPath;
const openDevTools = launchOptions.openDevTools;

let driver;

Expand All @@ -37,6 +38,10 @@ const launchBrowser = async (launchOptions) => {
"--no-sandbox",
]);

if (openDevTools) {
options.addArguments(["-auto-open-devtools-for-tabs"]);
}

if (process.env.TEST_NATIVE_CRX_BINDINGS === "1") {
console.warn("NOTE: Running tests on a Chrome instance with NativeCrxBindings enabled.");
options.addArguments([
Expand All @@ -60,6 +65,10 @@ const launchBrowser = async (launchOptions) => {
options.headless();
}

if (openDevTools) {
options.addArguments("-devtools");
}

driver = await new Builder()
.forBrowser("firefox")
.setFirefoxOptions(options)
Expand Down Expand Up @@ -157,7 +166,7 @@ test.onFailure(() => {
* @param {string[]} parameters.extensions
* @param {boolean|string|string[]} [parameters.skip]
*/
const defineExtensionTests = ({description, extensions, skip}) => {
const defineExtensionTests = ({description, extensions, skip, openDevTools}) => {
for (const extensionDirName of extensions) {
test(`${description} (test extension: ${extensionDirName})`, async (tt) => {
let timeout;
Expand Down Expand Up @@ -192,7 +201,7 @@ const defineExtensionTests = ({description, extensions, skip}) => {
await bundleTapeStandalone(extensionPath);

server = await createHTTPServer(path.join(__dirname, "..", "fixtures"));
driver = await launchBrowser({extensionPath, browser});
driver = await launchBrowser({extensionPath, browser, openDevTools});
await Promise.race([
runExtensionTest(tt, server, driver, extensionDirName, browser),
new Promise((resolve, reject) => {
Expand Down
6 changes: 6 additions & 0 deletions test/integration/test-extensions-in-browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,9 @@ defineExtensionTests({
description: "Instance of BrowserSetting API",
extensions: ["privacy-setting-extension"],
});

defineExtensionTests({
description: "browser.devtools",
extensions: ["devtools-extension"],
openDevTools: true,
});