Implement correct normalization of locales in i18n #8535

AMoo-Miki · 2024-10-09T22:16:48Z

Description

Implement correct normalization of locales in i18n

Also:

Stop examining the fragment identifier for possible locale overrides
Update relative formats and plural rules for certain locales

Changelog

feat: Implement correct normalization of locales in i18n
feat: Update relative formats and plural rules for certain locales

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

codecov · 2024-10-09T23:01:35Z

Codecov Report

Attention: Patch coverage is 96.29630% with 2 lines in your changes missing coverage. Please review.

Project coverage is 60.93%. Comparing base (91fd6d3) to head (f57441c).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/osd-i18n/src/loader.ts	60.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8535      +/-   ##
==========================================
- Coverage   60.93%   60.93%   -0.01%     
==========================================
  Files        3771     3770       -1     
  Lines       89541    89554      +13     
  Branches    14017    14015       -2     
==========================================
+ Hits        54563    54570       +7     
- Misses      31567    31572       +5     
- Partials     3411     3412       +1

Flag	Coverage Δ
Linux_1	`29.04% <68.00%> (+0.03%)`	⬆️
Linux_2	`56.28% <84.90%> (+<0.01%)`	⬆️
Linux_3	`37.79% <68.00%> (+0.04%)`	⬆️
Linux_4	`29.95% <70.37%> (+0.03%)`	⬆️
Windows_1	`29.06% <68.00%> (+0.03%)`	⬆️
Windows_2	`56.23% <84.90%> (+<0.01%)`	⬆️
Windows_3	`37.79% <68.00%> (+0.04%)`	⬆️
Windows_4	`29.95% <70.37%> (+0.03%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Also: * Stop examining the fragment identifier for possible locale overrides Signed-off-by: Miki <miki@amazon.com>

Signed-off-by: Miki <miki@amazon.com>

virajsanghvi · 2024-10-10T21:41:56Z

Stop examining the fragment identifier for possible locale overrides

Was this used by anything

virajsanghvi · 2024-10-10T21:30:43Z

packages/osd-i18n/src/core/i18n.ts

+export function normalizeLocale(locale: string) {
+  const { lang, script, region } = localeParser.exec(locale)?.groups || {};
+  // If parsing failed or the language code was not extracted, return the locale
+  if (!lang) return locale;


Is the right thing to accept the bad input or default in this case?

This guy only does the normalization; (in)validation is handled by comparing it against those that have been registered in a different place.

virajsanghvi · 2024-10-10T21:39:08Z

src/core/server/rendering/rendering_service.tsx

@@ -100,6 +100,15 @@ export class RenderingService {
          opensearchDashboardsConfig as OpenSearchDashboardsConfigType
        );

+        let locale = i18n.getLocale();


Is this always a defaulted/configured valid locale?

defaulted: yes
valid: no

i18n starts with en as the default locale and if configured in the YAML config, it uses that without validating that it has been registered or not; I think this is because while reading the config, the filesystem might not have been read to prime the translation registration cache. At runtime, the locale is validation and if found to not have been registered, en is used.

From the code, if invalid, then does it potentially lead to a translation file not being loaded? Is this okay because english translations are loaded worst case?

If the locale is not registered, it would just use English, yes.

virajsanghvi · 2024-10-10T21:40:40Z

src/legacy/ui/ui_render/ui_render_mixin.js

@@ -55,7 +55,8 @@ import { getApmConfig } from '../apm';
 */
 export function uiRenderMixin(osdServer, server, config) {
  const translationsCache = { translations: null, hash: null };
-  const defaultLocale = i18n.getLocale() || 'en'; // Fallback to 'en' if no default locale is set
+  // `i18n.getLocale` will always return a value; the 'en' is just to accommodate tests
+  const defaultLocale = i18n.getLocale() || 'en';


will this always be comparable to a normalized locale? (given toLowerCase was dropped)

Everyone now goes through normalizeLocale, as opposed to .toLowerCase() which is what the older normalize was doing.

ananzh

I saw this PR removes getLocaleInUrl then introduces a new way to handle locale specification in URLs by checking query parameter const localeOverride = (request.query as any)?.locale?.trim?.();

I think the previous way is to handle both standard query or non-standard one, given the two formats of current osd urls. For the URL format like (https://localhost:9200/app/home#/?locale=cn), where the locale is specified in the hash fragment rather than as a regular query parameter, it seems we can't handle.

Does it mean we will not work on such url and request the standard query format if user need this feature? Should we add some documents somewhere for user?

AMoo-Miki · 2024-10-11T00:05:46Z

Stop examining the fragment identifier for possible locale overrides

Was this used by anything

No. We haven’t started using any of the theme or locale overrides yet.

AMoo-Miki · 2024-10-11T16:01:06Z

I think the previous way is to handle both standard query or non-standard one, given the two formats of current osd urls.

Does it mean we will not work on such url and request the standard query format if user need this feature?

That is correct. We cannot parse and handle URL fragments on the server-side and as such would rather not entertain them. A similar pattern is used for the theme. These two parameters are exclusively being introduced to temporarily override a setting and are not meant to be suffixed to every URL fragment.

Should we add some documents somewhere for user?

I don't believe these are to be part of our public API. If we decide to make them, we should.

opensearch-trigger-bot · 2024-10-11T16:36:35Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-8535-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2b149d242cd4f7420c755fe77538b0c56f3677ab
# Push it to GitHub
git push --set-upstream origin backport/backport-8535-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-8535-to-2.x.

…t#8535) * Implement correct normalization of locales in i18n Also: * Stop examining the fragment identifier for possible locale overrides Signed-off-by: Miki <miki@amazon.com> * Update relative formats and plural rules for certain locales Signed-off-by: Miki <miki@amazon.com> --------- Signed-off-by: Miki <miki@amazon.com> (cherry picked from commit 2b149d2) Signed-off-by: Miki <miki@amazon.com>

* Implement correct normalization of locales in i18n Also: * Stop examining the fragment identifier for possible locale overrides * Update relative formats and plural rules for certain locales --------- (cherry picked from commit 2b149d2) Signed-off-by: Miki <miki@amazon.com>

…t#8535) * Implement correct normalization of locales in i18n Also: * Stop examining the fragment identifier for possible locale overrides Signed-off-by: Miki <miki@amazon.com> * Update relative formats and plural rules for certain locales Signed-off-by: Miki <miki@amazon.com> --------- Signed-off-by: Miki <miki@amazon.com>

AMoo-Miki added i18n Internationalization related Issues and PRs backport 2.x v2.18.0 labels Oct 9, 2024

github-actions bot added the distinguished-contributor label Oct 9, 2024

opensearch-changeset-bot bot added a commit to AMoo-Miki/OpenSearch-Dashboards that referenced this pull request Oct 9, 2024

Changeset file for PR opensearch-project#8535 created/updated

6f49c5a

AMoo-Miki force-pushed the fix-i18n-normalization branch from 6f49c5a to 9fc471a Compare October 10, 2024 00:42

AMoo-Miki added 2 commits October 10, 2024 09:34

Implement correct normalization of locales in i18n

b367db4

Also: * Stop examining the fragment identifier for possible locale overrides Signed-off-by: Miki <miki@amazon.com>

Update relative formats and plural rules for certain locales

f57441c

Signed-off-by: Miki <miki@amazon.com>

AMoo-Miki force-pushed the fix-i18n-normalization branch from 9fc471a to f57441c Compare October 10, 2024 16:34

virajsanghvi reviewed Oct 10, 2024

View reviewed changes

ananzh reviewed Oct 10, 2024

View reviewed changes

virajsanghvi approved these changes Oct 11, 2024

View reviewed changes

ananzh approved these changes Oct 11, 2024

View reviewed changes

AMoo-Miki merged commit 2b149d2 into opensearch-project:main Oct 11, 2024
67 of 68 checks passed

opensearch-trigger-bot bot added the failed backport label Oct 11, 2024

AMoo-Miki removed the failed backport label Oct 11, 2024

AMoo-Miki mentioned this pull request Oct 11, 2024

[Manual backport 2.x] Implement correct normalization of locales in i18n (#8535) #8561

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement correct normalization of locales in i18n #8535

Implement correct normalization of locales in i18n #8535

AMoo-Miki commented Oct 9, 2024

codecov bot commented Oct 9, 2024 •

edited

Loading

virajsanghvi commented Oct 10, 2024

virajsanghvi Oct 10, 2024

AMoo-Miki Oct 10, 2024 •

edited

Loading

virajsanghvi Oct 10, 2024

AMoo-Miki Oct 10, 2024

virajsanghvi Oct 10, 2024

AMoo-Miki Oct 11, 2024

virajsanghvi Oct 10, 2024

AMoo-Miki Oct 10, 2024

ananzh left a comment

AMoo-Miki commented Oct 11, 2024

AMoo-Miki commented Oct 11, 2024 •

edited

Loading

opensearch-trigger-bot bot commented Oct 11, 2024

Implement correct normalization of locales in i18n #8535

Implement correct normalization of locales in i18n #8535

Conversation

AMoo-Miki commented Oct 9, 2024

Description

Changelog

Check List

codecov bot commented Oct 9, 2024 • edited Loading

Codecov Report

virajsanghvi commented Oct 10, 2024

virajsanghvi Oct 10, 2024

Choose a reason for hiding this comment

AMoo-Miki Oct 10, 2024 • edited Loading

Choose a reason for hiding this comment

virajsanghvi Oct 10, 2024

Choose a reason for hiding this comment

AMoo-Miki Oct 10, 2024

Choose a reason for hiding this comment

virajsanghvi Oct 10, 2024

Choose a reason for hiding this comment

AMoo-Miki Oct 11, 2024

Choose a reason for hiding this comment

virajsanghvi Oct 10, 2024

Choose a reason for hiding this comment

AMoo-Miki Oct 10, 2024

Choose a reason for hiding this comment

ananzh left a comment

Choose a reason for hiding this comment

AMoo-Miki commented Oct 11, 2024

AMoo-Miki commented Oct 11, 2024 • edited Loading

opensearch-trigger-bot bot commented Oct 11, 2024

codecov bot commented Oct 9, 2024 •

edited

Loading

AMoo-Miki Oct 10, 2024 •

edited

Loading

AMoo-Miki commented Oct 11, 2024 •

edited

Loading