1903087 - SelectTranslationsPanel cached docLangTag is not correctly updated between panel opens

Status: VERIFIED FIXED

(Firefox :: Translations, defect, P2)

Description

[Erik Nordin [:nordzilla]]

Description

In Bug 1899354 I attempted to fix an issue with the languageInfo cache not updating correctly between page loads, however I fixed only half the problem.

While investigating Bug 1903044 it became clear that the cache will need to be invalidated between each panel open, otherwise the incorrect document language tag will be reported to telemetry.

---

Steps to reproduce

• Ensure that toolkit.telemetry.translations.logLevel is set to Debug.
• Open the Browser Console and filter on TranslationsTelemetry.
• Open a page in a new tab, e.g. https://fr.wikipedia.org.
• Open a page in a different language in another tab, e.g. https://es.wikipedia.org.
• Select text and open the SelectTranslationsPanel on the Spanish page.
• Switch to the French-page tab.
• Select text and open the SelectTranslationsPanel on the French page.

Expected Behavior

The docLangTag attribute for the onOpen event and onTranslate event shows fr for the French-page telemetry submission.

Actual Behavior

The docLangTag attribute for the onOpen event and onTranslate event shows es for the French-page telemetry submission, reading old the value from the cache.

---

Steps to implement

• Ensure that the languageInfo cache is invalidated with each open of the panel.

---

Tests to implement

• Write a telemetry test that ensures the correct document language tag is reported with multiple tabs open.

Comment 1

[Erik Nordin [:nordzilla]]

Attachment: Bug 1903087 - Refresh languageInfo cache on every panel open r=#translations-reviewers!

Ensures that the SelectTranslationsPanel languageInfo cache
is refreshed every time the panel would be opened. This prevents
a case where the incorrect (previous) document language tag
is reported to telemetry in some cases.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f96ac3918096
Refresh languageInfo cache on every panel open r=translations-reviewers,gregtatum

Comment 3

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/f96ac3918096

Comment 4

[Erik Nordin [:nordzilla]]

Attachment: Bug 1903087 - Refresh languageInfo cache on every panel open

Ensures that the SelectTranslationsPanel languageInfo cache
is refreshed every time the panel would be opened. This prevents
a case where the incorrect (previous) document language tag
is reported to telemetry in some cases.

Original Revision: https://phabricator.services.mozilla.com/D214011

Comment 5

[Phabricator Automation]

beta Uplift Approval Request

• User impact if declined: The Select Translations Panel will occasionally report the incorrect detected document language tag to telemetry
• Code covered by automated testing: yes
• Fix verified in Nightly: yes
• Needs manual QE test: yes
• Steps to reproduce for manual QE testing: STR are included in the bug description.
• Risk associated with taking this patch: Very low
• Explanation of risk level: This patch affects only the Select Translations Panel and is well covered by pre-existing and new automated tests
• String changes made/needed: None
• Is Android affected?: no

Comment 6

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/2c7e8aa0e34b

Comment 7

[Daniel Bodea [:danibodea]]

I can reproduce this issue in Nightly v129.0a1 from 2024-06-17 and verify the fix in Nightly v129.0a1 from 2024-06-20 and Beta v128.0b5. The docLangTag shows the expected language when using the steps in comment 0. Tested in Windows10, MacOS11 and Ubuntu22. Thanks!