Issue 6940 - Use underscore prefixes lib/matcher.js

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
@@ skipping 39 matching lines @@
 
 /**
  * Blacklist/whitelist filter matching
  */
 class Matcher
 {
   constructor()
   {
     /**
      * Lookup table for filters by their associated keyword
+     * @private

[Manish Jethani, 2018/10/21 12:12:19]

I've already started using @private/@protected elsewhere [1], but I put it as
the last thing in the comment. Could you please make @private the last line in
the comment?

[1]: https://hg.adblockplus.org/adblockpluscore/rev/4a0244a174e6#l2.57

[Jon Sonesen, 2018/10/23 01:28:01]

Acknowledged.

      * @type {Map.<string,(Filter|Set.<Filter>)>}
      */
-    this.filterByKeyword = new Map();
+    this._filterByKeyword = new Map();
   }
 
   /**
    * Removes all known filters
    */
   clear()
   {
-    this.filterByKeyword.clear();
+    this._filterByKeyword.clear();
   }
 
   /**
    * Adds a filter to the matcher
    * @param {RegExpFilter} filter
    */
   add(filter)
   {
     // Look for a suitable keyword
     let keyword = this.findKeyword(filter);
-    let set = this.filterByKeyword.get(keyword);
+    let set = this._filterByKeyword.get(keyword);
     if (typeof set == "undefined")
     {
-      this.filterByKeyword.set(keyword, filter);
+      this._filterByKeyword.set(keyword, filter);
     }
     else if (set.size == 1)
     {
       if (filter != set)
-        this.filterByKeyword.set(keyword, new Set([set, filter]));
+        this._filterByKeyword.set(keyword, new Set([set, filter]));
     }
     else
     {
       set.add(filter);
     }
   }
 
   /**
    * Removes a filter from the matcher
    * @param {RegExpFilter} filter
    */
   remove(filter)
   {
     let keyword = this.findKeyword(filter);
-    let set = this.filterByKeyword.get(keyword);
+    let set = this._filterByKeyword.get(keyword);
     if (typeof set == "undefined")
       return;
 
     if (set.size == 1)
     {
       if (filter == set)
-        this.filterByKeyword.delete(keyword);
+        this._filterByKeyword.delete(keyword);
     }
     else
     {
       set.delete(filter);
 
       if (set.size == 1)
-        this.filterByKeyword.set(keyword, [...set][0]);
+        this._filterByKeyword.set(keyword, [...set][0]);
     }
   }
 
   /**
    * Chooses a keyword to be associated with the filter
+   * @protected

[Manish Jethani, 2018/10/21 12:12:19]

Same here.

[Jon Sonesen, 2018/10/23 01:28:04]

Acknowledged.

    * @param {Filter} filter
    * @returns {string} keyword or an empty string if no keyword could be found
    */
   findKeyword(filter)
   {
     let result = "";
     let {pattern} = filter;
     if (pattern == null)
       return result;
 
     let candidates = pattern.toLowerCase().match(allKeywordsRegExp);
     if (!candidates)
       return result;
 
-    let hash = this.filterByKeyword;
+    let hash = this._filterByKeyword;
     let resultCount = 0xFFFFFF;
     let resultLength = 0;
     for (let i = 0, l = candidates.length; i < l; i++)
     {
       let candidate = candidates[i].substr(1);
       let filters = hash.get(candidate);
       let count = typeof filters != "undefined" ? filters.size : 0;
       if (count < resultCount ||
           (count == resultCount && candidate.length > resultLength))
       {
         result = candidate;
         resultCount = count;
         resultLength = candidate.length;
       }
     }
     return result;
   }
 
   /**
    * Checks whether the entries for a particular keyword match a URL
    * @param {string} keyword
    * @param {string} location
    * @param {number} typeMask
    * @param {string} [docDomain]
    * @param {boolean} [thirdParty]
    * @param {string} [sitekey]
    * @param {boolean} [specificOnly]
    * @returns {?Filter}
    */
   _checkEntryMatch(keyword, location, typeMask, docDomain, thirdParty, sitekey,

[Manish Jethani, 2018/10/21 12:52:04]

About this function, I think we can make it "protected". Let's remove the
underscore and add the @protected tag.

[Jon Sonesen, 2018/10/23 01:28:02]

Acknowledged.

                    specificOnly)
   {
-    let set = this.filterByKeyword.get(keyword);
+    let set = this._filterByKeyword.get(keyword);
     if (typeof set == "undefined")
       return null;
 
     for (let filter of set)
     {
       if (specificOnly && filter.isGeneric() &&
           !(filter instanceof WhitelistFilter))
         continue;
 
       if (filter.matches(location, typeMask, docDomain, thirdParty, sitekey))
@@ skipping 63 matching lines @@
     /**
      * Matcher for exception rules.
      * @type {Matcher}
      */
     this.whitelist = new Matcher();
 
     /**
      * Lookup table of previous {@link Matcher#matchesAny} results
      * @type {Map.<string,Filter>}
      */
     this.resultCache = new Map();

[Manish Jethani, 2018/10/21 12:52:04]

Let's do this entire file while we're at it. I don't think resultCache needs to
be public. It can private (underscore and @private).

[Manish Jethani, 2018/10/22 22:57:50]

FYI we're having a discussion [1] about making blacklist and whitelist private
as well. I think it makes sense to make them private.

[1]: https://codereview.adblockplus.org/29896562/

[Jon Sonesen, 2018/10/23 01:28:02]

Acknowledged. In the new patch set, I made them private and realized they are in
fact not private. in lib/subscriptionClasses.js the "defaultsMap" literal is
used to fetch the filter groups (not a very good design choice as it seems
everyone has thought they are private.) The same applies in lib/filterClassesjs
and test/filterListener.js so my first reaction is to just make them protected.

[Manish Jethani, 2018/10/23 03:10:14]

I don't think that has anything to do with the change here. We can make these
properties private.

[Jon Sonesen, 2018/10/23 03:16:42]

It does, have you tested making them private? I can upload the patch set that
only changes properties but it breaks *alot* of tests

[Manish Jethani, 2018/10/23 03:23:17]

You'll have to modify the tests of course, so they use the underscored names of
the properties. I think you have to change exactly one line for this.

[Manish Jethani, 2018/10/23 03:28:42]

Please try just changing this line:

https://hg.adblockplus.org/adblockpluscore/file/e8254db792d0/test/filterListe...

To this:

  let matcher = defaultMatcher["_" + type];

[Jon Sonesen, 2018/10/23 04:08:03]

Yeah I am the worst, thanks for your help and patience

[Manish Jethani, 2018/10/23 10:38:26]

Not at all, it happens to me too :)

   }
 
   /**
    * @see Matcher#clear
    */
   clear()
   {
     this.blacklist.clear();
     this.whitelist.clear();
     this.resultCache.clear();
@@ skipping 25 matching lines @@
       this.blacklist.remove(filter);
 
     this.resultCache.clear();
   }
 
   /**
    * @see Matcher#findKeyword
    * @param {Filter} filter
    * @returns {string} keyword
    */
   findKeyword(filter)

[Manish Jethani, 2018/10/21 12:52:03]

If we're marking fineKeyword @protected in Matcher, let's do it here in
CombinedMatcher as well.

[Jon Sonesen, 2018/10/23 01:28:04]

Done.

   {
     if (filter instanceof WhitelistFilter)
       return this.whitelist.findKeyword(filter);
     return this.blacklist.findKeyword(filter);
   }
 
   /**
    * Optimized filter matching testing both whitelist and blacklist matchers
    * simultaneously. For parameters see
      {@link Matcher#matchesAny Matcher.matchesAny()}.
    * @see Matcher#matchesAny
    * @inheritdoc
    */
   matchesAnyInternal(location, typeMask, docDomain, thirdParty, sitekey,

[Manish Jethani, 2018/10/21 12:52:03]

Let's make this private (underscore and @private).

[Jon Sonesen, 2018/10/23 01:28:02]

Acknowledged.

                      specificOnly)
   {
     let candidates = location.toLowerCase().match(/[a-z0-9%]{3,}/g);
     if (candidates === null)
       candidates = [];
     candidates.push("");
 
     let blacklistHit = null;
     for (let i = 0, l = candidates.length; i < l; i++)
     {
       let substr = candidates[i];
       let result = this.whitelist._checkEntryMatch(
         substr, location, typeMask, docDomain, thirdParty, sitekey
       );
       if (result)
         return result;
       if (blacklistHit === null)
       {
         blacklistHit = this.blacklist._checkEntryMatch(
           substr, location, typeMask, docDomain, thirdParty, sitekey,
           specificOnly
         );
       }
     }
     return blacklistHit;
   }
 
   /**
    * @see Matcher#matchesAny
    * @inheritdoc

[Manish Jethani, 2018/10/21 12:52:04]

There are two instances of @inheritdoc in this file, neither of them makes sense
because there is no inheritance. Let's remove them.

[Jon Sonesen, 2018/10/23 01:28:01]

Doing this makes eslint throw errors for the valid-jsdoc plugin

[Manish Jethani, 2018/10/23 03:10:14]

Oh yeah, I think you had mentioned this earlier as well. I forgot. Welp, let's
leave it then.

    */
   matchesAny(location, typeMask, docDomain, thirdParty, sitekey, specificOnly)
   {
     let key = location + " " + typeMask + " " + docDomain + " " + thirdParty +
       " " + sitekey + " " + specificOnly;
 
     let result = this.resultCache.get(key);
     if (typeof result != "undefined")
       return result;
 
@@ skipping 11 matching lines @@
 
 exports.CombinedMatcher = CombinedMatcher;
 
 /**
  * Shared {@link CombinedMatcher} instance that should usually be used.
  * @type {CombinedMatcher}
  */
 let defaultMatcher = new CombinedMatcher();
 
 exports.defaultMatcher = defaultMatcher;