1287158 - Previewing or Installing Light Weight Themes Closes Navigation Toolbar Menu and Popups Automatically

Status: UNCONFIRMED

(Core :: General, defect)

Description

[Baris Derin]

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9; rv:47.0) Gecko/20100101 Firefox/47.0
Build ID: 20160623154057

Steps to reproduce:

1.Install the Personas Plus: https://addons.mozilla.org/en-US/firefox/addon/personas-plus/
2. Go to about:addons and remove “Groovy Blue” theme.
3. Go to Personas Plus icon and hover over themes in “Featured”

Github issue for more details:
https://github.com/mozilla/personas-plus/issues/42


Actual results:

 The list closes after hovering over the themes.


Expected results:

 The list with themes is displayed without any issues.

Comment 1

[Baris Derin]

It is because of the line:

https://dxr.mozilla.org/mozilla-esr45/source/toolkit/modules/LightweightThemeConsumer.jsm#126

    `root.setAttribute("lwtheme", "true");`

Setting lwtheme attribute to true for `window.document.documentElement` closes any open popup and menus automatically.

Comment 2

[Baris Derin]

This issue is not specific to Personas Plus toolbar button menu. Most of the Navigation Toolbar popups and menus get closed when root.setAttribute("lwtheme", "true");

To test other popups, e.g. Pocket menu, run below code in Scratchpad, open Pocket popup, wait 5 seconds and it gets closed automatically when setTimeout runs.

    var win=Components.classes['@mozilla.org/appshell/window-mediator;1'].getService(Components.interfaces.nsIWindowMediator).getMostRecentWindow("navigator:browser")
    win.setTimeout(function(){

         var root = win.document.documentElement;
         root.setAttribute("lwtheme", "true");

    },5000)

Comment 3

[julesmyers2011]

Unable to reproduce bug on OSX Yosemite 10.10.2 using nightly build 50.0a1 (2016-7-18).

These are the steps I took:
(1) installed the add-on
(2) went to about:addons/appearance/ and deleted "Groovy Blue" theme.
(3) Clicked on the persona plus icon/featured/and hovered over several themes anywhere from 5 seconds to 30 seconds and the list stayed open and showed the theme loaded in the background.
(4) I added a different theme/deleted that theme/ and repeated step (3). The list stayed open and showed the theme loaded in the background.

Comment 4

[Andreas Wagner [:TheOne] [use NI]]

I couldn't reproduce that on Mac, but I can on Windows 7.

Comment 5

[ovidiu boca[:Ovidiu]]

I have tested this on Mac OS X 10.10 and Windows 7 with FF Nightly. I tested this using new profile. 
You can try to see if you can reproduce it with new profile, you have the steps here:https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles?redirectlocale=en-US&redirectslug=Managing-profiles#w_starting-the-profile-manager

Comment 6

[Baris Derin]

Detailed report here, https://github.com/mozilla/personas-plus/issues/39 , please check the screencast.

I can still produce this on Mac. Strangely I noticed this bug on Windows but now I can not produce it on Windows. It happens sporadic, not sure why.

The best way to test is the below code. Run below code in Scratchpad, open Pocket popup quickly (you must open up the panel in 5 seconds), wait 5 seconds and it gets closed automatically when setTimeout runs.

    var win = Components.classes['@mozilla.org/appshell/window-mediator;1'].getService(Components.interfaces.nsIWindowMediator).getMostRecentWindow("navigator:browser")
    win.setTimeout(function(){

         var root = win.document.documentElement;
         root.setAttribute("lwtheme", "true");

    },5000)

The issue is:
root.setAttribute("lwtheme", "true");

closes all popups so even if you can not reproduce the issue for Personas Plus by the attached STR, you can produce it by above code.

Comment 7

[Baris Derin]

Sorry related github issue is https://github.com/mozilla/personas-plus/issues/42

Comment 8

[Andy McKay]

I don't think this is an add-ons manager bug but with the APIs the add-on uses?

Comment 9

[:Gijs (he/him)]

Dão, is this just a widget or toolkit issue? Doesn't seem like it's anything in our theme code...

Comment 10

[Dão Gottwald [:dao]]

I have no idea, but I don't see how this could be a theme bug.

Comment 11

[Markus Stange [:mstange]]

The theme might be changing CSS properties that cause frame reconstruction, and if you destroy + recreate a popup frame then it will close.
To know for sure, somebody will need to set a breakpoint on nsWindow::Show when this happens and look at the callstack.

Comment 12

[Baris Derin]

Workflow

In the case Default Theme is active and when hovered over Featured menu item, this workflow is executed

