Issue 7285 - Abstract caching logic

lib/matcher.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 "use strict";
 
 /**
  * @fileOverview Matcher class implementing matching addresses against
  *               a list of filters.
  */
 
 const {RegExpFilter, WhitelistFilter} = require("./filterClasses");
 const {normalizeHostname, suffixes} = require("./domain");
+const {Cache} = require("./caching");
 
 /**
  * Regular expression for matching a keyword in a filter.
  * @type {RegExp}
  */
 const keywordRegExp = /[^a-z0-9%*][a-z0-9%]{3,}(?=[^a-z0-9%*])/;
 
 /**
  * Regular expression for matching all keywords in a filter.
  * @type {RegExp}
@@ skipping 580 matching lines @@
 
 /**
  * Combines a matcher for blocking and exception rules, automatically sorts
  * rules into two {@link Matcher} instances.
  */
 class CombinedMatcher
 {
   constructor()
   {
     /**
-     * Maximal number of matching cache entries to be kept
-     * @type {number}
-     */
-    this.maxCacheEntries = 10000;
-
-    /**
      * Matcher for blocking rules.
      * @type {Matcher}
      * @private
      */
     this._blacklist = new Matcher();
 
     /**
      * Matcher for exception rules.
      * @type {Matcher}
      * @private
      */
     this._whitelist = new Matcher();
 
     /**
      * Lookup table of previous {@link Matcher#matchesAny} results
-     * @type {Map.<string,Filter>}
+     * @type {Cache.<string, ?Filter>}
      * @private
      */
-    this._resultCache = new Map();
+    this._resultCache = new Cache(10000);
   }
 
   /**
    * @see Matcher#clear
    */
   clear()
   {
     this._blacklist.clear();
     this._whitelist.clear();
     this._resultCache.clear();
@@ skipping 139 matching lines @@
     return hits;
   }
 
   /**
    * @see Matcher#matchesAny
    * @inheritdoc
    */
   matchesAny(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     let key = location + " " + typeMask + " " + docDomain + " " + thirdParty +
-      " " + sitekey + " " + specificOnly;
+              " " + sitekey + " " + specificOnly;
 
-    let result = this._resultCache.get(key);
+    let result = this._resultCache.read(key);
     if (typeof result != "undefined")
       return result;
 
     result = this._matchesAnyInternal(location, typeMask, docDomain,
                                       thirdParty, sitekey, specificOnly);
 
-    if (this._resultCache.size >= this.maxCacheEntries)
-      this._resultCache.clear();
-
-    this._resultCache.set(key, result);
+    this._resultCache.save(key, result);
 
     return result;
   }
 
   /**
    * @typedef {object} MatcherSearchResults
    * @property {Array.<BlockingFilter>} [blocking] List of blocking filters
    *   found.
    * @property {Array.<WhitelistFilter>} [whitelist] List of whitelist filters
    *   found.
@@ skipping 15 matching lines @@
    *
    * @returns {MatcherSearchResults}
    */
   search(location, typeMask, docDomain, thirdParty, sitekey, specificOnly,
          filterType = "all")
   {
     let key = "* " + location + " " + typeMask + " " + docDomain + " " +
               thirdParty + " " + sitekey + " " + specificOnly + " " +
               filterType;
 
-    let result = this._resultCache.get(key);
+    let result = this._resultCache.read(key);
     if (typeof result != "undefined")
       return result;
 
     result = this._searchInternal(location, typeMask, docDomain, thirdParty,
                                   sitekey, specificOnly, filterType);
 
-    if (this._resultCache.size >= this.maxCacheEntries)
-      this._resultCache.clear();
-
-    this._resultCache.set(key, result);
+    this._resultCache.save(key, result);
 
     return result;
   }
 
   /**
    * Tests whether the URL is whitelisted
    * @see Matcher#matchesAny
    * @inheritdoc
    * @returns {boolean}
    */
   isWhitelisted(location, typeMask, docDomain, thirdParty, sitekey)
   {
     return !!this._whitelist.matchesAny(location, typeMask, docDomain,
                                         thirdParty, sitekey);
   }
 }
 
 exports.CombinedMatcher = CombinedMatcher;
 
 /**
  * Shared {@link CombinedMatcher} instance that should usually be used.
  * @type {CombinedMatcher}
  */
 let defaultMatcher = new CombinedMatcher();
 
 exports.defaultMatcher = defaultMatcher;