Release build 6.19.0 [ci release]

Sources/ContentScopeScripts/dist/contentScope.js

@@ -2583,6 +2583,9 @@
         if (this.getFeatureSettingEnabled("screenLock")) {
           this.screenLockFix();
         }
+        if (this.getFeatureSettingEnabled("modifyLocalStorage")) {
+          this.modifyLocalStorage();
+        }
       }
       /** Shim Web Share API in Android WebView */
       shimWebShare() {
@@ -2948,6 +2951,19 @@
         } catch {
         }
       }
+      /**
+       * Support for modifying localStorage entries
+       */
+      modifyLocalStorage() {
+        const settings = this.getFeatureSetting("modifyLocalStorage");
+        if (!settings || !settings.changes)
+          return;
+        settings.changes.forEach((change) => {
+          if (change.action === "delete") {
+            localStorage.removeItem(change.key);
+          }
+        });
+      }
       /**
        * Support for proxying `window.webkit.messageHandlers`
        */

build/android/contentScope.js

@@ -7899,6 +7899,10 @@
             if (this.getFeatureSettingEnabled('screenLock')) {
                 this.screenLockFix();
             }
+
+            if (this.getFeatureSettingEnabled('modifyLocalStorage')) {
+                this.modifyLocalStorage();
+            }
         }
 
         /** Shim Web Share API in Android WebView */
@@ -8313,6 +8317,22 @@
             }
         }
 
+        /**
+         * Support for modifying localStorage entries
+         */
+        modifyLocalStorage () {
+            /** @type {import('../types//webcompat-settings').WebCompatSettings['modifyLocalStorage']} */
+            const settings = this.getFeatureSetting('modifyLocalStorage');
+
+            if (!settings || !settings.changes) return
+
+            settings.changes.forEach((change) => {
+                if (change.action === 'delete') {
+                    localStorage.removeItem(change.key);
+                }
+            });
+        }
+
         /**
          * Support for proxying `window.webkit.messageHandlers`
          */

build/contentScope.js

@@ -14606,6 +14606,10 @@
             if (this.getFeatureSettingEnabled('screenLock')) {
                 this.screenLockFix();
             }
+
+            if (this.getFeatureSettingEnabled('modifyLocalStorage')) {
+                this.modifyLocalStorage();
+            }
         }
 
         /** Shim Web Share API in Android WebView */
@@ -15020,6 +15024,22 @@
             }
         }
 
+        /**
+         * Support for modifying localStorage entries
+         */
+        modifyLocalStorage () {
+            /** @type {import('../types//webcompat-settings').WebCompatSettings['modifyLocalStorage']} */
+            const settings = this.getFeatureSetting('modifyLocalStorage');
+
+            if (!settings || !settings.changes) return
+
+            settings.changes.forEach((change) => {
+                if (change.action === 'delete') {
+                    localStorage.removeItem(change.key);
+                }
+            });
+        }
+
         /**
          * Support for proxying `window.webkit.messageHandlers`
          */

build/integration/contentScope.js

@@ -14606,6 +14606,10 @@
             if (this.getFeatureSettingEnabled('screenLock')) {
                 this.screenLockFix();
             }
+
+            if (this.getFeatureSettingEnabled('modifyLocalStorage')) {
+                this.modifyLocalStorage();
+            }
         }
 
         /** Shim Web Share API in Android WebView */
@@ -15020,6 +15024,22 @@
             }
         }
 
+        /**
+         * Support for modifying localStorage entries
+         */
+        modifyLocalStorage () {
+            /** @type {import('../types//webcompat-settings').WebCompatSettings['modifyLocalStorage']} */
+            const settings = this.getFeatureSetting('modifyLocalStorage');
+
+            if (!settings || !settings.changes) return
+
+            settings.changes.forEach((change) => {
+                if (change.action === 'delete') {
+                    localStorage.removeItem(change.key);
+                }
+            });
+        }
+
         /**
          * Support for proxying `window.webkit.messageHandlers`
          */

integration-test/playwright/webcompat.spec.js

