commit 413cb44a5bd2a554fb2819f15c1a16b96c29c0d9
author Adrià Vilanova Martínez <me@avm99963.com> Mon Sep 06 00:30:45 2021 +0200
committer Adrià Vilanova Martínez <me@avm99963.com> Mon Sep 06 18:29:23 2021 +0200
tree f99a514336a4fb2f226d587d018b939ffaffc66d
parent 8bbad168bd669c1ccb9f9ac76eb62fe9a72be150

Add kill switch mechanism

This code implements the kill switch mechanism in the extension. This is
explained in //src/killSwitch/README.md and in the design doc:
https://docs.google.com/document/d/1O5YV6_WcxwrUyz-lwHOSTfZ3oyIFWj2EQee0VuKkhaA/edit.

Bug: twpowertools:64

Change-Id: Ia993c78035bba7038aafd53d156f20954217e86f

src/common/optionsUtils.js

diff --git a/src/common/optionsUtils.js b/src/common/optionsUtils.js
index 16294ab..bfcb92c 100644
--- a/src/common/optionsUtils.js
+++ b/src/common/optionsUtils.js
@@ -6,7 +6,7 @@
 // Adds missing options with their default value. If |dryRun| is set to false,
 // they are also saved to the sync storage area.
 export function cleanUpOptions(options, dryRun = false) {
-  console.log('[cleanUpOptions] Previous options', JSON.stringify(options));
+  console.debug('[cleanUpOptions] Previous options', JSON.stringify(options));
 
   if (typeof options !== 'object' || options === null) options = {};
 
@@ -18,7 +18,7 @@
     }
   }
 
-  console.log('[cleanUpOptions] New options', JSON.stringify(options));
+  console.debug('[cleanUpOptions] New options', JSON.stringify(options));
 
   if (!ok && !dryRun) {
     chrome.storage.sync.set(options);
@@ -31,12 +31,29 @@
 // stored in the sync storage area.
 export function getOptions(options) {
   // Once we only target MV3, this can be greatly simplified.
-  return new Promise(
-      (resolve, reject) => {chrome.storage.sync.get(options, items => {
-        if (chrome.runtime.lastError) return reject(chrome.runtime.lastError);
+  return new Promise((resolve, reject) => {
+    if (typeof options === 'string')
+      options = [options, '_forceDisabledFeatures'];
+    else if (typeof options === 'array')
+      options = [...options, '_forceDisabledFeatures'];
+    else if (options !== null)
+      console.error('Unexpected |options| parameter (expected: string, array, or null).');
 
-        resolve(items);
-      })});
+    chrome.storage.sync.get(options, items => {
+      if (chrome.runtime.lastError) return reject(chrome.runtime.lastError);
+
+      // Handle applicable kill switches which force disable features
+      if (items?._forceDisabledFeatures) {
+        for (let feature of items?._forceDisabledFeatures) {
+          items[feature] = false;
+        }
+
+        delete items._forceDisabledFeatures;
+      }
+
+      resolve(items);
+    });
+  });
 }
 
 // Returns a promise which returns whether the |option| option/feature is