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

lib/csp.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 {defaultMatcher} = require("../adblockpluscore/lib/matcher");
 const {RegExpFilter, WhitelistFilter} =
   require("../adblockpluscore/lib/filterClasses");
 const {extractHostFromFrame, getDecodedHostname,
        isThirdParty, stringifyURL} = require("./url");
 const {checkWhitelisted} = require("./whitelisting");
 const {FilterNotifier} = require("filterNotifier");
-const devtools = require("./devtools");
+const {logRequest} = require("./hitLogger");
 
 const {typeMap} = RegExpFilter;
 
 browser.webRequest.onHeadersReceived.addListener(details =>
 {
   let url = new URL(details.url);
   let urlString = stringifyURL(url);
   let parentFrame = ext.getFrame(details.tabId, details.parentFrameId);
-  let hostname = extractHostFromFrame(parentFrame) || getDecodedHostname(url);
-  let thirdParty = isThirdParty(url, hostname);
+  let docDomain = extractHostFromFrame(parentFrame) || getDecodedHostname(url);

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

I renamed this in order to use the Object shorthand later. It makes sense now
that we're passing through a request Object to logRequest.

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

Acknowledged.

Maybe rename urlString to url and and url to urlObject?

[kzar, 2018/05/02 15:41:50]

I think I prefer it like it is, I find the name urlObject kind of ugly somehow.

[Sebastian Noack, 2018/05/02 16:11:32]

Agreed with kzar (also in favor to avoid wrapping the line here).

+  let thirdParty = isThirdParty(url, docDomain);
 
-  let cspMatch = defaultMatcher.matchesAny(urlString, typeMap.CSP, hostname,
+  let cspMatch = defaultMatcher.matchesAny(urlString, typeMap.CSP, docDomain,
                                            thirdParty, null, false);
   if (cspMatch)
   {
     let page = new ext.Page({id: details.tabId, url: details.url});
     let frame = ext.getFrame(details.tabId, details.frameId);
 
     if (checkWhitelisted(page, frame))
       return;
 
     // To avoid an extra matchesAny for the common case we assumed no
     // $genericblock filters applied when searching for a matching $csp filter.
     // We must now pay the price by first checking for a $genericblock filter
     // and if necessary that our $csp filter is specific.
     let specificOnly = !!checkWhitelisted(page, frame, null,
                                           typeMap.GENERICBLOCK);
     if (specificOnly)
     {
-      cspMatch = defaultMatcher.matchesAny(urlString, typeMap.CSP, hostname,
+      cspMatch = defaultMatcher.matchesAny(urlString, typeMap.CSP, docDomain,
                                            thirdParty, null, specificOnly);
       if (!cspMatch)
         return;
     }
 
-    devtools.logRequest([details.tabId], urlString, "CSP", hostname,
-                        thirdParty, null, specificOnly, cspMatch);
+    logRequest(
+      [details.tabId],
+      {url: urlString, type: "CSP", docDomain, thirdParty, specificOnly},
+      cspMatch
+    );
     FilterNotifier.emit("filter.hitCount", cspMatch, 0, 0, [details.tabId]);
 
     if (cspMatch instanceof WhitelistFilter)
       return;
 
     details.responseHeaders.push({
       name: "Content-Security-Policy",
       value: cspMatch.csp
     });
 
     return {responseHeaders: details.responseHeaders};
   }
 }, {
   urls: ["http://*/*", "https://*/*"],
   types: ["main_frame", "sub_frame"]
 }, ["blocking", "responseHeaders"]);