Skip to content

fix: avoid potentially infinite hangs on async messages #669

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 12, 2024
Merged

fix: avoid potentially infinite hangs on async messages #669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
112 changes: 62 additions & 50 deletions src/ext/background/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,13 +291,16 @@ async function nativeChecks() {
}

/**
* handles messages sent with browser.runtime.sendMessage
* Handles messages sent with `browser.runtime.sendMessage`
* Make sure not to return `undefined` or `rejection`, otherwise the reply may never be delivered
* @see {@link https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/onMessage#listener}
* @type {Parameters<typeof browser.runtime.onMessage.addListener>[0]}
* @param {(response: any) => void} sendResponse send a response to the message
* @returns {Promise<{status: "pending"|"fulfilled"|"rejected", result: any}>}
*/
async function handleMessage(request, sender, sendResponse) {
switch (request.name) {
async function handleMessage(message, sender) {
/** @type {Promise} */
let promise;
switch (message.name) {
case "REQ_USERSCRIPTS": {
// get the page url from the content script that sent request
const url = sender.url;
Expand All @@ -306,73 +309,75 @@ async function handleMessage(request, sender, sendResponse) {
const isTop = sender.frameId === 0;
// send request to swift layer to provide code for page url
const message = { name: "REQ_USERSCRIPTS", url, isTop };
const response = await sendNativeMessage(message);
if (import.meta.env.MODE === "development") {
console.debug("REQ_USERSCRIPTS", message, response);
try {
const response = await sendNativeMessage(message);
if (import.meta.env.MODE === "development") {
console.debug("REQ_USERSCRIPTS", message, response);
}
// if request failed, send error to content script for logging
if (response.error) return response;
// sort files
response.files.js.sort(userscriptSort);
response.files.css.sort((a, b) => Number(a.weight) < Number(b.weight));
// return sorted files for injection
return response;
} catch (error) {
console.error(error);
// @ts-ignore -- ignore for now and will reconstruct this in the future.
return { error };
}
// if request failed, send error to content script for logging
if (response.error) return sendResponse(response);
// sort files
response.files.js.sort(userscriptSort);
response.files.css.sort((a, b) => {
return Number(a.weight) < Number(b.weight);
});
// return sorted files for injection
return response;
}
case "API_CLOSE_TAB": {
const tabId = request.tabId || sender.tab.id;
return browser.tabs.remove(tabId);
promise = browser.tabs.remove(message.tabId || sender.tab.id);
break;
}
case "API_OPEN_TAB": {
const props = {
active: request.active,
promise = browser.tabs.create({
active: message.active,
index: sender.tab.index + 1,
url: request.url,
};
return browser.tabs.create(props);
url: message.url,
});
break;
}
case "API_ADD_STYLE": {
const tabId = sender.tab.id;
/** @type {import("webextension-polyfill").ExtensionTypes.InjectDetails} */
const details = { code: request.css, cssOrigin: "user" };
return browser.tabs.insertCSS(tabId, details);
promise = browser.tabs.insertCSS(sender.tab.id, {
code: message.css,
cssOrigin: "user",
});
break;
}
case "API_GET_TAB": {
let tab = null;
if (typeof sender.tab !== "undefined") {
if (typeof sender.tab === "undefined") {
const error = "unable to deliver tab due to empty tab id";
return { status: "rejected", result: error };
}
try {
const tabData = sessionStorage.getItem(`tab-${sender.tab.id}`);
try {
// if tabData is null, can still parse it and return that
tab = JSON.parse(tabData);
} catch (error) {
console.error("failed to parse tab data for getTab", error);
}
} else {
console.error("unable to deliver tab due to empty tab id");
// if tabData is null, can still parse it and return that
const tabObj = JSON.parse(tabData);
return { status: "fulfilled", result: tabObj };
} catch (error) {
console.error("failed to parse tab data for getTab", error);
return { status: "rejected", result: error };
}
sendResponse(tab == null ? {} : tab);
break;
}
case "API_SAVE_TAB": {
if (sender.tab != null && sender.tab.id) {
const key = `tab-${sender.tab.id}`;
sessionStorage.setItem(key, JSON.stringify(request.tab));
sendResponse({ success: true });
sessionStorage.setItem(key, JSON.stringify(message.tabObj));
return { status: "fulfilled", result: undefined };
} else {
console.error("unable to save tab, empty tab id");
sendResponse({ success: false });
const error = "unable to save tab, empty tab id";
return { status: "rejected", result: error };
}
break;
}
case "API_SET_CLIPBOARD": {
const result = setClipboard(request.clipboardData, request.type);
sendResponse(result);
break;
const result = setClipboard(message.clipboardData, message.type);
return { status: "fulfilled", result };
}
case "API_XHR": {
// parse details and set up for XMLHttpRequest
const details = request.details;
const details = message.details;
const method = details.method ? details.method : "GET";
const user = details.user || null;
const password = details.password || null;
Expand All @@ -387,7 +392,7 @@ async function handleMessage(request, sender, sendResponse) {
}
// establish a long-lived port connection to content script
const port = browser.tabs.connect(sender.tab.id, {
name: request.xhrPortName,
name: message.xhrPortName,
});
// set up XMLHttpRequest
const xhr = new XMLHttpRequest();
Expand All @@ -397,7 +402,7 @@ async function handleMessage(request, sender, sendResponse) {
xhr.overrideMimeType(details.overrideMimeType);
}
// add required listeners and send result back to the content script
for (const e of request.events) {
for (const e of message.events) {
if (!details[e]) continue;
xhr[e] = async (event) => {
// can not send xhr through postMessage
Expand Down Expand Up @@ -487,6 +492,13 @@ async function handleMessage(request, sender, sendResponse) {
break;
}
}
try {
const result = await promise;
return { status: "fulfilled", result };
} catch (error) {
console.error(message, sender, error);
return { status: "rejected", result: error };
}
}
browser.runtime.onInstalled.addListener(async () => {
await nativeChecks();
Expand Down
39 changes: 26 additions & 13 deletions src/ext/content-scripts/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,43 +52,56 @@ async function listValues() {
return keys;
}

async function sendMessageProxy(message) {
try {
/** @type {{status: "fulfilled"|"rejected", result: any}} */
const response = await browser.runtime.sendMessage(message);
if (response.status === "fulfilled") {
return response.result;
} else {
return Promise.reject(response.result);
}
} catch (error) {
console.error(error);
return Promise.reject(error);
}
}

async function openInTab(url, openInBackground = false) {
try {
new URL(url);
} catch (error) {
return Promise.reject(error);
}
return browser.runtime.sendMessage({
return sendMessageProxy({
name: "API_OPEN_TAB",
url,
active: !openInBackground,
});
}

async function getTab() {
return browser.runtime.sendMessage({ name: "API_GET_TAB" });
async function closeTab(tabId) {
return sendMessageProxy({ name: "API_CLOSE_TAB", tabId });
}

async function saveTab(tab) {
if (tab == null) {
return Promise.reject(new Error("saveTab invalid arg"));
}
return browser.runtime.sendMessage({ name: "API_SAVE_TAB", tab });
async function getTab() {
return sendMessageProxy({ name: "API_GET_TAB" });
}

async function closeTab(tabId) {
return browser.runtime.sendMessage({ name: "API_CLOSE_TAB", tabId });
async function saveTab(tabObj) {
if (tabObj == null) return Promise.reject(new Error("saveTab invalid arg"));
return sendMessageProxy({ name: "API_SAVE_TAB", tabObj });
}

async function addStyle(css) {
if (typeof css !== "string" || !css.length) {
return Promise.reject(new Error("addStyle invalid css arg"));
}
return browser.runtime.sendMessage({ name: "API_ADD_STYLE", css });
return sendMessageProxy({ name: "API_ADD_STYLE", css });
}

async function setClipboard(clipboardData, type) {
return browser.runtime.sendMessage({
return sendMessageProxy({
name: "API_SET_CLIPBOARD",
clipboardData,
type,
Expand Down Expand Up @@ -174,7 +187,7 @@ function xhr(details) {
xhrPortName,
events,
};
browser.runtime.sendMessage(message);
sendMessageProxy(message);
return response;
}

Expand Down
Loading