Split .i18nrc across `src`, `packages`, and `examples` #8414

AMoo-Miki · 2024-10-01T07:17:17Z

Description

Split .i18nrc across src, packages, and examples

Note: This is the first step in recursively looking for translations. These 3 will be the roots where i18n will recursively search.

Also:

Force validation of i18n even when no translations are available

Changelog

refactor: Split .i18nrc across src, packages, and examples

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-01T07:58:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.92%. Comparing base (4b56be5) to head (ac7150a).
Report is 31 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8414   +/-   ##
=======================================
  Coverage   60.92%   60.92%           
=======================================
  Files        3750     3751    +1     
  Lines       89104    89149   +45     
  Branches    13926    13935    +9     
=======================================
+ Hits        54284    54318   +34     
- Misses      31443    31451    +8     
- Partials     3377     3380    +3

Flag	Coverage Δ
Linux_1	`28.85% <ø> (+0.02%)`	⬆️
Linux_2	`56.35% <ø> (-0.01%)`	⬇️
Linux_3	`37.73% <ø> (+<0.01%)`	⬆️
Linux_4	`29.96% <100.00%> (-0.01%)`	⬇️
Windows_1	`28.87% <ø> (+0.02%)`	⬆️
Windows_2	`56.30% <ø> (-0.01%)`	⬇️
Windows_3	`37.73% <ø> (+<0.01%)`	⬆️
Windows_4	`29.96% <100.00%> (-0.01%)`	⬇️

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: * Force validation of i18n even when no translations are available * Allow including translations in built artifacts Signed-off-by: Miki <[email protected]>

ashwin-pc · 2024-10-01T17:05:05Z

src/plugins/data_explorer/.i18nrc.json

If this file is here, its likely because of our plugin scaffolding code. Lets modify it too to support generating the i18nrc code?

OpenSearch-Dashboards/packages/osd-plugin-generator/src/render_template.ts

Lines 104 to 107 in d7004dc