@@ -30,7 +30,7 @@ test('web compat', async ({ page }, testInfo) => {
 })
 
 export class WebcompatSpec {
-    htmlPage = '/webcompat/index.html'
+    htmlPage = '/webcompat/pages/message-handlers.html'
     config = './integration-test/test-pages/webcompat/config/message-handlers.json'
 
     /**

integration-test/test-pages.js

@@ -94,4 +94,11 @@ describe('Test integration pages', () => {
             `${process.cwd()}/integration-test/test-pages/webcompat/config/shims.json`
         )
     })
+
+    it('Properly modifies localStorage entries', async () => {
+        await testPage(
+            'webcompat/pages/modify-localstorage.html',
+            `${process.cwd()}/integration-test/test-pages/webcompat/config/modify-localstorage.json`
+        )
+    })
 })

integration-test/test-pages/webcompat/config/modify-localstorage.json

@@ -0,0 +1,41 @@
+{
+  "unprotectedTemporary": [],
+  "features": {
+    "webCompat": {
+      "exceptions": [],
+      "state": "enabled",
+      "settings": {
+        "windowSizing": "enabled",
+        "navigatorCredentials": "enabled",
+        "safariObject": "enabled",
+        "modifyLocalStorage": {
+          "state": "enabled",
+          "changes": []
+        },
+        "domains": [
+          {
+            "domain": ["localhost", "privacy-test-pages.site"],
+            "patchSettings": [
+              {
+                "op": "add",
+                "path": "/modifyLocalStorage/changes/-",
+                "value": {
+                  "key": "keyToBeDeleted",
+                  "action": "delete"
+                }
+              },
+              {
+                "op": "add",
+                "path": "/modifyLocalStorage/changes/-",
+                "value": {
+                  "key": "nonexistentKey",
+                  "action": "delete"
+                }
+              }
+            ]
+          }
+        ]
+      }
+    }
+  }
+}

integration-test/test-pages/webcompat/index.html

@@ -3,60 +3,15 @@
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width">
-    <title>Webcompat</title>
+    <title>Webcompat Interventions</title>
     <link rel="stylesheet" href="../shared/style.css">
 </head>
 <body>
-<script src="../shared/utils.js"></script>
-
-<p>Webcompat, Message Handlers</p>
-<script>
-    test('webkit.messageHandlers - polyfill prevents throw', async () => {
-        let notThrown = true;
-        try {
-            window.webkit.messageHandlers.anythingatall.postMessage({})
-        } catch (e) {
-            notThrown = false
-        }
-        return [
-            { name: 'Error not thrown polyfil', result: notThrown, expected: true },
-        ]
-    })
-    test('webkit.messageHandlers - undefined should throw', async () => {
-        let thrown = false;
-        try {
-            window.webkit.messageHandlers.jsHandler.postMessage({})
-        } catch (e) {
-            thrown = true
-        }
-        return [
-            { name: 'undefined handler should throw', result: thrown, expected: true },
-        ]
-    })
-    test('webkit.messageHandlers - reflected message', async () => {
-        window.webkit.messageHandlers.printHandler = {
-            postMessage() {
-                return { test: "test" }
-            }
-        }
-
-        const value = window.webkit.messageHandlers.printHandler.postMessage({});
-
-        return [
-            { name: 'reflected message should pass through', result: value.test, expected: 'test' },
-        ]
-    })
-    renderResults();
-
-    async function captureError(fn) {
-        try {
-            // ensure Promise.reject is captured
-            return fn().catch(e => e)
-        } catch (e) {
-            return e
-        }
-    }
-
-</script>
+    <p><a href="../../index.html">[Home]</a></p>
+    <ul>
+        <li><a href="./pages/message-handlers.html">Message Handlers</a> - <a href="./config/message-handlers.json">Config</a></li>
+        <li><a href="./pages/shims.html">Shims</a> - <a href="./config/shims.json">Config</a></li>
+        <li><a href="./pages/modify-localstorage.html">Modify localStorage</a> - <a href="./config/modify-localstorage.json">Config</a></li>
+    </ul>
 </body>
 </html>

integration-test/test-pages/webcompat/pages/message-handlers.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>Webcompat</title>
+    <link rel="stylesheet" href="../../shared/style.css">
+</head>
+<body>
+<script src="../../shared/utils.js"></script>
+
+<p>Webcompat, Message Handlers</p>
+<script>
+    test('webkit.messageHandlers - polyfill prevents throw', async () => {
+        let notThrown = true;
+        try {
+            window.webkit.messageHandlers.anythingatall.postMessage({})
+        } catch (e) {
+            notThrown = false
+        }
+        return [
+            { name: 'Error not thrown polyfil', result: notThrown, expected: true },
+        ]
+    })
+    test('webkit.messageHandlers - undefined should throw', async () => {
+        let thrown = false;
+        try {
+            window.webkit.messageHandlers.jsHandler.postMessage({})
+        } catch (e) {
+            thrown = true
+        }
+        return [
+            { name: 'undefined handler should throw', result: thrown, expected: true },
+        ]
+    })
+    test('webkit.messageHandlers - reflected message', async () => {
+        window.webkit.messageHandlers.printHandler = {
+            postMessage() {
+                return { test: "test" }
+            }
+        }
+
+        const value = window.webkit.messageHandlers.printHandler.postMessage({});
+
+        return [
+            { name: 'reflected message should pass through', result: value.test, expected: 'test' },
+        ]
+    })
+    renderResults();
+
+    async function captureError(fn) {
+        try {
+            // ensure Promise.reject is captured
+            return fn().catch(e => e)
+        } catch (e) {
+            return e
+        }
+    }
+
+</script>
+</body>
+</html>

integration-test/test-pages/webcompat/pages/modify-localstorage.html

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>Modify localStorage</title>
+    <link rel="stylesheet" href="../../shared/style.css">
+    <script>
+       window.localStorage.setItem('keyToBeDeleted', 'valueToBeDeleted')
+       window.localStorage.setItem('otherKey', 'valueToRemain')
+    </script>
+</head>
+<body>
+    <script src="../../shared/utils.js"></script>
+    <p><a href="../index.html">[WebCompat]</a></p>
+
+    <p>This page verifies that localStorage modifications work properly given the <a href="../config/modify-localstorage.json">config</a>. At this time, only deletion is supported.</p>
+
+    <script>
+        // eslint-disable-next-line no-undef
+        test('Only specified localStorage entry should be removed', async () => {
+            const specifiedKey = window.localStorage.getItem('keyToBeDeleted')
+            const nonexistentKey = window.localStorage.getItem('nonexistentKey')
+            const otherKey = window.localStorage.getItem('otherKey')
+
+            return [
+                { name: 'specified localStorage entry deleted', result: specifiedKey, expected: null },
+                { name: 'specified localStorage entry that is not present on page load', result: nonexistentKey, expected: null },
+                { name: 'other localStorage entry untouched', result: otherKey, expected: 'valueToRemain' }
+            ];
+        });
+
+        // eslint-disable-next-line no-undef
+        renderResults();
+    </script>
+</body>
+</html>