Fixes 4218 - setIcon for older, fussy versions of Chrome

chrome/ext/background.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 158 matching lines @@
 
 
   /* Browser actions */
 
   var BrowserAction = function(tabId)
   {
     this._tabId = tabId;
     this._changes = null;
   };
   BrowserAction.prototype = {
+    _legacySetIcon: function(details)
+    {
+      var legacyDetails = {};
+      for (var key in details)
+      {
+        if (details.hasOwnProperty(key))

[Sebastian Noack, 2016/08/16 16:49:11]

Is this case worth to be considered? As far as I can tell we always pass a plain
object, and there is arguable no reason to pass any thing else, and in that case
each property we get here is an own property.

[kzar, 2016/08/16 16:59:17]

Done.

+        {
+          var value = details[key];
+          if (typeof value == "object")
+            value = {19: value[19], 38: value[38]};
+          legacyDetails[key] = value;
+        }
+      }
+      chrome.browserAction.setIcon(legacyDetails);
+    },
+    _safeSetIcon: function(details)
+    {
+      try
+      {
+        chrome.browserAction.setIcon(details);
+      }
+      catch (e)
+      {
+        // Older versions of Chrome do not allow any sizes other than 19 and 38
+        // to be present, but newer versions of Chrome (and Edge) prefer
+        // different sizes.
+        this._safeSetIcon = this._legacySetIcon;
+        this._legacySetIcon(details);
+      }
+    },
     _applyChanges: function()
     {
       if ("iconPath" in this._changes)
       {
-        chrome.browserAction.setIcon({
-          tabId: this._tabId,
-          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")
-          }
-        });
+        var details = {tabId: this._tabId, path: {}};

[Sebastian Noack, 2016/08/16 16:49:11]

This change here isn't even necessary, and while it avoids duplication, it makes
the code hardly any easier to understand. I think the original declarative
approach was nicer.

[kzar, 2016/08/16 16:59:17]

Done.

+        let sizes = [16, 19, 20, 32, 38, 40];
+        for (var size of sizes)
+          details.path[size] = this._changes.iconPath.replace("$size", size);
+        this._safeSetIcon(details);
       }
 
       if ("badgeText" in this._changes)
       {
         chrome.browserAction.setBadgeText({
           tabId: this._tabId,
           text: this._changes.badgeText
         });
       }
 
@@ skipping 391 matching lines @@
   ext.windows = {
     create: function(createData, callback)
     {
       chrome.windows.create(createData, function(createdWindow)
       {
         afterTabLoaded(callback)(createdWindow.tabs[0]);
       });
     }
   };
 })();