Expand bidi-trie usage in static network filtering engine

Related issues:
- uBlockOrigin/uBlock-issues#761
- uBlockOrigin/uBlock-issues#528

The previous bidi-trie code could only hold filters which
are plain pattern, i.e. no wildcard characters, and which
had no origin option (`domain=`), right and/or left anchor,
and no `csp=` option.

Example of filters that could be moved into a bidi-trie
data structure:

    &ad_box_
    /w/d/capu.php?z=$script,third-party
    ||liveonlinetv247.com/images/muvixx-150x50-watch-now-in-hd-play-btn.gif

Examples of filters that could NOT be moved to a bidi-trie:

    -adap.$domain=~l-adap.org
    /tsc.php?*&ses=
    ||ibsrv.net/*forumsponsor$domain=[...]
    @@||imgspice.com/jquery.cookie.js|$script
    ||view.atdmt.com^*/iview/$third-party
    ||postimg.cc/image/$csp=[...]

Ideally the filters above should be able to be moved to a
bidi-trie since they are basically plain patterns, or at
least partially moved to a bidi-trie when there is only a
single wildcard (i.e. made of two plain patterns).

Also, there were two distinct bidi-tries in which
plain-pattern filters can be moved to: one for patterns
without hostname anchoring and another one for patterns
with hostname-anchoring. This was required because the
hostname-anchored patterns have an extra condition which
is outside the bidi-trie knowledge.

This commit expands the number of filters which can be
stored in the bidi-trie, and also remove the need to
use two distinct bidi-tries.

- Added ability to associate a pattern with an integer
  in the bidi-trie [1].
    - The bidi-trie match code passes this externally
      provided integer when calling an externally
      provided method used for testing extra conditions
      that may be present for a plain pattern found to
      be matching in the bidi-trie.

- Decomposed existing filters into smaller logical units:
    - FilterPlainLeftAnchored =>
        FilterPatternPlain +
        FilterAnchorLeft
    - FilterPlainRightAnchored =>
        FilterPatternPlain +
        FilterAnchorRight
    - FilterExactMatch =>
        FilterPatternPlain +
        FilterAnchorLeft +
        FilterAnchorRight
    - FilterPlainHnAnchored =>
        FilterPatternPlain +
        FilterAnchorHn
    - FilterWildcard1 =>
        FilterPatternPlain + [
          FilterPatternLeft or
          FilterPatternRight
        ]
    - FilterWildcard1HnAnchored =>
        FilterPatternPlain + [
          FilterPatternLeft or
          FilterPatternRight
        ] +
        FilterAnchorHn
    - FilterGenericHnAnchored =>
        FilterPatternGeneric +
        FilterAnchorHn
    - FilterGenericHnAndRightAnchored =>
        FilterPatternGeneric +
        FilterAnchorRight +
        FilterAnchorHn
    - FilterOriginMixedSet =>
        FilterOriginMissSet +
        FilterOriginHitSet
    - Instances of FilterOrigin[...], FilterDataHolder
      can also be added to a composite filter to
      represent `domain=` and `csp=` options.

- Added a new filter class, FilterComposite, for
  filters which are a combination of two or more
  logical units. A FilterComposite instance is a
  match when *all* filters composing it are a
  match.

Since filters are now encoded into combination of
smaller units, it becomes possible to extract the
FilterPatternPlain component and store it in the
bidi-trie, and use the integer as a handle for the
remaining extra conditions, if any.

Since a single pattern in the bidi-trie may be a
component for different filters, the associated
integer points to a sequence of extra conditions,
and a match occurs as soon as one of the extra
conditions (which may itself be a sequence of
conditions) is fulfilled.

Decomposing filters which are currently single
instance into sequences of smaller logical filters
means increasing the storage and CPU overhead when
evaluating such filters. The CPU overhead is
compensated by the fact that more filters can now
moved into the bidi-trie, where the first match is
efficiently evaluated. The extra conditions have to
be evaluated if and only if there is a match in the
bidi-trie.

The storage overhead is compensated by the
bidi-trie's intrinsic nature of merging similar
patterns.

Furthermore, the storage overhead is reduced by no
longer using JavaScript array to store collection
of filters (which is what FilterComposite is):
the same technique used in [2] is imported to store
sequences of filters.

