1422481 - Browser action icon for WebExtension is missing when moved to overflow menu

Status: RESOLVED INVALID

(WebExtensions :: Frontend, defect, P2)

Description

[Alex Eng]

Attachment: WebExtension browser action - overflow menu icon missing.png

User Agent: Mozilla/5.0 (Windows NT 6.1; rv:58.0) Gecko/20100101 Firefox/58.0
Build ID: 20171115114231

Steps to reproduce:

My WebExtension, Panic Button, allows users to customize the browser action icon by choosing one of several available icons (SVG image files) that are packaged with the add-on.  The add-on invokes browser.browserAction.setIcon() to set the custom icon.  But this doesn't apply the user's custom icon selection if the browser action button is moved to the overflow ("More Tools") menu.

Steps to Reproduce:
1. Install the Panic Button add-on; current version is 4.0: https://addons.mozilla.org/en-US/firefox/addon/panic-button (requires Firefox 57 or newer)
2. Open the add-on preferences page from Add-ons Manager
3. Select an icon other than the default icon (orange ball with exclamation)
4. Right-click on the Panic Button toolbar button and choose "Pin to Overflow Menu"




Actual results:

The Panic Button browser action button is moved to the overflow menu, but is missing the custom icon.


Expected results:

The custom icon should appear with the Panic Button browser action on the overflow menu.

Comment 1

[Alex Eng]

The following code in the WebExtension is used to set the browser action icon:

function setToolbarButtonIcon(aIconIndex, isReverseContrast)
{
  // ...

  let toolbarBtnIconName = gToolbarBtnIcons[aIconIndex];
  let revContr = isReverseContrast ? "_reverse" : "";

  browser.browserAction.setIcon({
    path: {
      16: `img/${toolbarBtnIconName}16${revContr}.svg`,
      32: `img/${toolbarBtnIconName}32${revContr}.svg`
    }
  }).catch(onError);
}

There were no errors in the browser console when the browser action button was moved to the overflow menu.

I've tried wrapping the image paths inside browser.runtime.getURL(), but that did not have any effect.

Comment 2

[Andy McKay]

I can' reproduce this in the latest nightly on OS X. Is this a Windows specific bug?

Comment 3

[Alex Eng]

This issue isn't happening anymore. Turns out it was an issue with my WebExtension referencing a non-existent image file in my add-on.