1911896 - Translations Panel menulists do not react to Remote Settings sync until browser restart

Status: RESOLVED FIXED

(Firefox :: Translations, defect)

Description

[Erik Nordin [:nordzilla]]

Description

Note: I believe that this affects every Firefox version with the Translations feature enabled, however I reworked the panel cache logic in Bug 1870327 and still did not fix this issue. This is sufficiently far back that I feel fine considering this the regressor since we are unlikely to fix this issue in all but the most recent Firefox versions.

The Translations panels (both Select and Full Page) cache the initialized state of their dropdown menu lists the first time that they open. However, they do not appropriately react to the list of available languages changing, for example when publishing a new language model to Remote Settings, or when changing the Remote Settings channel from Prod to Dev, for example, which may have different language models available.

We should properly observe these events, and repopulate the panels' menu lists as necessary.

---

Steps to reproduce

• Download the Remote Settings Devtools extension.
• Open the FullPageTranslationsPanel or the SelectTranslationsPanel.
• Switch the Remote Settings channel from Prod to Dev, clear and sync.
• Reopen the panels and inspect the language lists.

Expected Behavior
The Dev channel has fewer language models released than the Prod channel, so the menulists should have fewer languages (only the ones that are available).

Actual Behavior
The menulists have the same languages that they had when Remote Settings was set to Prod, and some of the languages will not work, e.g. Vietnamese which is only in Prod, but not Dev at the time of writing.

---

Steps to implement

• Ensure that the Translations panels caches are refreshed if the available language models change.

---

Tests to implement

• Test pushing live changes to the Remote Settings test databases, ensuring that the panels react accordingly.

Comment 1

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Rename TranslationsPanelShared.clearCache r=#translations-reviewers!

Renames the TranslationsPanelShared.clearCache function to
clearLanguageListsCache to be more specific about what it does.

Depends on D218679

Comment 2

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Repopulate menulists when available lanaguges change r=#translations-reviewers!

Ensures that all FullPageTranslationsPanel and SelectTranslationsPanel
instances will repopulate their dropdown menulist elements if the
list of available languages changes, e.g. due to a Remote Settings sync.

Depends on D218680

Comment 3

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

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

Comment 4

[Erik Nordin [:nordzilla]]

Note: Release Managers

This patch stack consists of 3 core correctness fixes for Translations:

• Bug 1911890
• Bug 1911896
• Bug 1911897

Once landed, I intend to request uplift for this stack into the following channels:

• Firefox 128 ESR
• Firefox 129 Planned Dot Release
• Firefox 130 Beta

These changes are all fully tested in automation.

I believe these changes match the criteria for ESR uplift, and given that that is the version prior to the current release, it would be nice to have these fixes in all consecutive Firefox versions after that as well.

Comment 5

[Donal Meehan [:dmeehan]]

:nordzilla the planned 129 dot release builds on Monday 2024-08-19. The uplift deadline is the Friday before.
If you wanted to land this and add uplift requests before then? Otherwise it won't make the 129 dot release

Comment 6

[Erik Nordin [:nordzilla]]

Hey Donal, I appreciate the ping.

I wrote the above comment while I was still implementing these fixes, but ran into some unexpected test failures in CI.

I'm happy to say I finally believe I've resolved everything, and I just queued this stack for landing about an hour ago.

I'll be sure to request uplifts before Friday.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/5e37caaa52b4
Rename TranslationsPanelShared.clearCache r=translations-reviewers,gregtatum
https://hg.mozilla.org/integration/autoland/rev/0b70fbf8b4d9
Repopulate menulists when available lanaguges change r=translations-reviewers,gregtatum

Comment 8

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/5e37caaa52b4
https://hg.mozilla.org/mozilla-central/rev/0b70fbf8b4d9

Comment 9

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

The patch landed in nightly and beta is affected.
:nordzilla, is this bug important enough to require an uplift?

• If yes, please nominate the patch for beta approval.
• If no, please set status-firefox130 to wontfix.

For more information, please visit BugBot documentation.

Comment 10

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Rename TranslationsPanelShared.clearCache

Renames the TranslationsPanelShared.clearCache function to
clearLanguageListsCache to be more specific about what it does.

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

Comment 11

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Repopulate menulists when available lanaguges change

Ensures that all FullPageTranslationsPanel and SelectTranslationsPanel
instances will repopulate their dropdown menulist elements if the
list of available languages changes, e.g. due to a Remote Settings sync.

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

Comment 12

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Rename TranslationsPanelShared.clearCache

Renames the TranslationsPanelShared.clearCache function to
clearLanguageListsCache to be more specific about what it does.

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

Comment 13

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Repopulate menulists when available lanaguges change

Ensures that all FullPageTranslationsPanel and SelectTranslationsPanel
instances will repopulate their dropdown menulist elements if the
list of available languages changes, e.g. due to a Remote Settings sync.

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

Comment 14

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/1749200cc68a
https://hg.mozilla.org/releases/mozilla-beta/rev/ab05836adc9e

Comment 15

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Rename TranslationsPanelShared.clearCache

Renames the TranslationsPanelShared.clearCache function to
clearLanguageListsCache to be more specific about what it does.

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

Comment 16

[Erik Nordin [:nordzilla]]

Attachment: Bug 1911896 - Repopulate menulists when available lanaguges change

Ensures that all FullPageTranslationsPanel and SelectTranslationsPanel
instances will repopulate their dropdown menulist elements if the
list of available languages changes, e.g. due to a Remote Settings sync.

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

Comment 17

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-release/rev/18fa16c43590
https://hg.mozilla.org/releases/mozilla-release/rev/aaae1cb41574

Comment 18

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-esr128/rev/591764d2630c
https://hg.mozilla.org/releases/mozilla-esr128/rev/8c1d8e123c0c