1410736 - Remove remaining uses of `general.useragent.locale`

Status: RESOLVED FIXED

(Core :: Internationalization, enhancement, P3)

Description

[Zibi Braniecki [:zbraniecki][:gandalf]]

We migrated almost all calls for "requested locale" to use LocaleService.

There are some leftover in the tests and one leftover in the code:
 - toolkit/components/search/nsSearchService.js

It's slightly tricky because it tests for if the value has been manually modified, which we do not provide as part of LocaleService API.

Anyhoo, we'll have to deal with it and liberate ourselves from `general.useragent.locale` once and for all :)

Comment 1

[Zibi Braniecki [:zbraniecki][:gandalf]]

Jorg - no rush with that, but flagging you to put it on your radar. It should be always possible for you to use LocaleService setRequestedLocales/getRequestedLocales.

Comment 2

[Jorg K (CEST = GMT+2)]

I filed bug 1410738 assuming that you're referring to the preference general.useragent.locale.

We have a few uses:
https://dxr.mozilla.org/comm-central/search?q=general.useragent.locale&redirect=true

These lines (four in TB/IB and one in SM)
  pref("general.useragent.locale", "@AB_CD@");
will just be removed since we won't be setting the preference any more, right?

Comment 3

[Zibi Braniecki [:zbraniecki][:gandalf]]

> These lines (four in TB/IB and one in SM)
>  pref("general.useragent.locale", "@AB_CD@");
> will just be removed since we won't be setting the preference any more, right?

This is up in the air right now. We probably will start setting it at startup to multilocale.json once bug 1362617 lands. No rush with those. For now it's all about getting runtime code call the right API :)

Thank you!

Comment 4

[Axel Hecht [:Pike]]

The user-pref will need to stay for explicit UI language selection, I think.

Comment 5

[Zibi Braniecki [:zbraniecki][:gandalf]]

That's a good point.

The pref supports a single value, while we want a list. I'd like us to migrate to a new pref I believe that handles a list of values.

The end game result I'm after would:
1) get a list of fallback locales for a given locale at runtime (say: "it-IT, it, en-US" for "it" and "sr-Cyrl, ru-RU" for 'sr-Cyrl")
2) build a multilocale.json based on the locales we ask to package the build with and their deduplicated fallbacks (for example for "it-IT, sr-Cyrl" it would build a multilocale.json with ["it-IT, "it", "en-US", "sr-Cyrl", "ru-RU"])
3) package the 5 locales into the build and expose them at runtime so that L10nRegistry can register them
4) GetRequestedLocales should return either ["it-IT, it, en-US"] or ["sr-Cyrl", "ru-RU"]
5) SetRequestedLocales can change that
6) The UI for locale selection would show all 5 available languages at this point but when selected, it would set requestedLocales to a fallback chain for the selected locale.

That's two birds at once - fallback chains, and packaging with multilocales.

Let's start with just fallback chains:

1) Introduce some data structure in our tree that stores fallback chains maintained by l10n drivers
2) When repackaging, build the multilocale.json with said fallback chain
3) Introduce LocaleService::GetFallbackChainForLocale // "it-IT" => ["it-IT", "it", "en-US"]
4) introduce `intl.locale.requested-locales` pre-populated with the fallback chain

I'd like to leave the packaging multiple locales for later, just noting it here because it affects how I'm shaping the APIs.

Comment 6

[Axel Hecht [:Pike]]

I see multilocale.json to be a packaging optimization for L10nRegistry.

I would expect the fallback chains to be an independent dataset of what's part of our build.

I don't see where the actual default is coming from right now, in a single-locale German build, a Fennec build, or a linux distro build.

Comment 7

[Zibi Braniecki [:zbraniecki][:gandalf]]

Attachment: Bug 1410736 - Replace remaining uses of general.useragent.locale with LocaleService API.

Review commit: https://reviewboard.mozilla.org/r/195954/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/195954/

Comment 8

[Zibi Braniecki [:zbraniecki][:gandalf]]

This moves the remaining bits in our codebase to use LocaleService API.

The remaining uses are raw intl.properties, firefox-l10n.js, browser/app/profile/firefox.js etc.

Comment 9

[Jonathan Kew [:jfkthame]]

Comment on attachment 8924730 [details]
Bug 1410736 - Replace remaining uses of general.useragent.locale with LocaleService API.

https://reviewboard.mozilla.org/r/195954/#review201498

Looks reasonable to me, though I'm largely trusting that tryserver would tell us if it was badly broken!

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/0637dca8a971
Replace remaining uses of general.useragent.locale with LocaleService API. r=jfkthame

Comment 11

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

Backed out for eslint failure at toolkit/components/extensions/test/xpcshell/test_ext_i18n_css.js:130: Unexpected var, use let or const instead:

https://hg.mozilla.org/integration/autoland/rev/fd9b6dde9feeec0c4b8406e1ea5920647878824d

Push with failure: https://treeherder.mozilla.org/#/jobs?repo=autoland&revision=0637dca8a9718ca67b57fc879c8be0f22658452b&filter-resultStatus=testfailed&filter-resultStatus=busted&filter-resultStatus=exception&filter-resultStatus=retry&filter-resultStatus=usercancel&filter-resultStatus=runnable
Failure log: https://treeherder.mozilla.org/logviewer.html#?job_id=142053692&repo=autoland
>  TEST-UNEXPECTED-ERROR | /builds/worker/checkouts/gecko/toolkit/components/extensions/test/xpcshell/test_ext_i18n_css.js:130:5 | Unexpected var, use let or const instead. (mozilla/var-only-at-top-level)

Comment 12

[Zibi Braniecki [:zbraniecki][:gandalf]]

Comment on attachment 8924730 [details]
Bug 1410736 - Replace remaining uses of general.useragent.locale with LocaleService API.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/195954/diff/1-2/

Comment 13

[Zibi Braniecki [:zbraniecki][:gandalf]]

Thanks for backing this out!

Comment 14

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/f401d9f8a87d
Replace remaining uses of general.useragent.locale with LocaleService API. r=jfkthame

Comment 15

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

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