Excluding containers from sync with RegExp

mozilla · Dec 5, 2021 · 1da25b2 · 1da25b2
1 parent e3772b2
commit 1da25b2
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 1 deletion.
diff --git a/src/_locales b/src/_locales
diff --git a/src/js/background/backgroundLogic.js b/src/js/background/backgroundLogic.js
@@ -19,6 +19,8 @@ const backgroundLogic = {
         }
       }
     });
+
+    backgroundLogic.setDefaultOptions();
   },
 
   async getExtensionInfo() {
@@ -362,6 +364,17 @@ const backgroundLogic = {
   cookieStoreId(userContextId) {
     if(userContextId === 0) return "firefox-default";
     return `firefox-container-${userContextId}`;
+  },
+
+  async setDefaultOptions() {    
+    // Default container sync exclude regexp to "^tmp\d+$" to prevent
+    // https://github.com/mozilla/multi-account-containers/issues/1675
+    // https://github.com/stoically/temporary-containers/issues/371
+    // for future users of the MAC + TC combination.
+    const { syncExcludeRegExp } = await browser.storage.local.get("syncExcludeRegExp");
+    if (syncExcludeRegExp === undefined) {
+      browser.storage.local.set({syncExcludeRegExp: "^tmp\\d+$"});
+    }
   }
 };
 

diff --git a/src/js/background/sync.js b/src/js/background/sync.js
@@ -128,9 +128,16 @@ const sync = {
       await sync.checkForListenersMaybeAdd();
 
       async function updateSyncIdentities() {
+        const { syncExcludeRegExp } = await browser.storage.local.get("syncExcludeRegExp");
+        const excludeRegExp = new RegExp(syncExcludeRegExp, 'i');
         const identities = await browser.contextualIdentities.query({});
 
         for (const identity of identities) {
+          // skip excluded identities
+          if (identity.name.match(excludeRegExp)) {
+            continue;
+          }
+
           delete identity.colorCode;
           delete identity.iconUrl;
           identity.macAddonUUID = await identityState.lookupMACaddonUUID(identity.cookieStoreId);

diff --git a/src/js/options.js b/src/js/options.js
@@ -29,11 +29,13 @@ async function setupOptions() {
   const hasPermission = await browser.permissions.contains({permissions: ["bookmarks"]});
   const { syncEnabled } = await browser.storage.local.get("syncEnabled");
   const { replaceTabEnabled } = await browser.storage.local.get("replaceTabEnabled");
+  const { syncExcludeRegExp } = await browser.storage.local.get("syncExcludeRegExp");
   if (hasPermission) {
     document.querySelector("#bookmarksPermissions").checked = true;
   }
   document.querySelector("#syncCheck").checked = !!syncEnabled;
   document.querySelector("#replaceTabCheck").checked = !!replaceTabEnabled;
+  document.querySelector("#syncExcludeRegExp").value = syncExcludeRegExp || "";
   setupContainerShortcutSelects();
 }
 
@@ -78,11 +80,16 @@ function resetOnboarding() {
   browser.storage.local.set({"onboarding-stage": 0});
 }
 
+function updateSyncExcludeRegExp(event) {
+  browser.storage.local.set({syncExcludeRegExp: event.target.value});
+}
+
 document.addEventListener("DOMContentLoaded", setupOptions);
 document.querySelector("#bookmarksPermissions").addEventListener( "change", requestPermissions);
 document.querySelector("#syncCheck").addEventListener( "change", enableDisableSync);
 document.querySelector("#replaceTabCheck").addEventListener( "change", enableDisableReplaceTab);
 document.querySelector("button").addEventListener("click", resetOnboarding);
+document.querySelector("#syncExcludeRegExp").addEventListener( "change", updateSyncExcludeRegExp);
 
 for (let i=0; i < NUMBER_OF_KEYBOARD_SHORTCUTS; i++) {
   document.querySelector("#open_container_"+i)

diff --git a/src/options.html b/src/options.html
@@ -83,6 +83,9 @@ <h3 data-i18n-message-id="keyboardShortCuts"></h3>
       <h3 data-i18n-message-id="onboarding"></h3>
       <button data-i18n-message-id="resetOnboardingPanels"></button>
       <p><em data-i18n-message-id="onboardingToggle"></em></p>
+      <h3 data-i18n-message-id="syncExclude"></h3>
+      <input id="syncExcludeRegExp">
+      <p><em data-i18n-message-id="syncExcludeDescription"></em></p>
     </form>
     <script src="js/options.js"></script>
   </body>