Rewrite logger's "exceptor" feature

gorhill · gorhill · commit a91781a4959c · 2022-12-14T16:04:45.000-05:00
Related issue: - uBlockOrigin/uBlock-issues#1861 The "exceptor" feature has been rewritten, with the following changes as a result: - The excepted filters cease to exist when closing the logger - It's now possible to temporary except network filters When toggling on/off a temporary exception, filter lists are now fully reloaded. This simplified managing temporary exceptions, and made it easy to implement temporary exception for network filters, but this also means there might be a perceptible delay when adding/removing temporary exceptions. At this point I consider this an acceptable side-effect just to bring the ability to easily create temporary exception for network filters, while this simplified the existing temporary exception code throughout.
diff --git a/platform/common/vapi-background.js b/platform/common/vapi-background.js
@@ -919,6 +919,9 @@ vAPI.messaging = {
                 this.onPortDisconnect(port);
             }
         }
+        if ( this.defaultHandler ) {
+            this.defaultHandler(message, null, ( ) => { });
+        }
     },
 
     onFrameworkMessage: function(request, port, callback) {
diff --git a/src/css/logger-ui.css b/src/css/logger-ui.css
@@ -678,6 +678,9 @@ body[dir="rtl"] #netFilteringDialog > .panes > .details > div > span:nth-of-type
     background-color: rgb(var(--primary-50) / 50%);
     }
 #netFilteringDialog > .panes > .details .exceptor::before {
+    content: '@@';
+    }
+#netFilteringDialog.extendedRealm > .panes > .details .exceptor::before {
     content: '#@#';
     }
 #netFilteringDialog > div.panes > .dynamic > .toolbar {
