Add tests for gpcHeaderEnabledSites (#72)

* Add tests for gpcHeaderEnabledSites https://app.asana.com/0/1200606622205980/1203496117125023/f * Add tests for platforms that don't implement gpcHeaderEnabledSites * Improve test name description * Remove android from gpcHeader specific tests * Update readme * Change documentation style
duckduckgo · Feb 8, 2023 · 2c8192b · 2c8192b
1 parent 746c592
commit 2c8192b
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/global-privacy-control/README.md b/global-privacy-control/README.md
@@ -55,3 +55,7 @@ for $testSet in test.json
             expect(getJSPropertyValue('Navigator.prototype.globalPrivacyControl') === $test.expectGPCAPIValue)
 
 ```
+
+## Platform exceptions
+
+- On platforms where header modifications is limited headers should only be modified on sites listed in gpcHeaderEnabledSites inside the settings of the gpc feature of the remote config.
diff --git a/global-privacy-control/tests.json b/global-privacy-control/tests.json
@@ -22,6 +22,33 @@
                 "expectGPCHeader": false,
                 "exceptPlatforms": []
             },
+            {
+                "name": "Header not injected on platforms using gpcHeaderEnabledSites - domain is excluded from gpcHeaderEnabledSites",
+                "siteURL": "http://anotherexample.com",
+                "requestURL": "http://anotherexample.com",
+                "requestType": "main_frame",
+                "gpcUserSettingOn": true,
+                "expectGPCHeader": false,
+                "exceptPlatforms": [
+                    "web-extension",
+                    "safari-extension",
+                    "windows-browser",
+                    "android-browser"
+                ]
+            },
+            {
+                "name": "Header injected on platforms not using gpcHeaderEnabledSites - domain is excluded from gpcHeaderEnabledSites",
+                "siteURL": "http://anotherexample.com",
+                "requestURL": "http://anotherexample.com",
+                "requestType": "main_frame",
+                "gpcUserSettingOn": true,
+                "expectGPCHeader": true,
+                "exceptPlatforms": [
+                    "ios-browser",
+                    "macos-browser",
+                    "android-browser"
+                ]
+            },
             {
                 "name": "Header not injected - privacy config local exception (gpc/exceptions)",
                 "siteURL": "https://www.washingtonpost.com/",
@@ -101,6 +128,14 @@
                 "expectGPCAPI": true,
                 "exceptPlatforms": []
             },
+            {
+                "name": "API injected - domain is excluded from gpcHeaderEnabledSites, JavaScript API should still work",
+                "siteURL": "http://anotherexample.com",
+                "gpcUserSettingOn": true,
+                "expectGPCAPI": true,
+                "expectGPCAPIValue": "true",
+                "exceptPlatforms": []
+            },
             {
                 "name": "API NOT injected - excluded site (gpc/exceptions)",
                 "siteURL": "https://www.washingtonpost.com/",