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 151 matching lines @@
 
   chrome.tabs.onRemoved.addListener(forgetTab);
 
   chrome.tabs.onActivated.addListener(function(details)
   {
     ext.pages.onActivated._dispatch(new Page({id: details.tabId}));
   });
 
 
   /* Browser actions */
-  var supportedIconSizes = ["19", "38", "16", "32", "20", "40"];

[Sebastian Noack, 2016/08/15 21:22:16]

Nit: Preserve the blank line.

[kzar, 2016/08/16 08:33:40]

Done.

 
   var BrowserAction = function(tabId)
   {
     this._tabId = tabId;
     this._changes = null;
   };
   BrowserAction.prototype = {
+    _legacySetIcon: function(details)
+    {
+      var legacyDetails = {};
+      for (var key in details)
+      {
+        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()
     {
-      var iconDetails = function()

[Sebastian Noack, 2016/08/15 21:22:16]

For consistency with the surrounding code, make it an auxiliary method rather
than an anonymous function.

[kzar, 2016/08/16 08:33:40]

Done.

-      {
-        var details = {tabId: this._tabId, path: {}};
-        for (var size of supportedIconSizes)
-          details.path[size] = this._changes.iconPath.replace("$size", size);
-        return details;
-      }.bind(this);
-
       if ("iconPath" in this._changes)
       {
-        try
-        {
-          chrome.browserAction.setIcon(iconDetails());
-        }
-        catch (e)
-        {
-          if (supportedIconSizes.length == 2)
-            throw(e);

[Sebastian Noack, 2016/08/15 22:13:05]

This branch is redundant. It's not that we would enter a recursive condition
otherwise.

[kzar, 2016/08/16 08:33:40]

Oh yea, it would just be called twice but who cares.

-
-          // Edge and newer versions of Chrome prefer different icon sizes, but
-          // older versions of Chrome cannot handle them being present!
-          supportedIconSizes.splice(2);
-          chrome.browserAction.setIcon(iconDetails());
-        }
+        this._safeSetIcon({
+          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")
+          }
+        });
       }
 
       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]);
       });
     }
   };
 })();