Match feature state to feature table (#79)

* Match feature state to feature table * Remove state keys * Fix auto consent * Branch updates * Fix legacy generation * Update gh action node version
duckduckgo · Dec 13, 2021 · 048762b · 048762b
1 parent f0dea46
commit 048762b
Show file tree

Hide file tree

Showing 20 changed files with 133 additions and 68 deletions.
diff --git a/action.yml b/action.yml
@@ -3,5 +3,5 @@ description: 'Build generated privacy configs'
 author: DuckDuckGo
 
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'index.js'
diff --git a/features/amp-links.json b/features/amp-links.json
@@ -0,0 +1,31 @@
+{
+    "_meta": {
+        "description": "Rewrite AMP links to safer alternatives.",
+        "sampleExcludeRecords": {
+            "domain": "example.com",
+            "reason": "site breakage"
+        }
+    },
+    "exceptions": [],
+    "settings": {
+        "ampLinkFormats": [
+            "^https?:\\/\\/(?:w{3}\\.)?google\\.\\S{2,}\\/amp\\/s\\/(\\S+)$",
+            "^https?:\\/\\/\\S+ampproject\\.org\\/v\\/s\\/(\\S+)$"
+        ],
+        "ampKeywords": [
+            "=amp",
+            "amp=",
+            "&amp",
+            "amp&",
+            "/amp",
+            "amp/",
+            ".amp",
+            "amp.",
+            "%amp",
+            "amp%",
+            "_amp",
+            "amp_",
+            "?amp"
+        ]
+    }
+}
diff --git a/features/autoconsent.json b/features/autoconsent.json
@@ -6,7 +6,6 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": [{
         "domain": "spiegel.de",
         "reason": "Opt-out not possible"

diff --git a/features/click-to-play.json b/features/click-to-play.json
@@ -6,6 +6,5 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": []
 }
diff --git a/features/fingerprinting-battery.json b/features/fingerprinting-battery.json
@@ -6,6 +6,5 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": []
 }
diff --git a/features/fingerprinting-canvas.json b/features/fingerprinting-canvas.json
@@ -6,7 +6,6 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": [
         {
             "domain": "walgreens.com",

diff --git a/features/fingerprinting-hardware.json b/features/fingerprinting-hardware.json
@@ -6,7 +6,6 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": [
         {
             "domain": "play.geforcenow.com",

diff --git a/features/fingerprinting-screen-size.json b/features/fingerprinting-screen-size.json
@@ -6,6 +6,5 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": []
 }
diff --git a/features/fingerprinting-temporary-storage.json b/features/fingerprinting-temporary-storage.json
@@ -6,6 +6,5 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": []
 }
diff --git a/features/floc.json b/features/floc.json
@@ -6,6 +6,5 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": []
 }
diff --git a/features/navigator-credentials.json b/features/navigator-credentials.json
@@ -0,0 +1,10 @@
+{
+    "_meta": {
+        "description": "Disable the credentials API on the navigator",
+        "sampleExcludeRecords": {
+            "domain": "example.com",
+            "reason": "site breakage"
+        }
+    },
+    "exceptions": []
+}
diff --git a/features/referrer.json b/features/referrer.json
@@ -6,6 +6,5 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "exceptions": []
 }
diff --git a/features/tracking-cookies-1p.json b/features/tracking-cookies-1p.json
@@ -6,7 +6,6 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "settings": {
         "firstPartyTrackerCookiePolicy": {
             "threshold": 86400,

diff --git a/features/tracking-cookies-3p.json b/features/tracking-cookies-3p.json
@@ -6,7 +6,6 @@
             "reason": "site breakage"
         }
     },
