Issue 6402 - Split filter hit / request logging out into own API

lib/devtools.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";
 
 const {RegExpFilter,
        WhitelistFilter,
        ElemHideFilter} = require("../adblockpluscore/lib/filterClasses");
 const {SpecialSubscription} =
   require("../adblockpluscore/lib/subscriptionClasses");
 const {FilterStorage} = require("../adblockpluscore/lib/filterStorage");
 const {defaultMatcher} = require("../adblockpluscore/lib/matcher");
 const {FilterNotifier} = require("../adblockpluscore/lib/filterNotifier");
 const {extractHostFromFrame} = require("./url");
 const {port} = require("./messaging");
-
-const nonRequestTypes = ["DOCUMENT", "ELEMHIDE",
-                         "GENERICBLOCK", "GENERICHIDE", "CSP"];
+const {HitLogger, nonRequestTypes} = require("./hitLogger");
 
 let panels = new Map();
 
 function isActivePanel(panel)
 {
   return panel && !panel.reload && !panel.reloading;
 }
 
 function getActivePanel(tabId)
 {
@@ skipping 67 matching lines @@
   return defaultMatcher.matchesAny(
     request.url,
     RegExpFilter.typeMap[request.type],
     request.docDomain,
     request.thirdParty,
     request.sitekey,
     request.specificOnly
   );
 }
 
-/**
- * Logs a request to the devtools panel.
- *
- * @param {number[]} tabIds        The tabIds associated with the request
- * @param {string}   url           The URL of the request
- * @param {string}   type          The request type
- * @param {string}   docDomain     The IDN-decoded hostname of the document
- * @param {boolean}  thirdParty    Whether the origin of the request and
- *                                 document differs
- * @param {?string}  sitekey       The active sitekey if there is any
- * @param {?boolean} specificOnly  Whether generic filters should be ignored
- * @param {?BlockingFilter} filter The matched filter or null if there is no
- *                                 match
- */
-exports.logRequest = function(tabIds, url, type, docDomain,
-                              thirdParty, sitekey,
-                              specificOnly, filter)
-{
-  for (let tabId of tabIds)
-  {
-    let panel = getActivePanel(tabId);
-    if (panel)
-    {
-      let request = {url, type, docDomain, thirdParty, sitekey, specificOnly};
-      addRecord(panel, request, filter);
-    }
-  }
-};
-
-/**
- * Logs active element hiding filters to the devtools panel.
- *
- * @param {number}   tabId      The ID of the tab, the elements were hidden in
- * @param {string[]} selectors  The selectors of applied ElemHideFilters
- * @param {string[]} filters    The text of applied ElemHideEmulationFilters
- * @param {string}   docDomain  The IDN-decoded hostname of the document
- */
-function logHiddenElements(tabId, selectors, filters, docDomain)
-{
-  let panel = getActivePanel(tabId);
-  if (panel)
-  {
-    for (let subscription of FilterStorage.subscriptions)
-    {
-      if (subscription.disabled)
-        continue;
-
-      for (let filter of subscription.filters)
-      {
-        // We only know the exact filter in case of element hiding emulation.
-        // For regular element hiding filters, the content script only knows
-        // the selector, so we have to find a filter that has an identical
-        // selector and is active on the domain the match was reported from.
-        let isActiveElemHideFilter = filter instanceof ElemHideFilter &&
-                                     selectors.includes(filter.selector) &&
-                                     filter.isActiveOnDomain(docDomain);
-
-        if (isActiveElemHideFilter || filters.includes(filter.text))
-          addRecord(panel, {type: "ELEMHIDE", docDomain}, filter);
-      }
-    }
-  }
-}
-
-/**
- * Logs a whitelisting filter, that disables (some kind of)
- * blocking for a particular document, to the devtools panel.
- *
- * @param {number}       tabId     The tabId the whitelisting is active for
- * @param {string}       url       The url of the whitelisted document
- * @param {number}       typeMask  The bit mask of whitelisting types checked
- *                                 for
- * @param {string}       docDomain The IDN-decoded hostname of the parent
- *                                 document
- * @param {WhitelistFilter} filter The matched whitelisting filter
- */
-exports.logWhitelistedDocument = function(tabId, url, typeMask, docDomain,
-                                          filter)
-{
-  let panel = getActivePanel(tabId);
-  if (panel)
-  {
-    for (let type of nonRequestTypes)
-    {
-      if (typeMask & filter.contentType & RegExpFilter.typeMap[type])
-        addRecord(panel, {url, type, docDomain}, filter);
-    }
-  }
-};
-
-/**
- * Checks whether a tab is inspected by the devtools panel.
- *
- * @param {number} tabId
- * @return {boolean}
- */
-exports.hasPanel = function(tabId)
-{
-  return panels.has(tabId);
-};
-
 function onBeforeRequest(details)
 {
   let panel = panels.get(details.tabId);
 
   // Clear the devtools panel and reload the inspected tab without caching
   // when a new request is issued. However, make sure that we don't end up
   // in an infinite recursion if we already triggered a reload.
   if (panel.reloading)
   {
     panel.reloading = false;
@@ skipping 104 matching lines @@
 }
 
 browser.runtime.onConnect.addListener(newPort =>
 {
   let match = newPort.name.match(/^devtools-(\d+)$/);
   if (!match)
     return;
 
   let inspectedTabId = parseInt(match[1], 10);
   let localOnBeforeRequest = onBeforeRequest.bind();
+  let panel = {port: newPort, records: []};
 
   browser.webRequest.onBeforeRequest.addListener(
     localOnBeforeRequest,
     {
       urls: ["http://*/*", "https://*/*"],
       types: ["main_frame"],
       tabId: inspectedTabId
     }
   );
 
   if (panels.size == 0)
   {
     ext.pages.onLoading.addListener(onLoading);
     FilterNotifier.on("filter.added", onFilterAdded);
     FilterNotifier.on("filter.removed", onFilterRemoved);
     FilterNotifier.on("subscription.added", onSubscriptionAdded);
   }
 
+  let hitListener = addRecord.bind(null, panel);

[Manish Jethani, 2018/04/23 15:30:58]

I'm wondering if panel should be an object of a Panel class.

  function Panel(port)
  {
    this.port = port;
    this.records = [];
  }

  Panel.prototype = {
    addRecord(request, filter)
    {
      if (!this.hasRecord(request, filter))
      {
        ...
      }
    },
    hasRecord(request, filter)
    {
      ...
    }
  };

[kzar, 2018/05/01 10:53:07]

Seems like kind of an unrelated change to me, I'll leave this one for now.

[Manish Jethani, 2018/05/02 13:25:13]

Acknowledged.

+
   newPort.onDisconnect.addListener(() =>
   {
+    HitLogger.off(inspectedTabId, hitListener);
     panels.delete(inspectedTabId);
     browser.webRequest.onBeforeRequest.removeListener(localOnBeforeRequest);
 
     if (panels.size == 0)
     {
       ext.pages.onLoading.removeListener(onLoading);
       FilterNotifier.off("filter.added", onFilterAdded);
       FilterNotifier.off("filter.removed", onFilterRemoved);
       FilterNotifier.off("subscription.added", onSubscriptionAdded);
     }
   });
 
-  panels.set(inspectedTabId, {port: newPort, records: []});
+  HitLogger.on(inspectedTabId, hitListener);
+  panels.set(inspectedTabId, panel);
 });
-
-port.on("devtools.traceElemHide", (message, sender) =>
-{
-  logHiddenElements(
-    sender.page.id, message.selectors, message.filters,
-    extractHostFromFrame(sender.frame)
-  );
-});