1721585 - The tooltip for the Reader mode icon in the url bar sometimes displays "undefined"

Status: VERIFIED FIXED

(Toolkit :: Reader Mode, defect, P1)

Description

[Pascal Chevrel:pascalc]

Attachment: screenshot of the bug

Mozilla/5.0 (X11; Linux x86_64; rv:92.0) Gecko/20100101 Firefox/92.0 ID:20210720215601

STR:
1/ put your pointer on the reader mode icon in the url bar, repeat it several times

ER:
A tooltip with an explanation of what the icon is for is displayed

AR:
Once in a while, instead of the description, the value "undefined" is displayed instead

See attached screenshot.

Ubuntu 21.04, French build.

Comment 1

[BugBot [:suhaib / :marco/ :calixte]]

The Bugbug bot thinks this bug should belong to the 'Toolkit::Reader Mode' component, and is moving the bug to that component. Please revert this change in case you think the bot is wrong.

Comment 2

[Alice0775 White]

I can also reproduce the issue on Nightly92.0a1 Windows10.

Regression window:
https://hg.mozilla.org/integration/autoland/pushloghtml?fromchange=84b2f87384d5778fcd01fee192b91b156351a088&tochange=8b7dd99cdee2efb5c8a498a07a6c8d466395fd0d

Comment 3

[BugBot [:suhaib / :marco/ :calixte]]

Set release status flags based on info from the regressing bug 1706479

Comment 4

[Jared Wein [:jaws] (please needinfo? me)]

Requesting needinfo as this was marked as regressed by bug 1706479.

Comment 5

[Harry Twyford]

I can't seem to reproduce the issue. It's interesting that this is intermittent. I fixed a similar issue that was permanent in bug 1712569.

[Tracking Requested - why for this release]:
Minor UI regression. Requesting tracking so I don't forget to fix it :)

Comment 6

[Harry Twyford]

Attachment: Bug 1721585 - Show tooltip for both reader-mode-button and reader-mode-button-icon. r?jaws!

The bug was that the tooltip was only being shown for reader-mode-button-icon. The tooltip would show if you hovered right over the icon, and it would be undefined otherwise. This patch shows the tooltip regardless of the hover target. The other items on nodeToTooltipMap and nodeToShortcutMap are toolbarbuttons, so their icons are added in CSS and event handling always sees the parent node as the hover target. The reader mode button icon, however, is an <image> child of its parent. Either it or its parent could be hover targets. I considered added some handling in GetDynamicShortcutTooltipText along the lines of checking hg up centralnode.closest(reader-mode-button). I settled on just adding more entries to nodeToTooltipMap and nodeToShortcutMap since it's safer and easier to uplift.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1ad36c1999df
Show tooltip for both reader-mode-button and reader-mode-button-icon. r=jaws

Comment 8

[Iulian Moraru]

https://hg.mozilla.org/mozilla-central/rev/1ad36c1999df

Comment 9

[Ryan VanderMeulen [:RyanVM]]

Please nominate this for Beta approval when you get a chance.

Comment 10

[Harry Twyford]

Comment on attachment 9235417 [details]
Bug 1721585 - Show tooltip for both reader-mode-button and reader-mode-button-icon. r?jaws!

Beta/Release Uplift Approval Request

• User impact if declined: Minor UI regression where a tooltip will read "undefined".
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Well-understood, and the fix is very narrowly scoped.
• String changes made/needed:

Comment 11

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9235417 [details]
Bug 1721585 - Show tooltip for both reader-mode-button and reader-mode-button-icon. r?jaws!

Approved for 92.0b3 and 91.1esr.

Comment 12

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/593c608d2d1e

Comment 13

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-esr91/rev/cdf0b19f2bbe

Comment 14

[Hani Yacoub, Desktop QA]

Verified as fixed on Windows 10 x64, macOS 11.4 and on Ubuntu 20.04.