A sequence of filters is a sequence of integer pairs
where the first integer is an index to an actual
filter instance stored in a global array of filters
(`filterUnits`), while the second integer is an index
to the next pair in the sequence -- which means all
sequences of filters are encoded in one single array
of integers (`filterSequences` => Uint32Array). As
a result, a sequence of filters can be represented by
one single integer -- an index to the first pair --
regardless of the number of filters in the sequence.

This representation is further leveraged to replace
the use of JavaScript array in FilterBucket [3],
which used a JavaScript array to store collection
of filters. Doing so means there is no more need for
FilterPair [4], which purpose was to be a lightweight
representation when there was only two filters in a
collection.

As a result of the above changes, the map of `token`
(integer)  => filter instance (object) used to
associate tokens to filters or collections of filters
is replaced with a more efficient map of `token`
(integer) to filter unit index (integer) to lookup a
filter object from the global `filterUnits` array.

Another consequence of using one single global
array to store all filter instances means we can reuse
existing instances when a logical filter instance is
parameter-less, which is the case for FilterAnchorLeft,
FilterAnchorRight, FilterAnchorHn, the index to these
single instances is reused where needed.

`urlTokenizer` now stores the character codes of the
scanned URL into a bidi-trie buffer, for reuse when
string matching methods are called.

New method: `tokenHistogram()`, used to generate
histograms of occurrences of token extracted from URLs
in built-in benchmark. The top results of the "miss"
histogram are used as "bad tokens", i.e. tokens to
avoid if possible when compiling filter lists.

All plain pattern strings are now stored in the
bidi-trie memory buffer, regardless of whether they
will be used in the trie proper or not.

Three methods have been added to the bidi-trie to test
stored string against the URL which is also stored in
then bidi-trie.

FilterParser is now instanciated on demand and
released when no longer used.

***

[1] https://github.com/gorhill/uBlock/blob/135a45a878f5b93bc538f822981e3a42b1e9073f/src/js/strie.js#L120
[2] e94024d
[3] https://github.com/gorhill/uBlock/blob/135a45a878f5b93bc538f822981e3a42b1e9073f/src/js/static-net-filtering.js#L1630
[4] https://github.com/gorhill/uBlock/blob/135a45a878f5b93bc538f822981e3a42b1e9073f/src/js/static-net-filtering.js#L1566

src/js/background.js

