Skip to content

packages: adblocker-electron: conditionally enable webRequest handlers #4438

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

Draft
seg6 wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

packages: adblocker-electron: conditionally enable webRequest handlers #4438

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
fcd5513
packages: adblocker-electron: conditionally enable `webRequest` handlers
Nov 8, 2024
9df6abf
Merge branch 'master' of github.com:deta/adblocker into brkp/electron…
aavshr Jul 1, 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
10 changes: 9 additions & 1 deletion packages/adblocker-electron-example/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,15 @@ async function createWindow() {
},
);

blocker.enableBlockingInSession(mainWindow.webContents.session);
blocker.enableBlockingInSession(mainWindow.webContents.session, false);
mainWindow.webContents.session.webRequest.onHeadersReceived(
{ urls: ['<all_urls>'] },
blocker.onHeadersReceived,
);
mainWindow.webContents.session.webRequest.onBeforeRequest(
{ urls: ['<all_urls>'] },
blocker.onBeforeRequest,
);

blocker.on('request-blocked', (request: Request) => {
console.log('blocked', request.tabId, request.url);
Expand Down
21 changes: 9 additions & 12 deletions packages/adblocker-electron/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ export class BlockingContext {
constructor(
private readonly session: Electron.Session,
private readonly blocker: ElectronBlocker,
private readonly registerWebRequestHandlers: boolean,
) {
this.registerWebRequestHandlers = registerWebRequestHandlers;
this.onBeforeRequest = (details, callback) => blocker.onBeforeRequest(details, callback);

this.onInjectCosmeticFilters = (event, url, msg) =>
Expand All @@ -92,22 +94,14 @@ export class BlockingContext {
);
}

if (this.blocker.config.loadNetworkFilters === true) {
if (this.blocker.config.loadNetworkFilters === true && this.registerWebRequestHandlers) {
this.session.webRequest.onHeadersReceived({ urls: ['<all_urls>'] }, this.onHeadersReceived);
this.session.webRequest.onBeforeRequest({ urls: ['<all_urls>'] }, this.onBeforeRequest);
}
}

public disable(): void {
if (this.blocker.config.loadNetworkFilters === true) {
// NOTE - there is currently no support in Electron for multiple
// webRequest listeners registered for the same event. This means that
// adblocker's listeners can be overriden by other ones in the same
// application (or that the adblocker can override another listener
// registered previously). Because of this, the only way to disable the
// adblocker is to remove all listeners for the events we are interested
// in. In the future, we should consider implementing a webRequest
// pipeline allowing to register multiple listeners for the same event.
if (this.blocker.config.loadNetworkFilters === true && this.registerWebRequestHandlers) {
this.session.webRequest.onHeadersReceived(null);
this.session.webRequest.onBeforeRequest(null);
}
Expand All @@ -131,14 +125,17 @@ export class ElectronBlocker extends FiltersEngine {
// Helpers to enable and disable blocking for 'browser'
// ----------------------------------------------------------------------- //

public enableBlockingInSession(session: Electron.Session): BlockingContext {
public enableBlockingInSession(
session: Electron.Session,
registerWebRequestHandlers: boolean = true,
): BlockingContext {
let context: undefined | BlockingContext = this.contexts.get(session);
if (context !== undefined) {
return context;
}

// Create new blocking context for `session`
context = new BlockingContext(session, this);
context = new BlockingContext(session, this, registerWebRequestHandlers);
this.contexts.set(session, context);
context.enable();

Expand Down