DNR: Improve blocking with topDomains

Author: ghostwords

src/lib/dnr/utils.js

@@ -111,17 +111,16 @@ function getCnameAliases(domain) {
  * @returns {Object}
  */
 function makeDnrBlockRule(domain, priority = constants.DNR_BLOCK) {
-  let id = badger.getDynamicRuleId();
+  let id = badger.getDynamicRuleId(),
+    base = getBaseDomain(domain);
 
   let action = {
     type: 'block'
   };
 
   let condition = {
     requestDomains: [domain],
-    // TODO "A request is said to be first party if it has the same domain (eTLD+1) as the frame in which the request originated."
-    // TODO will this ever be a problem? frame vs. top-level frame
-    domainType: 'thirdParty',
+    excludedTopDomains: [base]
   };
 
   let cnames = getCnameAliases(domain);
@@ -131,16 +130,9 @@ function makeDnrBlockRule(domain, priority = constants.DNR_BLOCK) {
     condition.requestDomains = condition.requestDomains.concat(cnames);
   }
 
-  let mdfpList = mdfp.getEntityList(getBaseDomain(domain));
+  let mdfpList = mdfp.getEntityList(base);
   if (mdfpList.length) {
-    condition.excludedInitiatorDomains = mdfpList;
-  }
-
-  if (cnames.length) {
-    delete condition.domainType;
-    if (!condition.excludedInitiatorDomains) {
-      condition.excludedInitiatorDomains = [domain];
-    }
+    condition.excludedTopDomains = mdfpList;
   }
 
   let rule = { id, action, condition, priority };
@@ -157,7 +149,8 @@ function makeDnrBlockRule(domain, priority = constants.DNR_BLOCK) {
  * @returns {Object}
  */
 function makeDnrCookieblockRule(domain, priority = constants.DNR_COOKIEBLOCK_HEADERS) {
-  let id = badger.getDynamicRuleId();
+  let id = badger.getDynamicRuleId(),
+    base = getBaseDomain(domain);
 
   let action = {
     type: 'modifyHeaders',
@@ -167,7 +160,7 @@ function makeDnrCookieblockRule(domain, priority = constants.DNR_COOKIEBLOCK_HEA
 
   let condition = {
     requestDomains: [domain],
-    domainType: 'thirdParty',
+    excludedTopDomains: [base]
   };
 
   let cnames = getCnameAliases(domain);
@@ -177,16 +170,9 @@ function makeDnrCookieblockRule(domain, priority = constants.DNR_COOKIEBLOCK_HEA
     condition.requestDomains = condition.requestDomains.concat(cnames);
   }
 
-  let mdfpList = mdfp.getEntityList(getBaseDomain(domain));
+  let mdfpList = mdfp.getEntityList(base);
   if (mdfpList.length) {
-    condition.excludedInitiatorDomains = mdfpList;
-  }
-
-  if (cnames.length) {
-    delete condition.domainType;
-    if (!condition.excludedInitiatorDomains) {
-      condition.excludedInitiatorDomains = [domain];
-    }
+    condition.excludedTopDomains = mdfpList;
   }
 
   let rule = { id, action, condition, priority };
@@ -214,13 +200,11 @@ function makeDnrAllowRule(domain, priority = constants.DNR_COOKIEBLOCK_ALLOW) {
 
   let condition = {
     requestDomains: [domain],
-    domainType: 'thirdParty'
   };
 
   let cnames = getCnameAliases(domain);
 
   if (cnames.length) {
-    delete condition.domainType;
     // important for requestDomains[0] to be the domain
     condition.requestDomains = condition.requestDomains.concat(cnames);
   }
@@ -245,6 +229,8 @@ function makeDnrAllowRule(domain, priority = constants.DNR_COOKIEBLOCK_ALLOW) {
 function makeDnrSurrogateRule(id, script_host, surrogate_path, extraConditions,
   priority = constants.DNR_SURROGATE_REDIRECT, resource_type = 'script') {
 
+  let script_base = getBaseDomain(script_host);
+
   let rule = {
     id,
     priority,
@@ -257,21 +243,21 @@ function makeDnrSurrogateRule(id, script_host, surrogate_path, extraConditions,
     condition: {
       requestDomains: [script_host],
       resourceTypes: [resource_type],
-      domainType: 'thirdParty',
-      excludedInitiatorDomains: mdfp.getEntityList(getBaseDomain(script_host))
+      excludedTopDomains: [script_base]
     }
   };
 
+  let mdfpList = mdfp.getEntityList(script_base);
+  if (mdfpList.length) {
+    rule.condition.excludedTopDomains = mdfpList;
+  }
+
   if (extraConditions) {
     for (let key in extraConditions) {
       rule.condition[key] = extraConditions[key];
     }
   }
 
-  if (!rule.condition.excludedInitiatorDomains.length) {
-    delete rule.condition.excludedInitiatorDomains;
-  }
-
   return rule;
 }
 
@@ -349,6 +335,14 @@ function getDnrSurrogateRules(domain, is_user_action) {
  * @returns {Object}
  */
 function makeDnrFpScriptBlockRule(id, domain, path) {
+  let base = getBaseDomain(domain),
+    excludedTopDomains = [base];
+
+  let mdfpList = mdfp.getEntityList(base);
+  if (mdfpList.length) {
+    excludedTopDomains = mdfpList;
+  }
+
   return {
     id,
     priority: constants.DNR_FP_SCRIPT_BLOCK,
@@ -357,8 +351,7 @@ function makeDnrFpScriptBlockRule(id, domain, path) {
       requestDomains: [domain],
       resourceTypes: ['script'],
       urlFilter: '||' + domain + path + '^',
-      domainType: 'thirdParty',
-      excludedInitiatorDomains: mdfp.getEntityList(getBaseDomain(domain))
+      excludedTopDomains
     }
   };
 }
@@ -450,7 +443,7 @@ let updateSessionAllowRules = utils.debounce(async function (tempAllowlist) {
  * Reregisters DNR session rules for site-specific domain overrides.
  *
  * These are session rules because we can scope session rules to tab IDs.
- * What we actually want to do though is make topDomains-scoped dynamic rules.
+ * TODO What we actually want to do though is make topDomains-scoped dynamic rules.
  *
  * @param {Number} tab_id
  * @param {String} tab_host
@@ -786,7 +779,7 @@ async function updateWidgetSiteAllowlistRules(widgetSiteAllowlist) {
         priority: constants.DNR_WIDGET_ALLOW_ALL,
         action: { type: 'allowAllRequests' },
         condition: {
-          initiatorDomains: [site_host],
+          topDomains: [site_host],
           requestDomains: [domain],
           resourceTypes: ['sub_frame']
         }
@@ -804,7 +797,7 @@ async function updateWidgetSiteAllowlistRules(widgetSiteAllowlist) {
         priority: constants.DNR_WIDGET_ALLOW_ALL,
         action: { type: 'allow' },
         condition: {
-          initiatorDomains: [site_host],
+          topDomains: [site_host],
           requestDomains: [domain]
         }
       };
@@ -905,8 +898,7 @@ async function updateDntSignalHeaderRules() {
     let exceptionSites = Object.keys(
       badger.getPrivateSettings().getItem("gpcDisabledSites"));
     if (exceptionSites.length) {
-      // TODO switch to excludedTopDomains once widely available
-      rule.condition.excludedInitiatorDomains = exceptionSites;
+      rule.condition.excludedTopDomains = exceptionSites;
     }
     opts.addRules.push(rule);
 
@@ -930,8 +922,7 @@ async function updateDntSignalHeaderRules() {
       condition: {}
     };
     if (exceptionSites.length) {
-      // TODO switch to excludedTopDomains once widely available
-      rule.condition.excludedInitiatorDomains = exceptionSites;
+      rule.condition.excludedTopDomains = exceptionSites;
     }
     opts.addRules.push(rule);
   }

src/manifest.json

@@ -493,7 +493,7 @@
     "128": "icons/badger-128.png"
   },
   "manifest_version": 3,
-  "minimum_chrome_version": "121.0",
+  "minimum_chrome_version": "141.0",
   "name": "__MSG_name__",
   "action": {
     "default_area": "navbar",