1337531 - UI Tour closes PanelUI upon tab switch from about:home

Status: RESOLVED FIXED

(Firefox :: Tours, defect)

Description

[Edouard Oger [:eoger]]

How to reproduce:

Prerequisites:
- Apply the patch in bug 1334430 comment 6
- The Sync tabs button must be placed in the hamburger menu (default behavior)

1. Navigate to about:home if necessary
2. Open the Hamburger menu -> Synced Tabs then open a synced tab by Ctrl-Clicking or using the middle click.

Current behavior: the hamburger menu closes itself.

Excepted behavior: the hamburger menu should stay open, because we use preventDefault and stopPropagation in that patch.

I get the expected behavior if the current tab is not about:home.

Why is this happening? I put a breakpoint in panelUI.js#hide and checked the stacktrace.
It looks like the menu is hidden by UITour.jsm#teardownTourForBrowser, although there is not tour going on.

Comment 1

[Matthew N. [:MattN]]

(In reply to Edouard Oger [:eoger] from comment #0)
> 2. Open the Hamburger menu -> Synced Tabs then open a synced tab by
> Ctrl-Clicking or using the middle click.

Do these actions open the tab in the foreground or background?

> Why is this happening? I put a breakpoint in panelUI.js#hide and checked the
> stacktrace.

I could have told you if you included the stack :P What is the caller of teardownTourForBrowser? UITour shouldn't be tearing down for about:home if about:home remains as the foreground tab.

> It looks like the menu is hidden by UITour.jsm#teardownTourForBrowser,
> although there is not tour going on.

about:home is probably still using UITour from snippets so from the UITour perspective a tour is going on.

Comment 2

[Edouard Oger [:eoger]]

Attachment: stacktrace.png

> Do these actions open the tab in the foreground or background?

In the foreground, using shift + ctrl click does not trigger the bug.

I attached the stacktrace.

Comment 3

[Matthew N. [:MattN]]

(In reply to Edouard Oger [:eoger] from comment #2)
> In the foreground, using shift + ctrl click does not trigger the bug.

Should users really expect the menu item to stay open upon switching tabs? I don't think there is prior art for that even ignoring UITour. For example, the panel closes when restoring a tab from the history subview.

To be honest I don't see a likely fix in UITour as it's working as expected for a tour. I think it may be worth understanding why about:home (likely snippets) is using UITour and getting it to stop using the API. This has caused problems for other parts of FxA as well.

Comment 4

[Edouard Oger [:eoger]]

Looks like bug 1349742 fixed the bug