diff --git a/src/js/background.js b/src/js/background.js
@@ -211,6 +211,9 @@ const µBlock = {  // jshint ignore:line
     availableFilterLists: {},
     badLists: new Map(),
 
+    inMemoryFilters: [],
+    inMemoryFiltersCompiled: '',
+
     // https://github.com/uBlockOrigin/uBlock-issues/issues/974
     //   This can be used to defer filtering decision-making.
     readyToFilter: false,
diff --git a/src/js/cosmetic-filtering.js b/src/js/cosmetic-filtering.js
@@ -27,10 +27,7 @@ import './utils.js';
 import logger from './logger.js';
 import µb from './background.js';
 
-import {
-    StaticExtFilteringHostnameDB,
-    StaticExtFilteringSessionDB,
-} from './static-ext-filtering-db.js';
+import { StaticExtFilteringHostnameDB } from './static-ext-filtering-db.js';
 
 /******************************************************************************/
 /******************************************************************************/
@@ -236,10 +233,7 @@ const FilterContainer = function() {
     // specific filters
     this.specificFilters = new StaticExtFilteringHostnameDB(2);
 
-    // temporary filters
-    this.sessionFilterDB = new StaticExtFilteringSessionDB();
-
-    // low generic cosmetic filters: map of hash => array of selectors
+    // low generic cosmetic filters: map of hash => stringified selector list
     this.lowlyGeneric = new Map();
 
     // highly generic selectors sets
@@ -478,15 +472,6 @@ FilterContainer.prototype.compileSpecificSelector = function(
 
 /******************************************************************************/
 
-FilterContainer.prototype.compileTemporary = function(parser) {
-    return {
-        session: this.sessionFilterDB,
-        selector: parser.result.compiled,
-    };
-};
-
-/******************************************************************************/
-
 FilterContainer.prototype.fromCompiledContent = function(reader, options) {
     if ( options.skipCosmetic ) {
         this.skipCompiledContent(reader, 'SPECIFIC');
@@ -697,12 +682,6 @@ FilterContainer.prototype.disableSurveyor = function(details) {
 
 /******************************************************************************/
 
-FilterContainer.prototype.getSession = function() {
-    return this.sessionFilterDB;
-};
-
-/******************************************************************************/
-
 FilterContainer.prototype.cssRuleFromProcedural = function(json) {
     const pfilter = JSON.parse(json);
     if ( pfilter.cssable !== true ) { return; }
@@ -831,11 +810,6 @@ FilterContainer.prototype.retrieveSpecificSelectors = function(
             }
         }
 
-        // Retrieve temporary filters
-        if ( this.sessionFilterDB.isNotEmpty ) {
-            this.sessionFilterDB.retrieve([ null, exceptionSet ]);
-        }
-
         // Retrieve filters with a non-empty hostname
         this.specificFilters.retrieve(
             hostname,
diff --git a/src/js/html-filtering.js b/src/js/html-filtering.js
@@ -27,18 +27,14 @@ import logger from './logger.js';
 import µb from './background.js';
 import { sessionFirewall } from './filtering-engines.js';
 
-import {
-    StaticExtFilteringHostnameDB,
-    StaticExtFilteringSessionDB,
-} from './static-ext-filtering-db.js';
+import { StaticExtFilteringHostnameDB } from './static-ext-filtering-db.js';
 
 /******************************************************************************/
 
 const pselectors = new Map();
 const duplicates = new Set();
 
 const filterDB = new StaticExtFilteringHostnameDB(2);
-const sessionFilterDB = new StaticExtFilteringSessionDB();
 
 let acceptedCount = 0;
 let discardedCount = 0;
@@ -347,13 +343,6 @@ htmlFilteringEngine.compile = function(parser, writer) {
     }
 };
 
-htmlFilteringEngine.compileTemporary = function(parser) {
-    return {
-        session: sessionFilterDB,
-        selector: parser.result.compiled,
-    };
-};
-
 htmlFilteringEngine.fromCompiledContent = function(reader) {
     // Don't bother loading filters if stream filtering is not supported.
     if ( µb.canFilterResponseData === false ) { return; }
@@ -373,20 +362,13 @@ htmlFilteringEngine.fromCompiledContent = function(reader) {
     }
 };
 
-htmlFilteringEngine.getSession = function() {
-    return sessionFilterDB;
-};
-
 htmlFilteringEngine.retrieve = function(details) {
     const hostname = details.hostname;
 
     const plains = new Set();
     const procedurals = new Set();
     const exceptions = new Set();
 
-    if ( sessionFilterDB.isNotEmpty ) {
-        sessionFilterDB.retrieve([ null, exceptions ]);
-    }
     filterDB.retrieve(
         hostname,
         [ plains, exceptions, procedurals, exceptions ]
diff --git a/src/js/httpheader-filtering.js b/src/js/httpheader-filtering.js
@@ -28,16 +28,12 @@ import µb from './background.js';
 import { entityFromDomain } from './uri-utils.js';
 import { sessionFirewall } from './filtering-engines.js';
 
-import {
-    StaticExtFilteringHostnameDB,
-    StaticExtFilteringSessionDB,
-} from './static-ext-filtering-db.js';
+import { StaticExtFilteringHostnameDB } from './static-ext-filtering-db.js';
 
 /******************************************************************************/
 
 const duplicates = new Set();
 const filterDB = new StaticExtFilteringHostnameDB(1);
-const sessionFilterDB = new StaticExtFilteringSessionDB();
 
 const $headers = new Set();
 const $exceptions = new Set();
@@ -123,13 +119,6 @@ httpheaderFilteringEngine.compile = function(parser, writer) {
     }
 };
 
-httpheaderFilteringEngine.compileTemporary = function(parser) {
-    return {
-        session: sessionFilterDB,
-        selector: parser.result.compiled.slice(15, -1),
-    };
-};
-
 // 01234567890123456789
 // responseheader(name)
 //                ^   ^
@@ -152,10 +141,6 @@ httpheaderFilteringEngine.fromCompiledContent = function(reader) {
     }
 };
 
-httpheaderFilteringEngine.getSession = function() {
-    return sessionFilterDB;
-};
-
 httpheaderFilteringEngine.apply = function(fctxt, headers) {
     if ( filterDB.size === 0 ) { return; }
 
@@ -173,9 +158,6 @@ httpheaderFilteringEngine.apply = function(fctxt, headers) {
     $headers.clear();
     $exceptions.clear();
 
-    if ( sessionFilterDB.isNotEmpty ) {
-        sessionFilterDB.retrieve([ null, $exceptions ]);
-    }
     filterDB.retrieve(hostname, [ $headers, $exceptions ]);
     filterDB.retrieve(entity, [ $headers, $exceptions ], 1);
     if ( $headers.size === 0 ) { return; }
diff --git a/src/js/logger-ui.js b/src/js/logger-ui.js
@@ -1246,9 +1246,13 @@ const reloadTab = function(ev) {
         // Toggle temporary exception filter
         if ( tcl.contains('exceptor') ) {
             ev.stopPropagation();
+            const filter = filterFromTargetRow();
+            const exceptedFilter = dom.cl.has(targetRow, 'extendedRealm')
+                ? `#@#${filter.replace(/^.*?#@?#/, '')}`
+                : `@@${filter.replace(/^@@/, '')}`;
             const status = await messaging.send('loggerUI', {
-                what: 'toggleTemporaryException',
-                filter: filterFromTargetRow(),
+                what: 'toggleInMemoryFilter',
+                filter: exceptedFilter,
             });
             const row = target.closest('div');
             dom.cl.toggle(row, 'exceptored', status);
@@ -1477,26 +1481,16 @@ const reloadTab = function(ev) {
     const toSummaryPaneFilterNode = async function(receiver, filter) {
         receiver.children[1].textContent = filter;
         if ( filterAuthorMode !== true ) { return; }
-        const match = /#@?#/.exec(filter);
-        if ( match === null ) { return; }
-        const fragment = document.createDocumentFragment();
-        const pos = match.index + match[0].length;
-        fragment.appendChild(document.createTextNode(filter.slice(0, pos)));
-        const selector = filter.slice(pos);
-        const span = document.createElement('span');
-        span.className = 'filter';
-        span.textContent = selector;
-        fragment.appendChild(span);
+        if ( dom.cl.has(targetRow, 'canLookup') === false ) { return; }
+        const exceptedFilter = dom.cl.has(targetRow, 'extendedRealm')
+            ? `#@#${filter.replace(/^.*?#@?#/, '')}`
+            : `@@${filter.replace(/^@@/, '')}`;
         const isTemporaryException = await messaging.send('loggerUI', {
-            what: 'hasTemporaryException',
-            filter,
+            what: 'hasInMemoryFilter',
+            filter: exceptedFilter,
         });
         dom.cl.toggle(receiver, 'exceptored', isTemporaryException);
-        if ( match[0] === '##' || isTemporaryException ) {
-            receiver.children[2].style.visibility = '';
-        }
-        receiver.children[1].textContent = '';
-        receiver.children[1].appendChild(fragment);
+        receiver.children[2].style.visibility = '';
     };
 
     const fillSummaryPaneFilterList = async function(rows) {
diff --git a/src/js/logger.js b/src/js/logger.js
@@ -32,19 +32,15 @@ let writePtr = 0;
 const logBufferObsoleteAfter = 30 * 1000;
 
 const janitor = ( ) => {
-    if (
-        buffer !== null &&
-        lastReadTime < (Date.now() - logBufferObsoleteAfter)
-    ) {
-        logger.enabled = false;
-        buffer = null;
-        writePtr = 0;
-        logger.ownerId = undefined;
-        vAPI.messaging.broadcast({ what: 'loggerDisabled' });
-    }
-    if ( buffer !== null ) {
-        vAPI.setTimeout(janitor, logBufferObsoleteAfter);
+    if ( buffer === null ) { return; }
+    if ( lastReadTime >= (Date.now() - logBufferObsoleteAfter) ) {
+        return vAPI.setTimeout(janitor, logBufferObsoleteAfter);
     }
+    logger.enabled = false;
+    buffer = null;
+    writePtr = 0;
+    logger.ownerId = undefined;
+    vAPI.messaging.broadcast({ what: 'loggerDisabled' });
 };
 
 const boxEntry = function(details) {
diff --git a/src/js/messaging.js b/src/js/messaging.js
@@ -35,7 +35,6 @@ import logger from './logger.js';
 import lz4Codec from './lz4.js';
 import io from './assets.js';
 import scriptletFilteringEngine from './scriptlet-filtering.js';
-import staticExtFilteringEngine from './static-ext-filtering.js';
 import staticFilteringReverseLookup from './reverselookup.js';
 import staticNetFilteringEngine from './static-net-filtering.js';
 import µb from './background.js';
@@ -305,6 +304,10 @@ const onMessage = function(request, sender, callback) {
         µb.elementPickerExec(request.tabId, 0, request.targetURL, request.zap);
         break;
 
+    case 'loggerDisabled':
+        µb.clearInMemoryFilters();
+        break;
+
     case 'gotoURL':
         µb.openNewTab(request.details);
         break;
@@ -1680,49 +1683,25 @@ const getURLFilteringData = function(details) {
     return response;
 };
 
-const compileTemporaryException = function(filter) {
-    const parser = new StaticFilteringParser({
-        nativeCssHas: vAPI.webextFlavor.env.includes('native_css_has'),
-    });
-    parser.analyze(filter);
-    if ( parser.shouldDiscard() ) { return; }
-    return staticExtFilteringEngine.compileTemporary(parser);
-};
-
-const toggleTemporaryException = function(details) {
-    const result = compileTemporaryException(details.filter);
-    if ( result === undefined ) { return false; }
-    const { session, selector } = result;
-    if ( session.has(1, selector) ) {
-        session.remove(1, selector);
-        return false;
-    }
-    session.add(1, selector);
-    return true;
-};
-
-const hasTemporaryException = function(details) {
-    const result = compileTemporaryException(details.filter);
-    if ( result === undefined ) { return false; }
-    const { session, selector } = result;
-    return session && session.has(1, selector);
-};
-
 const onMessage = function(request, sender, callback) {
     // Async
     switch ( request.what ) {
     case 'readAll':
-        if (
-            logger.ownerId !== undefined &&
-            logger.ownerId !== request.ownerId
-        ) {
+        if ( logger.ownerId !== undefined && logger.ownerId !== request.ownerId ) {
             return callback({ unavailable: true });
         }
         vAPI.tabs.getCurrent().then(tab => {
             getLoggerData(request, tab && tab.id, callback);
         });
         return;
 
+    case 'toggleInMemoryFilter': {
+        const promise = µb.hasInMemoryFilter(request.filter)
+            ? µb.removeInMemoryFilter(request.filter)
+            : µb.addInMemoryFilter(request.filter);
+        promise.then(status => { callback(status); });
+        return;
+    }
     default:
         break;
     }
@@ -1731,14 +1710,14 @@ const onMessage = function(request, sender, callback) {
     let response;
 
     switch ( request.what ) {
-    case 'hasTemporaryException':
-        response = hasTemporaryException(request);
+    case 'hasInMemoryFilter':
+        response = µb.hasInMemoryFilter(request.filter);
         break;
 
     case 'releaseView':
-        if ( request.ownerId === logger.ownerId ) {
-            logger.ownerId = undefined;
-        }
+        if ( request.ownerId !== logger.ownerId ) { break; }
+        logger.ownerId = undefined;
+        µb.clearInMemoryFilters();
         break;
 
     case 'saveURLFilteringRules':
@@ -1761,10 +1740,6 @@ const onMessage = function(request, sender, callback) {
         response = getURLFilteringData(request);
         break;
 
-    case 'toggleTemporaryException':
-        response = toggleTemporaryException(request);
-        break;
-
     default:
         return vAPI.messaging.UNHANDLED;
     }
diff --git a/src/js/scriptlet-filtering.js b/src/js/scriptlet-filtering.js
diff --git a/src/js/static-ext-filtering-db.js b/src/js/static-ext-filtering-db.js
diff --git a/src/js/static-ext-filtering.js b/src/js/static-ext-filtering.js
diff --git a/src/js/storage.js b/src/js/storage.js

Original file line number	Diff line number	Diff line change
`@@ -919,6 +919,9 @@ vAPI.messaging = {`
`919`	`919`	`this.onPortDisconnect(port);`
`920`	`920`	`}`
`921`	`921`	`}`
	`922`	`+ if ( this.defaultHandler ) {`
	`923`	`+ this.defaultHandler(message, null, ( ) => { });`
	`924`	`+ }`
`922`	`925`	`},`
`923`	`926`
`924`	`927`	`onFrameworkMessage: function(request, port, callback) {`
Original file line number	Diff line number	Diff line change
`@@ -678,6 +678,9 @@ body[dir="rtl"] #netFilteringDialog > .panes > .details > div > span:nth-of-type`
`678`	`678`	`background-color: rgb(var(--primary-50) / 50%);`
`679`	`679`	`}`
`680`	`680`	`#netFilteringDialog > .panes > .details .exceptor::before {`
	`681`	`+ content: '@@';`
	`682`	`+ }`
	`683`	`+#netFilteringDialog.extendedRealm > .panes > .details .exceptor::before {`
`681`	`684`	`content: '#@#';`
`682`	`685`	`}`
`683`	`686`	`#netFilteringDialog > div.panes > .dynamic > .toolbar {`