Skip to content

fix: avoid browser tabs content scripts memory leak #864

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
ACTCD merged 2 commits into from
Aug 30, 2025
Merged

fix: avoid browser tabs content scripts memory leak #864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56587c8
refactor: add once option to the listeners
ACTCD Aug 30, 2025
7e9301b
fix: dynamically remove listeners when tab unload
ACTCD Aug 30, 2025
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
23 changes: 18 additions & 5 deletions src/ext/content-scripts/entry-script-market.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ async function injection() {
);
}
for (const link of links) {
if (link["href"]) url = link["href"];
link.addEventListener(
"click",
(e) => {
url = link["href"];
e.stopImmediatePropagation();
e.preventDefault();
browser.runtime.sendMessage({ name: "WEB_USERJS_POPUP" });
Expand All @@ -23,14 +23,27 @@ async function injection() {
}

async function listeners() {
browser.runtime.onMessage.addListener(async (message) => {
/**
* handle messages from background, popup, etc...
* @type {import("webextension-polyfill").Runtime.OnMessageListener}
*/
const handleMessage = async (message) => {
if (import.meta.env.MODE === "development") {
console.debug(message, url);
}
if (message === "TAB_CLICK_USERJS") {
const response = url;
url = undefined; // respond only once of click event
return response;
return url;
}
};
/** Dynamically remove listeners to avoid memory leaks */
if (document.visibilityState === "visible") {
browser.runtime.onMessage.addListener(handleMessage);
}
document.addEventListener("visibilitychange", () => {
if (document.hidden) {
browser.runtime.onMessage.removeListener(handleMessage);
} else {
browser.runtime.onMessage.addListener(handleMessage);
}
});
}
Expand Down
43 changes: 31 additions & 12 deletions src/ext/content-scripts/entry-userscripts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,23 @@ function triageJS(userscript) {
if (document.readyState !== "loading") {
injectJS(userscript);
} else {
document.addEventListener("DOMContentLoaded", () => {
injectJS(userscript);
});
document.addEventListener(
"DOMContentLoaded",
() => injectJS(userscript),
{ once: true },
);
}
} else if (runAt === "document-idle") {
if (document.readyState === "complete") {
injectJS(userscript);
} else {
document.addEventListener("readystatechange", () => {
const handle = () => {
if (document.readyState === "complete") {
injectJS(userscript);
document.removeEventListener("readystatechange", handle);
}
});
};
document.addEventListener("readystatechange", handle);
}
}
}
Expand Down Expand Up @@ -233,17 +237,23 @@ async function injection() {
}

function listeners() {
// listens for messages from background, popup, etc...
browser.runtime.onMessage.addListener((request) => {
const name = request.name;
/** listen for CSP violations */
document.addEventListener("securitypolicyviolation", cspFallback, {
once: true,
});
/**
* listens for messages from background, popup, etc...
* @type {import("webextension-polyfill").Runtime.OnMessageListener}
*/
const handleMessage = (message) => {
const name = message.name;
if (name === "CONTEXT_RUN") {
// from bg script when context-menu item is clicked
// double check to ensure context-menu scripts only run in top windows
if (window !== window.top) return;

// loop through context-menu scripts saved to data object and find match
// if no match found, nothing will execute and error will log
const filename = request.menuItemId;
const filename = message.menuItemId;
for (let i = 0; i < data.files.menu.length; i++) {
const item = data.files.menu[i];
if (item.scriptObject.filename === filename) {
Expand All @@ -254,9 +264,18 @@ function listeners() {
}
console.error(`Couldn't find ${filename} code!`);
}
};
/** Dynamically remove listeners to avoid memory leaks */
if (document.visibilityState === "visible") {
browser.runtime.onMessage.addListener(handleMessage);
}
document.addEventListener("visibilitychange", () => {
if (document.hidden) {
browser.runtime.onMessage.removeListener(handleMessage);
} else {
browser.runtime.onMessage.addListener(handleMessage);
}
});
// listen for CSP violations
document.addEventListener("securitypolicyviolation", cspFallback);
}

async function initialize() {
Expand Down