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

lib/hitLogger.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 63 matching lines @@
  *
  * @param {number[]} tabIds
  *   The tabIds associated with the request
  * @param {Object} request
  *   The request to log
  * @param {string} request.url
  *   The URL of the request
  * @param {string} request.type
  *  The request type
  * @param {string} request.docDomain
- *  The IDN-decoded hostname of the document

[Manish Jethani, 2018/05/09 15:11:11]

The hostname is no longer IDN-decoded. Also we should call it hostname instead
of docDomain here for consistency.

[kzar, 2018/05/09 17:58:42]

To rename it hostname involves changing adblockplusui as well, so I've kept it
as docDomain for now.

[Manish Jethani, 2018/05/09 22:29:17]

Acknowledged.

+ *  The hostname of the document
  * @param {boolean} request.thirdParty
  *   Whether the origin of the request and document differs
  * @param {?string} request.sitekey
  *   The active sitekey if there is any
  * @param {?boolean} request.specificOnly
  *   Whether generic filters should be ignored
  * @param {?BlockingFilter} filter
  *  The matched filter or null if there is no match
  */
 exports.logRequest = (tabIds, request, filter) =>
 {
   for (let tabId of tabIds)
     eventEmitter.emit(tabId, request, filter);
 };
 
 /**
  * Logs active element hiding filters for a tab.
  *
  * @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
+ * @param {string}   docDomain  The hostname of the document
  */
 function logHiddenElements(tabId, selectors, filters, docDomain)
 {
   if (HitLogger.hasListener(tabId))
   {
     for (let subscription of FilterStorage.subscriptions)
     {
       if (subscription.disabled)
         continue;
 
@@ skipping 15 matching lines @@
 }
 
 /**
  * Logs a whitelisting filter that disables (some kind of)
  * blocking for a particular document.
  *
  * @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 {string}       docDomain The hostname of the parent document
  * @param {WhitelistFilter} filter The matched whitelisting filter
  */
 exports.logWhitelistedDocument = (tabId, url, typeMask, docDomain, filter) =>
 {
   if (HitLogger.hasListener(tabId))
   {
     for (let type of nonRequestTypes)
     {
       if (typeMask & filter.contentType & RegExpFilter.typeMap[type])
         eventEmitter.emit(tabId, {url, type, docDomain}, filter);
     }
   }
 };
 
 port.on("hitLogger.traceElemHide", (message, sender) =>
 {
   logHiddenElements(
     sender.page.id, message.selectors, message.filters,
     extractHostFromFrame(sender.frame)
   );
 });