fix: session rules should be used instead of dynamic rules

session rules are less persistent than dynamic rules, and the intention of RequestBuilder is to only have rules active for the lifetime of specific requests.
yomidevs · Oct 29, 2023 · ba8eec9 · ba8eec9
1 parent 0adf9ce
commit ba8eec9
Showing 1 changed file with 46 additions and 4 deletions.
diff --git a/ext/js/background/request-builder.js b/ext/js/background/request-builder.js
@@ -42,6 +42,7 @@ class RequestBuilder {
     async prepare() {
         try {
             await this._clearDynamicRules();
+            await this._clearSessionRules();
         } catch (e) {
             // NOP
         }
@@ -260,6 +261,21 @@ class RequestBuilder {
         }
     }
 
+    async _clearSessionRules() {
+        if (!isObject(chrome.declarativeNetRequest)) { return; }
+
+        const rules = await this._getSessionRules();
+
+        if (rules.length === 0) { return; }
+
+        const removeRuleIds = [];
+        for (const {id} of rules) {
+            removeRuleIds.push(id);
+        }
+
+        await this._updateSessionRules({removeRuleIds});
+    }
+
     async _clearDynamicRules() {
         if (!isObject(chrome.declarativeNetRequest)) { return; }
 
@@ -311,17 +327,43 @@ class RequestBuilder {
                 }
             }];
 
-            await this._updateDynamicRules({addRules});
+            await this._updateSessionRules({addRules});
             try {
                 return await fetch(url, init);
             } finally {
-                await this._tryUpdateDynamicRules({removeRuleIds: [id]});
+                await this._tryUpdateSessionRules({removeRuleIds: [id]});
             }
         } finally {
             this._ruleIds.delete(id);
         }
     }
 
+    _getSessionRules() {
+        return new Promise((resolve, reject) => {
+            chrome.declarativeNetRequest.getSessionRules((result) => {
+                const e = chrome.runtime.lastError;
+                if (e) {
+                    reject(new Error(e.message));
+                } else {
+                    resolve(result);
+                }
+            });
+        });
+    }
+
+    _updateSessionRules(options) {
+        return new Promise((resolve, reject) => {
+            chrome.declarativeNetRequest.updateSessionRules(options, () => {
+                const e = chrome.runtime.lastError;
+                if (e) {
+                    reject(new Error(e.message));
+                } else {
+                    resolve();
+                }
+            });
+        });
+    }
+
     _getDynamicRules() {
         return new Promise((resolve, reject) => {
             chrome.declarativeNetRequest.getDynamicRules((result) => {
@@ -348,9 +390,9 @@ class RequestBuilder {
         });
     }
 
-    async _tryUpdateDynamicRules(options) {
+    async _tryUpdateSessionRules(options) {
         try {
-            await this._updateDynamicRules(options);
+            await this._updateSessionRules(options);
             return true;
         } catch (e) {
             return false;