worked on the duplicate bug

src/js/background/sync.js

@@ -58,6 +58,7 @@ const sync = {
         console.log("in sync: ", storage);
         const localStorage = await browser.storage.local.get();
         console.log("inLocal:", localStorage);
+        console.log("indents: ", await browser.contextualIdentities.query({}));
       }
       browser.storage.onChanged.addListener(
         sync.storageArea.onChangedListener);
@@ -168,6 +169,7 @@ const sync = {
     if (SYNC_DEBUG) {
       console.log("inSync: ", syncInfo);
       console.log("inLocal: ", localInfo);
+      console.log("indents: ", await browser.contextualIdentities.query({}));
     }
     const beenSynced = await assignManager.storageArea.getSynced();
     if (beenSynced){
@@ -202,7 +204,7 @@ async function runSync() {
 
 async function restore() {
   console.log("restore");
-  await reconcileIdentitiesByUUID();
+  await reconcileIdentities();
   await reconcileSiteAssignments();
   await sync.storageArea.backup();
 }
@@ -250,57 +252,104 @@ async function reconcileIdentities(){
       await browser.contextualIdentities.remove(deletedCookieStoreId);
     }
   }
-  
+
   const localIdentities = await browser.contextualIdentities.query({});
   const syncIdentities = 
-    await sync.storageArea.getStoredObject("identities");
+    await sync.storageArea.getStoredArray("identities");
   const cookieStoreIDmap = 
     await sync.storageArea.getStoredObject("cookieStoreIDmap");
+  // now compare all containers for matching names.
   for (const syncIdentity of syncIdentities) {
     syncIdentity.macAddonUUID = cookieStoreIDmap[syncIdentity.cookieStoreId];
-    const match = localIdentities.find(
+    const localMatch = localIdentities.find(
       localIdentity => localIdentity.name === syncIdentity.name
     );
-    if (!match) {
+    if (!localMatch) {
-      console.log("create new ident: ", syncIdentity.name);
+      // if there's no name match found, check on uuid,
-      const newIdentity = 
+      const localCookieStoreID = 
+        await identityState.lookupCookieStoreId(syncIdentity.macAddonUUID);
+      if (localCookieStoreID) {
+        await ifUUIDMatch(syncIdentity, localCookieStoreID);
+        continue;
+      }
+      await ifNoMatch(syncIdentity);
+      continue;
+    }
+    await ifNamesMatch(syncIdentity, localMatch);
+    continue;
+  }
+}
+
+async function ifNamesMatch(syncIdentity, localMatch) {
+  // Sync is truth. if there is a match, compare data and update as needed
+  if (syncIdentity.color !== localMatch.color 
+      || syncIdentity.icon !== localMatch.icon) {
+    await browser.contextualIdentities.update(
+      localMatch.cookieStoreId, {
+        name: syncIdentity.name, 
+        color: syncIdentity.color, 
+        icon: syncIdentity.icon
+      });
+
+    if (SYNC_DEBUG) {
+      if (localMatch.color !== syncIdentity.color) {
+        console.log(localMatch.name, "Change color: ", syncIdentity.color);
+      }
+      if (localMatch.icon !== syncIdentity.icon) {
+        console.log(localMatch.name, "Change icon: ", syncIdentity.icon);
+      }
+    }
+  }
+
+  // Sync is truth. If all is the same, update the local uuid to match sync
+  await identityState.updateUUID(
+    localMatch.cookieStoreId, 
+    syncIdentity.macAddonUUID
+  );
+}
+
+async function ifUUIDMatch(syncIdentity, localCookieStoreID) {
+  // if there's a local uuid, it's the same container. Sync is truth
+  const identityInfo = {
+    name: syncIdentity.name,
+    color: syncIdentity.color, 
+    icon: syncIdentity.icon
+  };
+  if (SYNC_DEBUG) {
+    const getIdent = 
+            await browser.contextualIdentities.get(localCookieStoreID);
+    if (getIdent.name !== identityInfo.name) {
+      console.log(getIdent.name, "Change name: ", identityInfo.name);
+    }
+    if (getIdent.color !== identityInfo.color) {
+      console.log(getIdent.name, "Change color: ", identityInfo.color);
+    }
+    if (getIdent.icon !== identityInfo.icon) {
+      console.log(getIdent.name, "Change icon: ", identityInfo.icon);
+    }
+  }
+
+  // update the local container with the sync data
+  await browser.contextualIdentities
+    .update(localCookieStoreID, identityInfo);
+  return;
+}
+
+async function ifNoMatch(syncIdentity){
+  // if no uuid match either, make new identity
+  console.log("create new ident: ", syncIdentity.name);
+  const newIdentity = 
         await browser.contextualIdentities.create({
           name: syncIdentity.name, 
           color: syncIdentity.color, 
           icon: syncIdentity.icon
         });
-      await identityState.updateUUID(
+  await identityState.updateUUID(
-        newIdentity.cookieStoreId, 
+    newIdentity.cookieStoreId, 
-        syncIdentity.macAddonUUID
+    syncIdentity.macAddonUUID
-      );
+  );
-      continue;
+  return;
-    }
-    if (syncIdentity.color !== match.color 
-      || syncIdentity.icon !== match.icon) {
-      await browser.contextualIdentities.update(
-        match.cookieStoreId, {
-          name: syncIdentity.name, 
-          color: syncIdentity.color, 
-          icon: syncIdentity.icon
-        });
-      continue;
-    }
-    if (SYNC_DEBUG) {
-      if (match.color !== syncIdentity.color) {
-        console.log(match.name, "Change color: ", syncIdentity.color);
-      }
-      if (match.icon !== syncIdentity.icon) {
-        console.log(match.name, "Change icon: ", syncIdentity.icon);
-      }
-    }
-    // end testing
-    await identityState.updateUUID(
-      match.cookieStoreId, 
-      cookieStoreIDmap[syncIdentity.cookieStoreId]
-    );
-  }
 }
-
 /*
  * Checks for site previously assigned. If it exists, and has the same
  * container assignment, the assignment is kept. If it exists, but has
@@ -381,7 +430,7 @@ async function reconcileIdentitiesByUUID() {
   const syncIdentities = await sync.storageArea.getStoredObject("identities");
   const cookieStoreIDmap = 
     await sync.storageArea.getStoredObject("cookieStoreIDmap");
-    
+
   const deletedIdentityList =
     await sync.storageArea.getStoredArray("deletedIdentityList");
   // first remove any deleted identities

src/js/background/test.js

@@ -3,31 +3,35 @@ browser.tests = {
     await this.testIdentityStateCleanup();
     await this.test1();
     await this.test2();
+    await this.dupeTest();
   },
 
   async testIdentityStateCleanup() {
     await browser.tests.stopSyncListeners();
     console.log("Testing the cleanup of local storage");
-    await this.removeAllContainers();
+
-    const localData = {
+    await this.setState({}, LOCAL_DATA, TEST_CONTAINERS);
-      "browserActionBadgesClicked": [ "6.1.1" ],
+
-      "containerTabsOpened": 7,
+    // await this.removeAllContainers();
-      "identitiesState@@_firefox-default": { "hiddenTabs": [] },
+    // const localData = {
-      "onboarding-stage": 5,
+    //   "browserActionBadgesClicked": [ "6.1.1" ],
-      "identitiesState@@_firefox-container-7": { "hiddenTabs": [] }
+    //   "containerTabsOpened": 7,
-    };
+    //   "identitiesState@@_firefox-default": { "hiddenTabs": [] },
-    await browser.storage.local.clear();
+    //   "onboarding-stage": 5,
-    await browser.storage.local.set(localData);
+    //   "identitiesState@@_firefox-container-7": { "hiddenTabs": [] }
-    // async function assignIdentities () {
+    // };
-    for (const containerInputSet of TEST_CONTAINERS) {
+    // await browser.storage.local.clear();
-      await browser.contextualIdentities.create(containerInputSet);
+    // await browser.storage.local.set(localData);
-    }
+    // // async function assignIdentities () {
+    // for (const containerInputSet of TEST_CONTAINERS) {
+    //   await browser.contextualIdentities.create(containerInputSet);
+    // }
     // }
     // await assignIdentities();
     await identityState.storageArea.cleanup();
+
     const macConfigs = await browser.storage.local.get();
     const identities = [];
-
     for(const configKey of Object.keys(macConfigs)) {
       if (configKey.includes("identitiesState@@_") && !configKey.includes("default")) {
         identities.push(macConfigs[configKey]);
@@ -44,14 +48,7 @@ browser.tests = {
     await browser.tests.stopSyncListeners();
     console.log("Testing new install with no sync");
 
-    // sync state on install: no sync data
+    await this.setState({}, LOCAL_DATA, TEST_CONTAINERS);
-    await browser.storage.sync.clear();
-    await browser.storage.local.clear();
-    await browser.storage.local.set(LOCAL_DATA);
-    await this.removeAllContainers();
-    for (const containerInputSet of TEST_CONTAINERS) {
-      await browser.contextualIdentities.create(containerInputSet);
-    }
 
     await sync.initSync();
 
@@ -88,31 +85,10 @@ browser.tests = {
     await browser.tests.stopSyncListeners();
     console.log("Testing sync differing from local");
 
-    await this.removeAllContainers();
+    await this.setState(SYNC_DATA, LOCAL_DATA, TEST_CONTAINERS, TEST_ASSIGNMENTS);
-    await browser.storage.sync.clear();
-    await browser.storage.sync.set(SYNC_DATA);
-    await browser.storage.local.clear();
-    const localData = LOCAL_DATA;
-    for (let i=0; i < TEST_CONTAINERS.length; i++) {
-      //build identities
-      const newIdentity = 
-        await browser.contextualIdentities.create(TEST_CONTAINERS[i]);
-      // fill identies with site assignments
-      if (TEST_ASSIGNMENTS[i]) {
-        localData[TEST_ASSIGNMENTS[i]] =  { 
-          "userContextId": 
-            String(
-              newIdentity.cookieStoreId.replace(/^firefox-container-/, "")
-            ),
-          "neverAsk": true
-        };
-      }
-    }
-    await browser.storage.local.set(localData);
-    console.log("local storage set: ", await browser.storage.local.get());
 
     await sync.initSync();
-    
+
     const getSync = await browser.storage.sync.get();
     const getAssignedSites = 
       await assignManager.storageArea.getAssignedSites();
@@ -144,6 +120,102 @@ browser.tests = {
     console.log("Finished!");
   },
 
+  async dupeTest() {
+    await browser.tests.stopSyncListeners();
+    console.log("Test state from duped sync");
+
+    await this.setState(
+      DUPE_TEST_SYNC, 
+      DUPE_TEST_LOCAL, 
+      DUPE_TEST_IDENTS, 
+      DUPE_TEST_ASSIGNMENTS
+    );
+
+    await sync.initSync();
+
+    const getSync = await browser.storage.sync.get();
+    const getAssignedSites = 
+      await assignManager.storageArea.getAssignedSites();
+
+    const identities = await browser.contextualIdentities.query({});
+
+    const localCookieStoreIDmap = 
+      await identityState.getCookieStoreIDuuidMap();
+
+    console.assert(
+      Object.keys(getSync.cookieStoreIDmap).length === 7, 
+      "cookieStoreIDmap should have 7 entries"
+    );
+
+    console.assert(
+      Object.keys(localCookieStoreIDmap).length === 8, 
+      "localCookieStoreIDmap should have 8 entries"
+    );
+
+    console.assert(
+      identities.length === 7,
+      "There should be 7 identities"
+    );
+
+    console.assert(
+      Object.keys(getAssignedSites).length === 5,
+      "There should be 5 site assignments"
+    );
+
+    const personalContainer = 
+      this.lookupIdentityBy(identities, {name: "Personal"});
+    console.log(personalContainer);
+    console.assert(
+      personalContainer.color === "red",
+      "Personal Container should be red"
+    );
+    const mozillaContainer =
+      this.lookupIdentityBy(identities, {name: "Mozilla"});
+    console.assert(
+      mozillaContainer.icon === "pet",
+      "Mozilla Container should be pet"
+    );
+    console.log("Finished!");
+  },
+
+  lookupIdentityBy(identities, options) {
+    for (const identity of identities) {
+      if (options && options.name) {
+        if (identity.name === options.name) return identity;
+      }
+      if (options && options.color) {
+        if (identity.color === options.color) return identity;
+      }
+      if (options && options.color) {
+        if (identity.color === options.color) return identity;
+      }
+    }
+    return false;
+  },
+  async setState(syncData, localData, indentityData, assignmentData){
+    await this.removeAllContainers();
+    await browser.storage.sync.clear();
+    await browser.storage.sync.set(syncData);
+    await browser.storage.local.clear();
+    for (let i=0; i < indentityData.length; i++) {
+      //build identities
+      const newIdentity = 
+        await browser.contextualIdentities.create(indentityData[i]);
+      // fill identies with site assignments
+      if (assignmentData && assignmentData[i]) {
+        localData[assignmentData[i]] =  { 
+          "userContextId": 
+            String(
+              newIdentity.cookieStoreId.replace(/^firefox-container-/, "")
+            ),
+          "neverAsk": true
+        };
+      }
+    }
+    await browser.storage.local.set(localData);
+    console.log("local storage set: ", await browser.storage.local.get());
+    return;
+  },
   async removeAllContainers() {
     const identities = await browser.contextualIdentities.query({});
     for (const identity of identities) {
@@ -275,6 +347,146 @@ browser.resetMAC2 = async function () {
 
 };
 
+const DUPE_TEST_SYNC = {
+  "identities": [
+    {
+      "name": "Personal",
+      "icon": "fingerprint",
+      "iconUrl": "resource://usercontext-content/fingerprint.svg",
+      "color": "red",
+      "colorCode": "#ff613d",
+      "cookieStoreId": "firefox-container-588"
+    },
+    {
+      "name": "Banking",
+      "icon": "dollar",
+      "iconUrl": "resource://usercontext-content/dollar.svg",
+      "color": "green",
+      "colorCode": "#51cd00",
+      "cookieStoreId": "firefox-container-589"
+    },
+    {
+      "name": "Mozilla",
+      "icon": "pet",
+      "iconUrl": "resource://usercontext-content/pet.svg",
+      "color": "red",
+      "colorCode": "#ff613d",
+      "cookieStoreId": "firefox-container-590"
+    },
+    {
+      "name": "Groceries, obviously",
+      "icon": "cart",
+      "iconUrl": "resource://usercontext-content/cart.svg",
+      "color": "pink",
+      "colorCode": "#ff4bda",
+      "cookieStoreId": "firefox-container-591"
+    },
+    {
+      "name": "Facebook",
+      "icon": "fence",
+      "iconUrl": "resource://usercontext-content/fence.svg",
+      "color": "toolbar",
+      "colorCode": "#7c7c7d",
+      "cookieStoreId": "firefox-container-592"
+    },
+    {
+      "name": "Oscar",
+      "icon": "dollar",
+      "iconUrl": "resource://usercontext-content/dollar.svg",
+      "color": "green",
+      "colorCode": "#51cd00",
+      "cookieStoreId": "firefox-container-593"
+    }
+  ],
+  "cookieStoreIDmap": {
+    "firefox-container-588": "d20d7af2-9866-468e-bb43-541efe8c2c2e",
+    "firefox-container-589": "cdd73c20-c26a-4c06-9b17-735c1f5e9187",
+    "firefox-container-590": "32cc4a9b-05ed-4e54-8e11-732468de62f4",
+    "firefox-container-591": "9ff381e3-4c11-420d-8e12-e352a3318be1",
+    "firefox-container-592": "3dc916fb-8c0a-4538-9758-73ef819a45f7",
+    "firefox-container-593": "63e5212f-0858-418e-b5a3-09c2dea61fcd"
+  },
+  "assignedSites": {
+    "siteContainerMap@@_developer.mozilla.org": {
+      "userContextId": "588",
+      "neverAsk": true,
+      "hostname": "developer.mozilla.org"
+    },
+    "siteContainerMap@@_reddit.com": {
+      "userContextId": "592",
+      "neverAsk": true,
+      "hostname": "reddit.com"
+    },
+    "siteContainerMap@@_twitter.com": {
+      "userContextId": "589",
+      "neverAsk": true,
+      "hostname": "twitter.com"
+    },
+    "siteContainerMap@@_www.facebook.com": {
+      "userContextId": "590",
+      "neverAsk": true,
+      "hostname": "www.facebook.com"
+    },
+    "siteContainerMap@@_www.linkedin.com": {
+      "userContextId": "591",
+      "neverAsk": true,
+      "hostname": "www.linkedin.com"
+    }
+  }
+};
+
+const DUPE_TEST_LOCAL = {
+  "beenSynced": true,
+  "browserActionBadgesClicked": [
+    "6.1.1"
+  ],
+  "containerTabsOpened": 7,
+  "identitiesState@@_firefox-default": {
+    "hiddenTabs": []
+  },
+  "onboarding-stage": 5,
+};
+
+const DUPE_TEST_ASSIGNMENTS = [
+  "siteContainerMap@@_developer.mozilla.org",
+  "siteContainerMap@@_reddit.com",
+  "siteContainerMap@@_twitter.com",
+  "siteContainerMap@@_www.facebook.com",
+  "siteContainerMap@@_www.linkedin.com"
+];
+
+const DUPE_TEST_IDENTS = [
+  {
+    "name": "Personal",
+    "icon": "fingerprint",
+    "color": "blue",
+  },
+  {
+    "name": "Banking",
+    "icon": "pet",
+    "color": "green",
+  },
+  {
+    "name": "Mozilla",
+    "icon": "briefcase",
+    "color": "red",
+  },
+  {
+    "name": "Groceries, obviously",
+    "icon": "cart",
+    "color": "orange",
+  },
+  {
+    "name": "Facebook",
+    "icon": "fence",
+    "color": "toolbar",
+  },
+  {
+    "name": "Big Bird",
+    "icon": "dollar",
+    "color": "yellow",
+  }
+];
 browser.resetMAC3 = async function () {
   // for debugging and testing: remove all containers except the default 4 and the first one created
   browser.tests.stopSyncListeners();