DOMMenuItemActive
https://github.com/mozilla/personas-plus/blob/1b395cee5aee9f02a6edc3740a22b66fb6dafae1/extension/content/personas.js#L1113

onPreviewPersona
https://github.com/mozilla/personas-plus/blob/1b395cee5aee9f02a6edc3740a22b66fb6dafae1/extension/content/personas.js#L710

_previewPersona
https://github.com/mozilla/personas-plus/blob/1b395cee5aee9f02a6edc3740a22b66fb6dafae1/extension/content/personas.js#L749

previewPersona
https://github.com/mozilla/personas-plus/blob/1b395cee5aee9f02a6edc3740a22b66fb6dafae1/extension/modules/service.js#L1017

_notifyWindows(aData);
https://dxr.mozilla.org/mozilla-central/source/toolkit/mozapps/extensions/LightweightThemeManager.jsm#222

lightweight-theme-styling-update
https://dxr.mozilla.org/mozilla-central/source/toolkit/mozapps/extensions/LightweightThemeManager.jsm#798

lightweight-theme-styling-update observer
https://dxr.mozilla.org/mozilla-esr45/source/toolkit/modules/LightweightThemeConsumer.jsm#72

root.setAttribute("lwtheme", "true");
https://dxr.mozilla.org/mozilla-esr45/source/toolkit/modules/LightweightThemeConsumer.jsm#126

Comment 13

[Baris Derin]

Before popup closed "lwtheme" attribute is modified by LightweightThemeConsumer.jsm

https://dxr.mozilla.org/mozilla-esr45/source/toolkit/modules/LightweightThemeConsumer.jsm#126

Then as Markus noted, some observer is probably called which is listening "lwtheme" attribute change and navigation toolbox is redrawn.

Comment 14

[:Gijs (he/him)]

(In reply to Baris Derin from comment #6)
> Detailed report here, https://github.com/mozilla/personas-plus/issues/39 ,
> please check the screencast.
> 
> I can still produce this on Mac. Strangely I noticed this bug on Windows but
> now I can not produce it on Windows. It happens sporadic, not sure why.
> 
> The best way to test is the below code. <snip>

Baris, does this reproduce if you don't install the personas plus extension? Does it happen if you repeat the code (keep setting the attribute) ? Or only when the default theme is selected and you hover over lightweight themes?

(In reply to Markus Stange [:mstange] from comment #11)
> The theme might be changing CSS properties that cause frame reconstruction,
> and if you destroy + recreate a popup frame then it will close.

This seems likely, but how would we narrow down what CSS property does this? And what could we do to avoid this besides "don't change that css property" ?

Comment 15

[Markus Stange [:mstange]]

One would need to start with what I suggested in comment 11: Set a breakpoint on nsWindow::Show(false) and go from there. My hypothesis about frame reconstruction might not even be correct. Once we know the reason why the panel closes, we can start thinking about remedies.

Comment 16

[Baris Derin]

Screencast = https://cloud.githubusercontent.com/assets/15885467/16873902/c27d3ca8-4a9e-11e6-97d2-00e9d655b24a.gif

When "Default", there is not light weight theme installed and there is no "lwtheme" attribute on global "Window" node. If you open up Personas Plus menu and hover over a Light Weight Theme menuitem, "preview" action is called. While previewing, Personas Plus menu is still in "open" state. Previewing sets "lwtheme" attribute on Window node by below line:
https://dxr.mozilla.org/mozilla-esr45/source/toolkit/modules/LightweightThemeConsumer.jsm#126

Then because "lwtheme" is "added" on window node, Firefox "navigation toolbox" is modified and Personas Plus menu gets closed as probably redrawn or frame reconstruction.

The other case:

If there is already a light weight theme is installed before opening Personas Plus menu, Window node already has "lwtheme" attribute. If you open up Personas Plus menu and hover over a Light Weight Theme menuitem, "preview" action is called. Because "lwtheme" attribute is already there, Preview action does not add "lwtheme" attribute so state does not change and Personas Plus menu does not get closed.

The problem is adding or removing "lwtheme" attribute to the Window root node while the Personas Plus menu is open, as this line states:
https://dxr.mozilla.org/mozilla-esr45/source/toolkit/modules/LightweightThemeConsumer.jsm#126

"lwtheme" attribute changes state and Personas Plus menu get affected.

Comment 17

[:Gijs (he/him)]

I can't reproduce this on either Windows (tested with Windows 10) or Mac, not with the personas plus menu nor with the test from comment #16 using the pocket panel, so I don't know how to investigate this further.