-    "state": "enabled",
     "settings": {
         "excludedCookieDomains": [
             {

diff --git a/features/tracking-parameters.json b/features/tracking-parameters.json
@@ -0,0 +1,35 @@
+{
+    "_meta": {
+        "description": "Rewrite links with tracking parameters to safer alternatives.",
+        "sampleExcludeRecords": {
+            "domain": "example.com",
+            "reason": "site breakage"
+        }
+    },
+    "exceptions": [],
+    "settings": {
+        "trackingParameters": [
+            "utm_[a-zA-Z]*",
+            "gclid",
+            "fbclid",
+            "fb_action_ids",
+            "fb_action_types",
+            "fb_source",
+            "fb_ref",
+            "ga_source",
+            "ga_medium",
+            "ga_term",
+            "ga_content",
+            "ga_campaign",
+            "ga_place",
+            "action_object_map",
+            "action_type_map",
+            "action_ref_map",
+            "gs_l",
+            "mkt_tok",
+            "hmb_campaign",
+            "hmb_source",
+            "hmb_medium"
+        ]
+    }
+}
diff --git a/features/user-agent-rotation.json b/features/user-agent-rotation.json
@@ -6,7 +6,6 @@
             "reason": "Two factor auth that verifies device pathes using user agent"
         }
     },
-    "state": "disabled",
     "settings": {
         "agentExcludePatterns": [
             {

diff --git a/index.js b/index.js
@@ -137,13 +137,18 @@ const legacyNaming = {
 const protections = {}
 for (const key in legacyNaming) {
     let newConfig
+    const override = JSON.parse(fs.readFileSync(`${OVERRIDE_DIR}/extension-override.json`))
     if (!defaultConfig.features[key] || defaultConfig.features[key].state !== 'enabled') {
-        const override = JSON.parse(fs.readFileSync(`${OVERRIDE_DIR}/extension-override.json`))
         if (!override.features[key]) {
             continue
         }
 
         newConfig = override.features[key]
+        if (!newConfig.exceptions) {
+            // feature may be disabled in default config but enabled in override
+            // add exceptions from default config
+            newConfig.exceptions = defaultConfig.features[key]?.exceptions || []
+        }
 
         // TODO: convert camel key to hyphen
         if (fs.existsSync(`${LISTS_DIR}/${key}.json`)) {
@@ -152,6 +157,7 @@ for (const key in legacyNaming) {
         }
     } else {
         newConfig = defaultConfig.features[key]
+        newConfig.exceptions = newConfig.exceptions.concat(override.features[key]?.exceptions || [])
     }
     const legacyConfig = {
         enabled: newConfig.state === 'enabled',

diff --git a/overrides/extension-override.json b/overrides/extension-override.json
@@ -1,8 +1,40 @@
 {
     "features": {
         "autofill": {
-            "state": "enabled",
-            "exceptions": []
+            "state": "enabled"
+        },
+        "referrer": {
+            "state": "enabled"
+        },
+        "clickToPlay": {
+            "state": "enabled"
+        },
+        "trackingCookies3p": {
+            "state": "enabled"
+        },
+        "trackingCookies1p": {
+            "state": "enabled"
+        },
+        "fingerprintingCanvas": {
+            "state": "enabled"
+        },
+        "fingerprintingAudio": {
+            "state": "disabled"
+        },
+        "fingerprintingTemporaryStorage": {
+            "state": "enabled"
+        },
+        "fingerprintingScreenSize": {
+            "state": "enabled"
+        },
+        "fingerprintingHardware": {
+            "state": "enabled"
+        },
+        "fingerprintingBattery": {
+            "state": "enabled"
+        },
+        "floc": {
+            "state": "enabled"
         }
     },
     "unprotectedTemporary": [

diff --git a/overrides/ios-override.json b/overrides/ios-override.json
@@ -8,6 +8,15 @@
                 }
             ]
         },
+        "fingerprintingTemporaryStorage": {
+            "state": "enabled"
+        },
+        "fingerprintingScreenSize": {
+            "state": "enabled"
+        },
+        "fingerprintingBattery": {
+            "state": "enabled"
+        },
         "gpc": {
             "settings": {
                 "gpcHeaderEnabledSites": [
@@ -19,58 +28,10 @@
             }
         },
         "ampLinks": {
-            "state": "enabled",
-            "exceptions": [],
-            "settings": {
-                "linkFormats": [
-                    "^https?:\\/\\/(?:w{3}\\.)?google\\.\\S{2,}\\/amp\\/s\\/(\\S+)$",
-                    "^https?:\\/\\/\\S+ampproject\\.org\\/v\\/s\\/(\\S+)$"
-                ],
-                "keywords": [
-                    "=amp",
-                    "amp=",
-                    "&amp",
-                    "amp&",
-                    "/amp",
-                    "amp/",
-                    ".amp",
-                    "amp.",
-                    "%amp",
-                    "amp%",
-                    "_amp",
-                    "amp_",
-                    "?amp"
-                ]
-            }
+            "state": "enabled"
         },
         "trackingParameters": {
-            "state": "enabled",
-            "exceptions": [],
-            "settings": {
-                "parameters": [
-                    "utm_[a-zA-Z]*",
-                    "gclid",
-                    "fbclid",
-                    "fb_action_ids",
-                    "fb_action_types",
-                    "fb_source",
-                    "fb_ref",
-                    "ga_source",
-                    "ga_medium",
-                    "ga_term",
-                    "ga_content",
-                    "ga_campaign",
-                    "ga_place",
-                    "action_object_map",
-                    "action_type_map",
-                    "action_ref_map",
-                    "gs_l",
-                    "mkt_tok",
-                    "hmb_campaign",
-                    "hmb_source",
-                    "hmb_medium"
-                ]
-            }
+            "state": "enabled"
         }
     },
     "unprotectedTemporary": [

diff --git a/overrides/macos-override.json b/overrides/macos-override.json
@@ -1,8 +1,10 @@
 {
     "features": {
         "navigatorCredentials": {
-            "state": "enabled",
-            "exceptions": []
+            "state": "enabled"
+        },
+        "autoconsent": {
+            "state": "enabled"
         },
         "gpc": {
             "settings": {