excludeFiles(

([] as string[]).concat(

answers.ui ? [] : 'public/**/*',

answers.ui && !answers.internal ? [] : ['translations/**/*', 'i18nrc.json'],

While generating a plugin, this piece decides if the i18n manifest and sample translation should be included or not.

If it is not a UI plugin, no i18n files will be included.

if a plugin is internal, no i18n files will be included.

data_explorer was probably generated as an external plugin and then they changes their minds.

Prior to this PR, everything in OSD shared one manifest and one translations folder. This PR splits them into 3 main groups of stuff under src, packages, and examples.
HOWEVER, my plan is to have i18n look through the 3 root folders recursively so src/core, and each internal plugin, package, and example can own its translations. I want to have some form of inheritance so common terms like Save and Save as need not be translated several times for each namespace.

Makes sense :)

ashwin-pc · 2024-10-01T17:08:43Z

examples/.i18nrc.json

if i create a new example or core or external plugin, how will this be updated? I think one of the reasons for keeping the i18nrc file in each plugin migt have been to make scaffolding easier (just speculation)

Each external plugin will continue to own its own i18n manifest and translations. Each internal plugin, package, or example will eventually have their own manifest too, but with this PR, each will use the translations from the src, packages, or examples. Prior to this PR, they all had to pick from one central place.

There is logic which I think "imports" translations files and distributes them to the folder of each manifest based on the namesspaces defined in them. All of these will tie into each other when and if I get to next phase.

Can you document this in a rewadme as a part of the change so that:

Its clear to someone how translations works in OSD after this change.

If you dont get to the next phase yourself, you still have it written down somewhere that someone can take your vision and execute it

A readme would be helpful - I really don't know how this works so harder to review

We have https://github.com/opensearch-project/dashboards-i18n/blob/main/DEVELOPER_GUIDE.md and https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/packages/osd-i18n. Some day, I will merge those into one and add my future vision into it.

ashwin-pc · 2024-10-01T17:09:35Z

src/dev/build/build_distributables.ts

+  if (options.withTranslations) {
+    // control w/ --with-translations
+    await run(Tasks.CopyTranslations);
+  }


virajsanghvi · 2024-10-02T23:14:59Z

examples/.i18nrc.json

+    "embeddableExamples": "embeddable_examples",
+    "expressionsExample": "expressions_example",
+    "multipleDataSourceExample": "multiple_data_source_examples",
+    "searchExamples": "search_examples",


Is the difference in total number of paths across these .i18nrc.json files due to adding some that were not added to the original ones?

virajsanghvi · 2024-10-02T23:35:02Z

examples/.i18nrc.json

A readme would be helpful - I really don't know how this works so harder to review

Also: * Force validation of i18n even when no translations are available * Allow including translations in built artifacts Signed-off-by: Miki <[email protected]> (cherry picked from commit f3f007a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Also: * Force validation of i18n even when no translations are available * Allow including translations in built artifacts (cherry picked from commit f3f007a) Signed-off-by: Miki <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

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

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

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

0509277

AMoo-Miki force-pushed the fix-i18n-paths branch 2 times, most recently from 5e94c56 to d0dbf5c Compare October 1, 2024 09:31

AMoo-Miki added backport 2.x v2.18.0 labels Oct 1, 2024

ashwin-pc added the i18n Internationalization related Issues and PRs label Oct 1, 2024

Split .i18nrc across src, packages, and examples

ac7150a

Also: * Force validation of i18n even when no translations are available * Allow including translations in built artifacts Signed-off-by: Miki <[email protected]>

AMoo-Miki force-pushed the fix-i18n-paths branch from d0dbf5c to ac7150a Compare October 1, 2024 15:24

ashwin-pc reviewed Oct 2, 2024

View reviewed changes

ashwin-pc approved these changes Oct 2, 2024

View reviewed changes

virajsanghvi approved these changes Oct 2, 2024

View reviewed changes

AMoo-Miki merged commit f3f007a into opensearch-project:main Oct 3, 2024
66 of 67 checks passed

opensearch-trigger-bot bot mentioned this pull request Oct 3, 2024

[Backport 2.x] Split .i18nrc across src, packages, and examples #8470

Merged

peterzhuamazon mentioned this pull request Oct 14, 2024

[Bug]: OpenSearch-Dashboards distribution builds are failing for RPM assemble opensearch-project/opensearch-build#5099

Closed

linghengqian mentioned this pull request Oct 26, 2024

[BUG] Docker Image's I18N_LOCALE environment variable does not seem to work #8075

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split .i18nrc across `src`, `packages`, and `examples` #8414

Split .i18nrc across `src`, `packages`, and `examples` #8414

AMoo-Miki commented Oct 1, 2024

codecov bot commented Oct 1, 2024 •

edited

Loading

ashwin-pc Oct 1, 2024

AMoo-Miki Oct 2, 2024 •

edited

Loading

ashwin-pc Oct 2, 2024

ashwin-pc Oct 1, 2024

AMoo-Miki Oct 2, 2024

ashwin-pc Oct 2, 2024

virajsanghvi Oct 2, 2024

AMoo-Miki Oct 3, 2024

ashwin-pc Oct 1, 2024

virajsanghvi Oct 2, 2024

AMoo-Miki Oct 3, 2024

virajsanghvi Oct 2, 2024

	excludeFiles(
	([] as string[]).concat(
	answers.ui ? [] : 'public/*/',
	answers.ui && !answers.internal ? [] : ['translations/*/', 'i18nrc.json'],

Split .i18nrc across src, packages, and examples #8414

Split .i18nrc across src, packages, and examples #8414

Conversation

AMoo-Miki commented Oct 1, 2024

Description

Changelog

Check List

codecov bot commented Oct 1, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

AMoo-Miki Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Split .i18nrc across `src`, `packages`, and `examples` #8414

Split .i18nrc across `src`, `packages`, and `examples` #8414

codecov bot commented Oct 1, 2024 •

edited

Loading

AMoo-Miki Oct 2, 2024 •

edited

Loading