Improve engine events to expose internal workflow

packages/adblocker-electron-example/index.ts

@@ -1,8 +1,15 @@
-import { app, BrowserWindow } from 'electron';
 import fetch from 'cross-fetch';
+import { app, BrowserWindow } from 'electron';
 import { readFileSync, writeFileSync } from 'fs';
 
-import { ElectronBlocker, fullLists, Request } from '@cliqz/adblocker-electron';
+import {
+  CosmeticFilter,
+  ElectronBlocker,
+  fullLists,
+  NetworkFilter,
+  Request,
+} from '@cliqz/adblocker-electron';
+import { MatchingContext } from '@cliqz/adblocker';
 
 function getUrlToLoad(): string {
   let url = 'https://google.com';
@@ -41,6 +48,10 @@ async function createWindow() {
 
   blocker.enableBlockingInSession(mainWindow.webContents.session);
 
+  blocker.on('request-allowed', (request: Request) => {
+    console.log('allow', request.tabId, request.url);
+  });
+
   blocker.on('request-blocked', (request: Request) => {
     console.log('blocked', request.tabId, request.url);
   });
@@ -53,8 +64,8 @@ async function createWindow() {
     console.log('whitelisted', request.tabId, request.url);
   });
 
-  blocker.on('csp-injected', (request: Request) => {
-    console.log('csp', request.url);
+  blocker.on('csp-injected', (csps: string, request: Request) => {
+    console.log('csp', csps, request.url);
   });
 
   blocker.on('script-injected', (script: string, url: string) => {
@@ -65,6 +76,13 @@ async function createWindow() {
     console.log('style', style.length, url);
   });
 
+  blocker.on(
+    'filter-matched',
+    (filter: CosmeticFilter | NetworkFilter, context: MatchingContext) => {
+      console.log('filter-matched', filter, context);
+    },
+  );
+
   mainWindow.loadURL(getUrlToLoad());
   mainWindow.webContents.openDevTools();
 

packages/adblocker-electron/adblocker.ts

@@ -186,6 +186,11 @@ export class ElectronBlocker extends FiltersEngine {
       getExtendedRules: true,
       getRulesFromHostname: true,
       getRulesFromDOM: false, // Only done on updates (see `onGetCosmeticFiltersUpdated`)
+
+      callerContext: {
+        frameId: event.frameId,
+        processId: event.processId,
+      },
     });
 
     if (active === false) {
@@ -233,6 +238,13 @@ export class ElectronBlocker extends FiltersEngine {
 
       // This will be done every time we get information about DOM mutation
       getRulesFromDOM: true,
+
+      callerContext: {
+        frameId: event.frameId,
+        processId: event.processId,
+
+        lifecycle: msg.lifecycle,
+      },
     });
 
     if (active === false) {

packages/adblocker-playwright-example/index.ts

@@ -17,6 +17,10 @@ import * as pw from 'playwright';
 
   await blocker.enableBlockingInPage(page);
 
+  blocker.on('request-allowed', (request: Request) => {
+    console.log('allow', request.url);
+  });
+
   blocker.on('request-blocked', (request: Request) => {
     console.log('blocked', request.url);
   });
@@ -29,19 +33,26 @@ import * as pw from 'playwright';
     console.log('whitelisted', request.url);
   });
 
-  blocker.on('csp-injected', (request: Request) => {
-    console.log('csp', request.url);
+  blocker.on('csp-injected', (csps: string, request: Request) => {
+    console.log('csp', request.url, csps);
   });
 
   blocker.on('script-injected', (script: string, url: string) => {
-    console.log('script', script.length, url);
+    console.log('script', url, script.length);
   });
 
   blocker.on('style-injected', (style: string, url: string) => {
-    console.log('style', style.length, url);
+    console.log('style', url, style.length);
   });
 
-  await page.goto('https://www.mangareader.to/');
+  blocker.on(
+    'filter-matched',
+    (filter: CosmeticFilter | NetworkFilter, context: MatchingContext) => {
+      console.log('filter-matched', filter, context);
+    },
+  );
+
+  await page.goto('https://www.mangareader.net/');
   await page.screenshot({ path: 'output.png' });
   await blocker.disableBlockingInPage(page);
   await browser.close();

packages/adblocker-puppeteer-example/index.ts

@@ -1,7 +1,7 @@
 import { fullLists, PuppeteerBlocker, Request } from '@cliqz/adblocker-puppeteer';
 import fetch from 'cross-fetch';
+import fs from 'fs/promises';
 import * as puppeteer from 'puppeteer';
-import { promises as fs } from 'fs';
 
 function getUrlToLoad(): string {
   let url = 'https://www.mangareader.to/';
@@ -35,6 +35,10 @@ function getUrlToLoad(): string {
   const page = await browser.newPage();
   await blocker.enableBlockingInPage(page);
 
+  blocker.on('request-allowed', (request: Request) => {
+    console.log('allow', request.url);
+  });
+
   blocker.on('request-blocked', (request: Request) => {
     console.log('blocked', request.url);
   });
@@ -47,17 +51,24 @@ function getUrlToLoad(): string {
     console.log('whitelisted', request.url);
   });
 
-  blocker.on('csp-injected', (request: Request) => {
-    console.log('csp', request.url);
+  blocker.on('csp-injected', (csps: string, request: Request) => {
+    console.log('csp', request.url, csps.length);
   });
 
   blocker.on('script-injected', (script: string, url: string) => {
-    console.log('script', script.length, url);
+    console.log('script', url, script.length);
   });
 
   blocker.on('style-injected', (style: string, url: string) => {
-    console.log('style', style.length, url);
+    console.log('style', url, style.length);
   });
 
+  blocker.on(
+    'filter-matched',
+    (filter: CosmeticFilter | NetworkFilter, context: MatchingContext) => {
+      console.log('filter-matched', filter, context);
+    },
+  );
+
   await page.goto(getUrlToLoad());
 })();

packages/adblocker-webextension-example/background.ts

@@ -10,11 +10,14 @@ import { browser } from 'webextension-polyfill-ts';
 
 import {
   BlockingResponse,
+  CosmeticFilter,
   fullLists,
   HTMLSelector,
+  NetworkFilter,
   Request,
   WebExtensionBlocker,
 } from '@cliqz/adblocker-webextension';
+import { MatchingContext } from '@cliqz/adblocker';
 
 /**
  * Keep track of number of network requests altered for each tab
@@ -62,6 +65,11 @@ WebExtensionBlocker.fromLists(fetch, fullLists, {
 }).then((blocker: WebExtensionBlocker) => {
   blocker.enableBlockingInBrowser(browser);
 
+  blocker.on('request-allowed', (request: Request, result: BlockingResponse) => {
+    incrementBlockedCounter(request, result);
+    console.log('allow', request.url);
+  });
+
   blocker.on('request-blocked', (request: Request, result: BlockingResponse) => {
     incrementBlockedCounter(request, result);
     console.log('block', request.url);
@@ -72,21 +80,33 @@ WebExtensionBlocker.fromLists(fetch, fullLists, {
     console.log('redirect', request.url, result);
   });
 
-  blocker.on('csp-injected', (request: Request) => {
-    console.log('csp', request.url);
+  blocker.on('request-whitelisted', (request: Request, result: BlockingResponse) => {
+    incrementBlockedCounter(request, result);
+    console.log('whitelist', request.url, result);
+  });
+
+  blocker.on('html-filtered', (htmlSelectors: HTMLSelector[], url: string) => {
+    console.log('html selectors', url, htmlSelectors);
+  });
+
+  blocker.on('csp-injected', (csps: string, request: Request) => {
+    console.log('csp', request.url, csps.length);
   });
 
   blocker.on('script-injected', (script: string, url: string) => {
-    console.log('script', script.length, url);
+    console.log('script', url, script.length);
   });
 
   blocker.on('style-injected', (style: string, url: string) => {
     console.log('style', url, style.length);
   });
 
-  blocker.on('html-filtered', (htmlSelectors: HTMLSelector[]) => {
-    console.log('html selectors', htmlSelectors);
-  });
+  blocker.on(
+    'filter-matched',
+    (filter: CosmeticFilter | NetworkFilter, context: MatchingContext) => {
+      console.log('filter-matched', filter, context);
+    },
+  );
 
   console.log('Ready to roll!');
 });

packages/adblocker-webextension/adblocker.ts

@@ -347,6 +347,11 @@ export class WebExtensionBlocker extends FiltersEngine {
       getExtendedRules: false,
       getRulesFromDOM: false,
       getRulesFromHostname: true,
+
+      callerContext: {
+        tabId: details.tabId,
+        frameId: details.frameId,
+      },
     });
     if (active === false) {
       return;
@@ -460,6 +465,11 @@ export class WebExtensionBlocker extends FiltersEngine {
         getExtendedRules: false,
         getRulesFromDOM: false,
         getRulesFromHostname: false,
+
+        callerContext: {
+          tabId: sender.tab?.id,
+          frameId: sender.frameId,
+        },
       });
 
       if (active === false) {
@@ -497,6 +507,11 @@ export class WebExtensionBlocker extends FiltersEngine {
 
         // This will be done every time we get information about DOM mutation
         getRulesFromDOM: msg.lifecycle === 'dom-update',
+
+        callerContext: {
+          tabId: sender.tab?.id,
+          frameId: sender.frameId,
+        },
       });
 
       if (active === false) {

packages/adblocker/adblocker.ts

@@ -6,7 +6,12 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-export { default as FiltersEngine, ENGINE_VERSION, BlockingResponse } from './src/engine/engine';
+export {
+  default as FiltersEngine,
+  ENGINE_VERSION,
+  BlockingResponse,
+  MatchingContext,
+} from './src/engine/engine';
 export { default as ReverseIndex } from './src/engine/reverse-index';
 export {
   default as Request,