Refactoring of index.js

index.js

@@ -8,8 +8,14 @@ const tabs = require('sdk/tabs');
 const webExtension = require('sdk/webextension');
 const { viewFor } = require("sdk/view/core");
 
-/* Let's start enabling Containers */
+let ContainerService =
-var prefs = [
+{
+  _identitiesState: {},
+
+  init() {
+    // Enabling preferences
+
+    let prefs = [
       [ "privacy.userContext.enabled", true ],
       [ "privacy.userContext.ui.enabled", true ],
       [ "privacy.usercontext.about_newtab_segregation.enabled", true ],
@@ -21,87 +27,50 @@ prefs.forEach((pref) => {
       prefService.set(pref[0], pref[1]);
     });
 
-const identitiesState = {
+    // Message routing
-};
 
-function convert(identity) {
+    // only these methods are allowed. We have a 1:1 mapping between messages
+    // and methods. These methods must return a promise.
+    let methods = [
+      'queryTabs',
+      'hideTabs',
+      'showTabs',
+      'removeTabs',
+      'openTab',
+      'queryIdentities',
+      'getIdentitiesState',
+    ];
+
+    webExtension.startup().then(api => {
+      api.browser.runtime.onMessage.addListener((message, sender, sendReply) => {
+        if ("method" in message && methods.indexOf(message.method) != -1) {
+          sendReply(this[message.method](message));
+        }
+      });
+    });
+  },
+
+  // utility methods
+
+  _convert(identity) {
     let hiddenTabUrls = [];
 
-  if (identity.userContextId in identitiesState) {
+    if (identity.userContextId in this._identitiesState) {
-    hiddenTabUrls = identitiesState[identity.userContextId].hiddenTabUrls;
+      hiddenTabUrls = this._identitiesState[identity.userContextId].hiddenTabUrls;
     }
-  const result = {
+
+    return {
       name: ContextualIdentityService.getUserContextLabel(identity.userContextId),
       icon: identity.icon,
       color: identity.color,
       userContextId: identity.userContextId,
       hiddenTabUrls: hiddenTabUrls
     };
+  },
 
-  return result;
+  // Tabs management
-}
 
-function queryContainers(details) {
+  queryTabs(args) {
-  const identities = [];
-
-  ContextualIdentityService.getIdentities().forEach(identity=> {
-    if (details && details.name &&
-        ContextualIdentityService.getUserContextLabel(identity.userContextId) !== details.name) {
-      return;
-    }
-
-    const convertedIdentity = convert(identity);
-
-    identities.push(convertedIdentity);
-    if (!(convertedIdentity.userContextId in identitiesState)) {
-      identitiesState[convertedIdentity.userContextId] = {hiddenTabUrls: []};
-    }
-  });
-
-  return Promise.resolve(identities);
-}
-
-function removeContainer(userContextId) {
-  if (!userContextId) {
-    return Promise.resolve(null);
-  }
-
-  const identity = ContextualIdentityService.getIdentityFromId(userContextId);
-
-  if (!identity) {
-    return Promise.resolve(null);
-  }
-
-  // We have to create the identity object before removing it.
-  const convertedIdentity = convert(identity);
-
-  if (!ContextualIdentityService.remove(identity.userContextId)) {
-    return Promise.resolve(null);
-  }
-
-  return Promise.resolve(convertedIdentity);
-}
-
-function openTab(args) {
-  let browserWin = Services.wm.getMostRecentWindow('navigator:browser');
-
-  // This should not really happen.
-  if (!browserWin || !browserWin.gBrowser) {
-    return Promise.resolve(false);
-  }
-
-  let userContextId = 0;
-  if ('userContextId' in args) {
-    userContextId = args.userContextId;
-  }
-
-  let tab = browserWin.gBrowser.addTab(args.url || null,
-                                       { userContextId: userContextId })
-  browserWin.gBrowser.selectedTab = tab;
-  return Promise.resolve(true);
-}
-
-function queryTabs(args) {
     return new Promise((resolve, reject) => {
       let tabList = [];
 
@@ -122,48 +91,74 @@ function queryTabs(args) {
 
       resolve(tabList);
     });
-}
+  },
 
-function removeTabs(ids) {
+  hideTabs(args) {
+    this._identitiesState[args.userContextId].hiddenTabUrls = args.tabUrlsToSave;
+    return Promise.resolve(null);
+  },
+
+  showTabs(args) {
+    return new Promise((resolve, reject) => {
+      let hiddenTabUrls = this._identitiesState[args.userContextId].hiddenTabUrls;
+      this._identitiesState[args.userContextId].hiddenTabUrls = [];
+      resolve(hiddenTabUrls);
+    });
+  },
+
+  removeTabs(args) {
+    return new Promise((resolve, reject) => {
       for (let tab of tabs) {
-    if (ids.indexOf(tab.id) != -1) {
+        if (args.tabIds.indexOf(tab.id) != -1) {
           tab.close();
         }
       }
-
+      resolve(null);
-  return Promise.resolve(null);
-}
-
-function handleWebExtensionMessage(message, sender, sendReply) {
-  switch (message.method) {
-      case 'queryIdentities':
-        sendReply(queryContainers(message.arguments));
-        break;
-      case 'queryTabs':
-        sendReply(queryTabs(message));
-        break;
-      case 'hideTabs':
-        identitiesState[message.userContextId].hiddenTabUrls = message.tabUrlsToSave;
-        break;
-      case 'showTabs':
-        sendReply(identitiesState[message.userContextId].hiddenTabUrls);
-        identitiesState[message.userContextId].hiddenTabUrls = [];
-        break;
-      case 'removeTabs':
-        sendReply(removeTabs(message.tabIds));
-        identitiesState[message.userContextId].hiddenTabUrls = [];
-        break;
-      case 'getIdentitiesState':
-        sendReply(identitiesState);
-        break;
-      case 'openTab':
-        sendReply(openTab(message));
-        break;
-  }
-}
-
-webExtension.startup().then(api=> {
-  const {browser} = api;
-
-  browser.runtime.onMessage.addListener(handleWebExtensionMessage);
     });
+  },
+
+  openTab(args) {
+    return new Promise((resolve, reject) => {
+      let browserWin = Services.wm.getMostRecentWindow('navigator:browser');
+
+      // This should not really happen.
+      if (!browserWin || !browserWin.gBrowser) {
+        return Promise.resolve(false);
+      }
+
+      let userContextId = 0;
+      if ('userContextId' in args) {
+        userContextId = args.userContextId;
+      }
+
+      let tab = browserWin.gBrowser.addTab(args.url || null,
+                                           { userContextId: userContextId })
+      browserWin.gBrowser.selectedTab = tab;
+      resolve(true);
+    });
+  },
+
+  // Identities management
+
+  queryIdentities(args) {
+    return new Promise((resolve, reject) => {
+      let identities = [];
+
+      ContextualIdentityService.getIdentities().forEach(identity => {
+        let convertedIdentity = this._convert(identity);
+        identities.push(convertedIdentity);
+        if (!(convertedIdentity.userContextId in this._identitiesState)) {
+          this._identitiesState[convertedIdentity.userContextId] = {hiddenTabUrls: []};
+        }
+      });
+
+      resolve(identities);
+    });
+  },
+
+  getIdentitiesState(args) {
+    return Promise.resolve(this._identitiesState);
+  },
+};
+
+ContainerService.init();

webextension/js/popup.js

@@ -20,10 +20,11 @@ function hideContainerTabs(userContextId) {
       userContextId: userContextId,
       tabUrlsToSave: tabUrlsToSave
     }).then(()=> {
-      browser.runtime.sendMessage({
+      return browser.runtime.sendMessage({
         method: 'removeTabs',
         tabIds: tabIdsToRemove
       });
+    }).then(() => {
       hideorshowIcon.src = CONTAINER_UNHIDE_SRC;
     });
   });
@@ -43,8 +44,9 @@ function showContainerTabs(userContextId) {
         url: url
       });
     });
-  });
+  }).then(() => {
     hideorshowIcon.src = CONTAINER_HIDE_SRC;
+  });
 }
 
 if (localStorage.getItem('onboarded2')) {
@@ -128,8 +130,12 @@ browser.runtime.sendMessage({method: 'queryIdentities'}).then(identities=> {
           }
         });
       } else if (e.target.matches('.newtab-icon')) {
-        browser.runtime.sendMessage({method: 'openTab', userContextId: userContextId});
+        browser.runtime.sendMessage({
+          method: 'openTab',
+          userContextId: userContextId})
+        .then(() => {
           window.close();
+        });
       }
     });
   });
@@ -154,7 +160,9 @@ function moveTabs(sortedTabsArray) {
 }
 
 document.querySelector('#sort-containers-link').addEventListener('click', ()=> {
-  browser.runtime.sendMessage({method: 'queryIdentities'}).then(identities=> {
+  browser.runtime.sendMessage({
+    method: 'queryIdentities'
+  }).then(identities=> {
     identities.unshift({userContextId: 0});
 
     browser.runtime.sendMessage({method: 'queryTabs'}).then(tabsArray=> {