Issue 6490 - Wrap browser.browserAction.set* with Promise

ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 86 matching lines @@
       }
     },
     sendMessage(message, responseCallback)
     {
       browser.tabs.sendMessage(this.id, message, responseCallback);
     }
   };
 
   ext.getPage = id => new Page({id: parseInt(id, 10)});
 
-  function afterTabLoaded(callback)
-  {
-    return openedTab =>
-    {
-      let onUpdated = (tabId, changeInfo, tab) =>
-      {
-        if (tabId == openedTab.id && changeInfo.status == "complete")
-        {
-          browser.tabs.onUpdated.removeListener(onUpdated);
-          callback(new Page(openedTab));
-        }
-      };
-      browser.tabs.onUpdated.addListener(onUpdated);
-    };
-  }
-
   ext.pages = {
     onLoading: new ext._EventTarget(),
     onActivated: new ext._EventTarget(),
     onRemoved: new ext._EventTarget()
   };
 
   browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) =>
   {
     if (changeInfo.status == "loading")
       ext.pages.onLoading._dispatch(new Page(tab));
@@ skipping 177 matching lines @@
   /* Browser actions */
 
   let BrowserAction = function(tabId)
   {
     this._tabId = tabId;
     this._changes = null;
   };
   BrowserAction.prototype = {
     _applyChanges()
     {
-      return Promise.all(Object.keys(this._changes).map((change) =>

[Sebastian Noack, 2018/06/13 01:35:33]

Nit: The parenthesis around the argument list is optional in arrow functions
with a single argument. Every where else we omit the parenthesis in this case.

[Jon Sonesen, 2018/06/13 23:05:07]

Oh yeah forgot about that, thanks

-      {
-        if (change == "iconPath")

[Sebastian Noack, 2018/06/13 01:35:33]

Unrelated, but since you are changing this code anyway, we can simplify the
Firefox for Android checks by combining them with the check here:

  if (change == "iconPath && "setIcon" in browser.browserAction)
    ...

Same for the other methods below.

[Jon Sonesen, 2018/06/13 23:05:07]

Acknowledged.

-        {
-          // Firefox for Android displays the browser action not as an icon but
-          // as a menu item. There is no icon, but such an option may be added in
-          // the future.
-          // https://bugzilla.mozilla.org/show_bug.cgi?id=1331746
-          if ("setIcon" in browser.browserAction)
+      return Promise.all(Object.keys(this._changes).map(change =>
+      {
+        // Firefox for Android displays the browser action not as an icon but
+        // as a menu item. There is no icon, but such an option may be added
+        // in the future.
+        // https://bugzilla.mozilla.org/show_bug.cgi?id=1331746
+        if (change == "iconPath" && "setIcon" in browser.browserAction)
+        {
+          let path = {
+            16: this._changes.iconPath.replace("$size", "16"),
+            19: this._changes.iconPath.replace("$size", "19"),
+            20: this._changes.iconPath.replace("$size", "20"),
+            32: this._changes.iconPath.replace("$size", "32"),
+            38: this._changes.iconPath.replace("$size", "38"),
+            40: this._changes.iconPath.replace("$size", "40")
+          };
+          try
           {
-            let path = {
-              16: this._changes.iconPath.replace("$size", "16"),
-              19: this._changes.iconPath.replace("$size", "19"),
-              20: this._changes.iconPath.replace("$size", "20"),
-              32: this._changes.iconPath.replace("$size", "32"),
-              38: this._changes.iconPath.replace("$size", "38"),
-              40: this._changes.iconPath.replace("$size", "40")
-            };
-            try

[Jon Sonesen, 2018/06/12 21:18:02]

Now that this is in polyfill.js I suspect this not longer works for edge, but do
not have a test VM at this exact moment.

-            {
-              return browser.browserAction.setIcon({tabId: this._tabId, path});
-            }
-            catch (e)
-            {
-              // Edge throws if passed icon sizes different than 19,20,38,40px.
-              delete path[16];
-              delete path[32];
-              return browser.browserAction.setIcon({tabId: this._tabId, path});
-            }
+            return browser.browserAction.setIcon({tabId: this._tabId, path});
+          }
+          catch (e)
+          {
+            // Edge throws if passed icon sizes different than 19,20,38,40px.
+            delete path[16];
+            delete path[32];
+            return browser.browserAction.setIcon({tabId: this._tabId, path});
           }
         }
 
-        if (change == "badgeText")
-        {
-          // There is no badge on Firefox for Android; the browser action is
-          // simply a menu item.
-          if ("setBadgeText" in browser.browserAction)
+        // There is no badge on Firefox for Android; the browser action is
+        // simply a menu item.
+        if (change == "badgeText" && "setBadgeText" in browser.browserAction)
+          return browser.browserAction.setBadgeText({
+            tabId: this._tabId,
+            text: this._changes.badgeText
+          });
+
+        // There is no badge on Firefox for Android; the browser action is
+        // simply a menu item.
+        if (change == "badgeColor" &&
+            "setBadgeBackgroundColor" in browser.browserAction)
+          return browser.browserAction.setBadgeBackgroundColor({
+            tabId: this._tabId,
+            color: this._changes.badgeColor
+          });
+      }));
+    },
+    _addChange(name, value)
+    {
+      let onReplaced = (addedTabId, removedTabId) =>

[Jon Sonesen, 2018/07/10 23:01:07]

Since I had trouble removing the check below this definition would still need to
be here.

+      {
+        if (addedTabId == this._tabId)
+        {
+          browser.tabs.onReplaced.removeListener(onReplaced);
+          this._applyChanges().then(() =>
           {
-            return browser.browserAction.setBadgeText({
-              tabId: this._tabId,
-              text: this._changes.badgeText
-            });
-          }
+            this._changes = null;
+          });
         }
-
-        if (change == "badgeColor")
-        {
-          // There is no badge on Firefox for Android; the browser action is
-          // simply a menu item.
-          if ("setBadgeBackgroundColor" in browser.browserAction)
-          {
-            return browser.browserAction.setBadgeBackgroundColor({
-              tabId: this._tabId,
-              color: this._changes.badgeColor
-            });
-          }
-        }
-
-        this._changes = null;

[Sebastian Noack, 2018/06/13 01:35:33]

It seems in case of failure (when we register the onReplaced handler to handle
prerendered tabs) the changes (still to be performed) will no longer be known.

[Jon Sonesen, 2018/06/13 23:05:07]

Acknowledged.

-      }));
-    },
-    _addChange(name, value)
-    {
+      };
       if (!this._changes)
-      {
         this._changes = {};
-      }
 
       this._changes[name] = value;
-      this._applyChanges().catch(() =>

[Sebastian Noack, 2018/06/13 01:35:33]

If this._changes is not null (and an onReplaced handler has already been
registered), we should not call _applyChanges() again but wait for the
onReplaced handler to take care of them.

[Jon Sonesen, 2018/06/13 23:06:40]

Acknowledged.

-      {
-        // If the tab is prerendered, browser.browserAction.set* fails
-        // and we have to delay our changes until the currently visible tab
-        // is replaced with the prerendered tab.
-        let onReplaced = (addedTabId, removedTabId) =>
-        {
-          if (addedTabId == this._tabId)
-          {
-            browser.tabs.onReplaced.removeListener(onReplaced);
-            this._applyChanges();
-          }
-        };
-        browser.tabs.onReplaced.addListener(onReplaced);
-      });
+      if (!browser.tabs.onReplaced.hasListener(onReplaced))

[Jon Sonesen, 2018/07/10 23:01:07]

Replacing this check with the applyChanges boolean does not seem to be a
reliable indication of whether a listener has been added or not. Removing the
hasListener check causes the badge color to stay blue.

+      {
+        this._applyChanges().then(() =>
+        {
+          this._changes = null;
+        }).catch(() =>

[Jon Sonesen, 2018/07/10 23:01:08]

I still think this is more readable than the callback-ish way. But am happy to
change.

+        {
+          // If the tab is prerendered, browser.browserAction.set* fails
+          // and we have to delay our changes until the currently visible tab
+          // is replaced with the prerendered tab.
+          browser.tabs.onReplaced.addListener(onReplaced);
+        });
+      }
     },
     setIcon(path)
     {
       this._addChange("iconPath", path);
     },
     setBadge(badge)
     {
       if (!badge)
       {
         this._addChange("badgeText", "");
@@ skipping 159 matching lines @@
           return frames.get(0) || null;
         }
       };
     }
 
     return ext.onMessage._dispatch(
       message, sender, sendResponse
     ).includes(true);
   });
 }