@@ -141,8 +141,8 @@ const µBlock = (( ) => { // jshint ignore:line
 
         // Read-only
         systemSettings: {
-            compiledMagic: 21,  // Increase when compiled format changes
-            selfieMagic: 22,    // Increase when selfie format changes
+            compiledMagic: 23,  // Increase when compiled format changes
+            selfieMagic: 23,    // Increase when selfie format changes
         },
 
         restoreBackupSettings: {

src/js/document-blocked.js

@@ -44,7 +44,6 @@ let details = {};
 (async ( ) => {
     const response = await messaging.send('documentBlocked', {
         what: 'listsFromNetFilter',
-        compiledFilter: details.fc,
         rawFilter: details.fs,
     });
     if ( response instanceof Object === false ) { return; }

src/js/hntrie.js

@@ -560,6 +560,8 @@ HNTrieContainer.prototype.HNTrieRef = class {
         this.container = container;
         this.iroot = iroot;
         this.size = size;
+        this.needle = '';
+        this.last = -1;
     }
 
     add(hn) {

src/js/logger-ui.js

@@ -659,7 +659,6 @@ const viewPort = (( ) => {
             }
             if ( filteringType === 'static' ) {
                 divcl.add('canLookup');
-                div.setAttribute('data-filter', filter.compiled);
             } else if ( filteringType === 'cosmetic' ) {
                 divcl.add('canLookup');
                 divcl.toggle('isException', filter.raw.startsWith('#@#'));
@@ -1465,7 +1464,6 @@ const reloadTab = function(ev) {
 
     const fillSummaryPaneFilterList = async function(rows) {
         const rawFilter = targetRow.children[1].textContent;
-        const compiledFilter = targetRow.getAttribute('data-filter');
 
         const nodeFromFilter = function(filter, lists) {
             const fragment = document.createDocumentFragment();
@@ -1524,7 +1522,6 @@ const reloadTab = function(ev) {
         if ( targetRow.classList.contains('networkRealm') ) {
             const response = await messaging.send('loggerUI', {
                 what: 'listsFromNetFilter',
-                compiledFilter: compiledFilter,
                 rawFilter: rawFilter,
             });
             handleResponse(response);

src/js/messaging.js

@@ -66,14 +66,18 @@ const onMessage = function(request, sender, callback) {
 
     case 'listsFromNetFilter':
         µb.staticFilteringReverseLookup.fromNetFilter(
-            request.compiledFilter,
-            request.rawFilter,
-            callback
-        );
+            request.rawFilter
+        ).then(response => {
+            callback(response);
+        });
         return;
 
     case 'listsFromCosmeticFilter':
-        µb.staticFilteringReverseLookup.fromCosmeticFilter(request, callback);
+        µb.staticFilteringReverseLookup.fromCosmeticFilter(
+            request
+        ).then(response => {
+            callback(response);
+        });
         return;
 
     case 'reloadAllFilters':

src/js/redirect-engine.js

@@ -737,6 +737,9 @@ RedirectEngine.prototype.loadBuiltinResources = function() {
                 store(name, reader.result);
                 resolve();
             };
+            reader.onabort = reader.onerror = ( ) => {
+                resolve();
+            };
             reader.readAsDataURL(blob);
         });
     };

src/js/reverselookup.js

@@ -39,9 +39,9 @@ let messageId = 1;
 
 const onWorkerMessage = function(e) {
     const msg = e.data;
-    const callback = pendingResponses.get(msg.id);
+    const resolver = pendingResponses.get(msg.id);
     pendingResponses.delete(msg.id);
-    callback(msg.response);
+    resolver(msg.response);
 };
 
 /******************************************************************************/
@@ -55,6 +55,9 @@ const stopWorker = function() {
     worker.terminate();
     worker = null;
     needLists = true;
+    for ( const resolver of pendingResponses.values() ) {
+        resolver();
+    }
     pendingResponses.clear();
 };
 
@@ -127,44 +130,42 @@ const initWorker = function() {
 
 /******************************************************************************/
 
-const fromNetFilter = async function(compiledFilter, rawFilter, callback) {
-    if ( typeof callback !== 'function' ) {
-        return;
-    }
+const fromNetFilter = async function(rawFilter) {
+    if ( typeof rawFilter !== 'string' || rawFilter === '' ) { return; }
 
-    if ( compiledFilter === '' || rawFilter === '' ) {
-        callback();
+    const µb = µBlock;
+    const writer = new µb.CompiledLineIO.Writer();
+    if ( µb.staticNetFilteringEngine.compile(rawFilter, writer) === false ) {
         return;
     }
 
     await initWorker();
 
     const id = messageId++;
-    const message = {
+    worker.postMessage({
         what: 'fromNetFilter',
         id: id,
-        compiledFilter: compiledFilter,
+        compiledFilter: writer.last(),
         rawFilter: rawFilter
-    };
-    pendingResponses.set(id, callback);
-    worker.postMessage(message);
+    });
+
+    return new Promise(resolve => {
+        pendingResponses.set(id, resolve);
+    });
 };
 
 /******************************************************************************/
 
-const fromCosmeticFilter = async function(details, callback) {
-    if ( typeof callback !== 'function' ) { return; }
-
-    if ( details.rawFilter === '' ) {
-        callback();
+const fromCosmeticFilter = async function(details) {
+    if ( typeof details.rawFilter !== 'string' || details.rawFilter === '' ) {
         return;
     }
 
     await initWorker();
 
     const id = messageId++;
     const hostname = µBlock.URI.hostnameFromURI(details.url);
-    pendingResponses.set(id, callback);
+
     worker.postMessage({
         what: 'fromCosmeticFilter',
         id: id,
@@ -182,6 +183,11 @@ const fromCosmeticFilter = async function(details, callback) {
             ) === 2,
         rawFilter: details.rawFilter
     });
+
+    return new Promise(resolve => {
+        pendingResponses.set(id, resolve);
+    });
+
 };
 
 /******************************************************************************/