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} = require("filterClasses");
-const {SpecialSubscription} = require("subscriptionClasses");
-const {defaultMatcher} = require("matcher");
-const {FilterNotifier} = require("filterNotifier");
-const {extractHostFromFrame} = require("url");
-const {port} = require("messaging");
-const {HitLogger} = require("hitLogger");
-
-const nonRequestTypes = ["DOCUMENT", "ELEMHIDE", "GENERICBLOCK", "GENERICHIDE"];
-
-// Mapping of inspected tabs to their devpanel page
-// and recorded items. We can't use a PageMap here,
-// because data must persist after navigation/reload.
+       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 {HitLogger, nonRequestTypes} = require("./hitLogger");
+
 let panels = new Map();
 
 function isActivePanel(panel)
 {
   return panel && !panel.reload && !panel.reloading;
 }
 
-function getActivePanel(page)
-{
-  let panel = panels.get(page.id);
+function getActivePanel(tabId)
+{
+  let panel = panels.get(tabId);
   if (isActivePanel(panel))
     return panel;
   return null;
 }
 
 function getFilterInfo(filter)
 {
   if (!filter)
     return null;
 
@@ skipping 32 matching lines @@
        record.request.type == request.type) &&
 
     // Matched element hiding filters don't relate to a particular request,
     // so we have to compare the selector in order to avoid duplicates.
     (record.filter && record.filter.selector) == (filter && filter.selector)
   );
 }
 
 function addRecord(panel, request, filter)
 {
-  if (isActivePanel(panel) && !hasRecord(panel, request, filter))

[kzar, 2018/03/21 15:18:45]

Since we can no longer do  the `isActivePanel` check in `logRequest` I moved it
here, which means it's additionally called as a result of
`logWhitelistedDocument` and `logHiddenElements` as well. I'm not sure if that
matters.

+  if (!hasRecord(panel, request, filter))
   {
     panel.port.postMessage({
       type: "add-record",
       request,
       filter: getFilterInfo(filter)
     });
 
     panel.records.push({request, filter});
   }
 }
@@ skipping 128 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: []};
+  let hitListener = addRecord.bind(null, panel);
 
   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);
-
   newPort.onDisconnect.addListener(() =>
   {
-    HitLogger.off(inspectedTabId, hitListener);
+    HitLogger.removeListener(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);
     }
   });
 
-  HitLogger.on(inspectedTabId, hitListener);
+  HitLogger.addListener(inspectedTabId, hitListener);
   panels.set(inspectedTabId, panel);
 });