Update v6 list to be per-manifest (#1989)

* Update to v6 list and per-manifest * Update integration tests to v6 lists
duckduckgo · May 22, 2023 · 996d326 · 996d326
1 parent 7664d09
commit 996d326
Show file tree

Hide file tree

Showing 7 changed files with 263 additions and 6 deletions.
diff --git a/...ata/staticcdn/trackerblocking/v4/tds.json → ...ackerblocking/beta/extension-mv3-tds.json b/...ata/staticcdn/trackerblocking/v4/tds.json → ...ackerblocking/beta/extension-mv3-tds.json
diff --git a/integration-test/data/staticcdn/trackerblocking/beta/extension-tds.json b/integration-test/data/staticcdn/trackerblocking/beta/extension-tds.json
@@ -0,0 +1,48 @@
+{
+    "trackers": {
+        "bad.third-party.site": {
+            "domain": "bad.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Bad Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://bad.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "default": "block"
+        },
+        "broken.third-party.site": {
+            "domain": "broken.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Broken Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://broken.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "rules": [],
+            "default": "ignore"
+        }
+    },
+    "entities": {
+        "Test Site for Tracker Blocking": {
+            "displayName": "Test Site for Tracker Blocking",
+            "prevalence": 0.1,
+            "domains": [
+                "bad.third-party.site",
+                "broken.third-party.site"
+            ]
+        }
+    },
+    "cnames": [],
+    "domains": {
+        "bad.third-party.site": "Test Site for Tracker Blocking",
+        "broken.third-party.site": "Test Site for Tracker Blocking"
+    }
+}
diff --git a/integration-test/data/staticcdn/trackerblocking/v6/current/extension-mv3-tds.json b/integration-test/data/staticcdn/trackerblocking/v6/current/extension-mv3-tds.json
@@ -0,0 +1,48 @@
+{
+    "trackers": {
+        "bad.third-party.site": {
+            "domain": "bad.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Bad Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://bad.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "default": "block"
+        },
+        "broken.third-party.site": {
+            "domain": "broken.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Broken Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://broken.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "rules": [],
+            "default": "ignore"
+        }
+    },
+    "entities": {
+        "Test Site for Tracker Blocking": {
+            "displayName": "Test Site for Tracker Blocking",
+            "prevalence": 0.1,
+            "domains": [
+                "bad.third-party.site",
+                "broken.third-party.site"
+            ]
+        }
+    },
+    "cnames": [],
+    "domains": {
+        "bad.third-party.site": "Test Site for Tracker Blocking",
+        "broken.third-party.site": "Test Site for Tracker Blocking"
+    }
+}
diff --git a/integration-test/data/staticcdn/trackerblocking/v6/current/extension-tds.json b/integration-test/data/staticcdn/trackerblocking/v6/current/extension-tds.json
@@ -0,0 +1,48 @@
+{
+    "trackers": {
+        "bad.third-party.site": {
+            "domain": "bad.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Bad Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://bad.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "default": "block"
+        },
+        "broken.third-party.site": {
+            "domain": "broken.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Broken Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://broken.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "rules": [],
+            "default": "ignore"
+        }
+    },
+    "entities": {
+        "Test Site for Tracker Blocking": {
+            "displayName": "Test Site for Tracker Blocking",
+            "prevalence": 0.1,
+            "domains": [
+                "bad.third-party.site",
+                "broken.third-party.site"
+            ]
+        }
+    },
+    "cnames": [],
+    "domains": {
+        "bad.third-party.site": "Test Site for Tracker Blocking",
+        "broken.third-party.site": "Test Site for Tracker Blocking"
+    }
+}
diff --git a/integration-test/data/staticcdn/trackerblocking/v6/next/extension-mv3-tds.json b/integration-test/data/staticcdn/trackerblocking/v6/next/extension-mv3-tds.json
@@ -0,0 +1,48 @@
+{
+    "trackers": {
+        "bad.third-party.site": {
+            "domain": "bad.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Bad Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://bad.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "default": "block"
+        },
+        "broken.third-party.site": {
+            "domain": "broken.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Broken Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://broken.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "rules": [],
+            "default": "ignore"
+        }
+    },
+    "entities": {
+        "Test Site for Tracker Blocking": {
+            "displayName": "Test Site for Tracker Blocking",
+            "prevalence": 0.1,
+            "domains": [
+                "bad.third-party.site",
+                "broken.third-party.site"
+            ]
+        }
+    },
+    "cnames": [],
+    "domains": {
+        "bad.third-party.site": "Test Site for Tracker Blocking",
+        "broken.third-party.site": "Test Site for Tracker Blocking"
+    }
+}
diff --git a/integration-test/data/staticcdn/trackerblocking/v6/next/extension-tds.json b/integration-test/data/staticcdn/trackerblocking/v6/next/extension-tds.json
@@ -0,0 +1,48 @@
+{
+    "trackers": {
+        "bad.third-party.site": {
+            "domain": "bad.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Bad Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://bad.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "default": "block"
+        },
+        "broken.third-party.site": {
+            "domain": "broken.third-party.site",
+            "owner": {
+                "name": "Test Site for Tracker Blocking",
+                "displayName": "Broken Third Party Site",
+                "privacyPolicy": "",
+                "url": "http://broken.third-party.site"
+            },
+            "prevalence": 0.1,
+            "fingerprinting": 3,
+            "cookies": 0.1,
+            "categories": [],
+            "rules": [],
+            "default": "ignore"
+        }
+    },
+    "entities": {
+        "Test Site for Tracker Blocking": {
+            "displayName": "Test Site for Tracker Blocking",
+            "prevalence": 0.1,
+            "domains": [
+                "bad.third-party.site",
+                "broken.third-party.site"
+            ]
+        }
+    },
+    "cnames": [],
+    "domains": {
+        "bad.third-party.site": "Test Site for Tracker Blocking",
+        "broken.third-party.site": "Test Site for Tracker Blocking"
+    }
+}
diff --git a/shared/data/constants.js b/shared/data/constants.js
@@ -1,16 +1,33 @@
 const parseUserAgentString = require('../js/shared-utils/parse-user-agent-string')
 const browserInfo = parseUserAgentString()
 
+const trackerBlockingEndpointBase = 'https://staticcdn.duckduckgo.com/trackerblocking'
+
+function isMV3 () {
+    return chrome?.runtime.getManifest().manifest_version === 3
+}
+
 function getConfigFileName () {
     let browserName = browserInfo?.browser?.toLowerCase() || ''
 
     // clamp to known browsers
     if (!['chrome', 'firefox', 'brave', 'edg'].includes(browserName)) {
         browserName = ''
     } else {
-        browserName = '-' + browserName + (chrome?.runtime.getManifest().manifest_version === 3 ? 'mv3' : '')
+        browserName = '-' + browserName + (isMV3() ? 'mv3' : '')
     }
-    return `https://staticcdn.duckduckgo.com/trackerblocking/config/v2/extension${browserName}-config.json`
+    return `${trackerBlockingEndpointBase}/config/v2/extension${browserName}-config.json`
+}
+
+/**
+ * Get the TDS endpoint associated with the current extension and given version.
+ *
+ * @param {`v6/${'current' | 'previous' | 'next'}` | 'beta'} version
+ * @returns {string}
+ */
+function getTDSEndpoint (version) {
+    const thisPlatform = `extension${isMV3() ? '-mv3' : ''}`
+    return `${trackerBlockingEndpointBase}/${version}/${thisPlatform}-tds.json`
 }
 
 module.exports = {
@@ -99,13 +116,13 @@ module.exports = {
         },
         {
             name: 'tds',
-            url: 'https://staticcdn.duckduckgo.com/trackerblocking/v6/current/extension-tds.json',
+            url: getTDSEndpoint('v6/current'),
             format: 'json',
             source: 'external',
             channels: {
-                live: 'https://staticcdn.duckduckgo.com/trackerblocking/v6/current/extension-tds.json',
-                next: 'https://staticcdn.duckduckgo.com/trackerblocking/v6/next/extension-tds.json',
-                beta: 'https://staticcdn.duckduckgo.com/trackerblocking/beta/extension-tds.json'
+                live: getTDSEndpoint('v6/current'),
+                next: getTDSEndpoint('v6/next'),
+                beta: getTDSEndpoint('beta')
             }
         },
         {