Add i18n checks to PR workflows (#8411)

* Ignore missing `formats` while checking locale files Also: * Add help text and description to `i18n-check` * Fix malformed translations Signed-off-by: Miki <[email protected]> * Add i18n checks to PR workflows Signed-off-by: Miki <[email protected]> * Changeset file for PR #8411 created/updated --------- Signed-off-by: Miki <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit 428a7c2) Signed-off-by: Miki <[email protected]>
opensearch-project · Oct 7, 2024 · af3ab27 · af3ab27
1 parent c5462c3
commit af3ab27
Show file tree

Hide file tree

Showing 12 changed files with 1,691 additions and 17 deletions.
diff --git a/.github/workflows/build_and_test_workflow.yml b/.github/workflows/build_and_test_workflow.yml
@@ -34,7 +34,7 @@ env:
   NODE_OPTIONS: "--max-old-space-size=6144 --dns-result-order=ipv4first"
 
 jobs:
-  build-lint-test:
+  build-test:
     name: Build and Verify on ${{ matrix.name }} (ciGroup${{ matrix.group }})
     strategy:
       fail-fast: false
@@ -104,18 +104,6 @@ jobs:
         if: matrix.os == 'windows-latest'
         run: yarn osd bootstrap || yarn osd bootstrap
 
-      - name: Run linter
-        # ciGroup 1 of unit-tests is shorter and Linux is faster
-        if: matrix.group == 1 && matrix.os == 'ubuntu-latest'
-        id: linter
-        run: yarn lint
-
-      - name: Validate NOTICE file
-        # ciGroup 1 of unit-tests is shorter and Linux is faster
-        if: matrix.group == 1 && matrix.os == 'ubuntu-latest'
-        id: notice-validate
-        run: yarn notice:validate
-
       - name: Run unit tests group ${{ matrix.group }} with coverage
         id: unit-tests
         run: yarn test:jest:ci:coverage  --ci-group=${{ matrix.group }}
@@ -140,6 +128,51 @@ jobs:
         id: integration-tests
         run: yarn test:jest_integration:ci
 
+  lint-and-validate:
+    name: Lint and validate
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Setup Yarn
+        run: |
+          npm uninstall -g yarn
+          npm i -g [email protected]
+          yarn config set network-timeout 1000000 -g
+
+      - name: Configure Yarn Cache
+        run: echo "YARN_CACHE_LOCATION=$(yarn cache dir)" >> $GITHUB_ENV
+
+      - name: Initialize Yarn Cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.YARN_CACHE_LOCATION }}
+          key: yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            yarn-
+
+      - name: Run bootstrap
+        run: yarn osd bootstrap
+
+      - name: Run linter
+        id: linter
+        run: yarn lint
+
+      - name: Validate NOTICE file
+        id: notice-validate
+        run: yarn notice:validate
+
+      - name: Check i18n
+        id: i18n-check
+        run: yarn i18n:check
+
   functional-tests:
     name: Run functional tests on ${{ matrix.name }} (ciGroup${{ matrix.group }})
     strategy:

diff --git a/changelogs/fragments/8411.yml b/changelogs/fragments/8411.yml
@@ -0,0 +1,9 @@
+infra:
+- Add i18n checks to PR workflows ([#8411](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8411))
+
+feat:
+- Ignore missing `formats` while checking locale files ([#8411](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8411))
+- Add help text and description to `i18n-check` ([#8411](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8411))
+
+fix:
+- Fix malformed translations ([#8411](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8411))
diff --git a/package.json b/package.json
@@ -69,6 +69,8 @@
     "lint": "yarn run lint:es && yarn run lint:style",
     "lint:es": "scripts/use_node scripts/eslint",
     "lint:style": "scripts/use_node scripts/stylelint",
+    "i18n:check": "scripts/use_node scripts/i18n_check --ignore-missing --ignore-unused",
+    "i18n:extract": "scripts/use_node scripts/i18n_extract.js",
     "makelogs": "scripts/use_node scripts/makelogs",
     "uiFramework:compileCss": "cd packages/osd-ui-framework && yarn compileCss",
     "osd:watch": "scripts/use_node scripts/opensearch_dashboards --dev --logging.json=false",

diff --git a/src/dev/i18n/integrate_locale_files.ts b/src/dev/i18n/integrate_locale_files.ts
@@ -56,6 +56,7 @@ export interface IntegrateOptions {
   ignoreIncompatible: boolean;
   ignoreUnused: boolean;
   ignoreMissing: boolean;
+  ignoreMissingFormats?: boolean;
   config: I18nConfig;
   log: ToolingLog;
 }
@@ -211,7 +212,11 @@ export async function integrateLocaleFiles(
 ) {
   const localizedMessages = JSON.parse((await readFileAsync(options.sourceFileName)).toString());
   if (!localizedMessages.formats) {
-    throw createFailError(`Locale file should contain formats object.`);
+    if (options.ignoreMissingFormats) {
+      options.log.warning('Missing formats object ignored');
+    } else {
+      throw createFailError(`Locale file should contain formats object.`);
+    }
   }
 
   const localizedMessagesMap: LocalizedMessageMap = new Map(

diff --git a/src/dev/i18n/tasks/check_compatibility.ts b/src/dev/i18n/tasks/check_compatibility.ts
@@ -37,6 +37,7 @@ export interface I18nFlags {
   ignoreIncompatible: boolean;
   ignoreUnused: boolean;
   ignoreMissing: boolean;
+  ignoreMissingFormats: boolean;
 }
 
 export function checkCompatibility(
@@ -47,16 +48,24 @@ export function checkCompatibility(
   if (!config) {
     throw new Error('Config is missing');
   }
-  const { fix, ignoreIncompatible, ignoreUnused, ignoreMalformed, ignoreMissing } = flags;
+  const {
+    fix,
+    ignoreIncompatible,
+    ignoreUnused,
+    ignoreMalformed,
+    ignoreMissing,
+    ignoreMissingFormats,
+  } = flags;
   return config.translations.map((translationsPath) => ({
     task: async ({ messages }: { messages: Map<string, { message: string }> }) => {
-      // If `fix` is set we should try apply all possible fixes and override translations file.
+      // If `fix` is set we should try to apply all possible fixes and override translations file.
       await integrateLocaleFiles(messages, {
         dryRun: !fix,
         ignoreIncompatible: fix || ignoreIncompatible,
         ignoreUnused: fix || ignoreUnused,
         ignoreMissing: fix || ignoreMissing,
         ignoreMalformed: fix || ignoreMalformed,
+        ignoreMissingFormats,
         sourceFileName: translationsPath,
         targetFileName: fix ? translationsPath : undefined,
         config,

diff --git a/src/dev/run_i18n_check.ts b/src/dev/run_i18n_check.ts
@@ -45,6 +45,7 @@ import { DEFAULT_DIRS_WITH_RC_FILES } from './i18n/constants';
 
 const skipOnNoTranslations = (context: ListrContext) =>
   !context.config?.translations?.length && 'No translations found.';
+
 run(
   async ({
     flags: {
@@ -54,6 +55,7 @@ run(
       'ignore-unused': ignoreUnused,
       'include-config': includeConfig,
       'ignore-untracked': ignoreUntracked,
+      'ignore-missing-formats': ignoreMissingFormats,
       fix = false,
       path,
     },
@@ -121,11 +123,13 @@ run(
                   ignoreIncompatible: !!ignoreIncompatible,
                   ignoreUnused: !!ignoreUnused,
                   ignoreMissing: !!ignoreMissing,
+                  // By default ignore missing formats
+                  ignoreMissingFormats: ignoreMissingFormats !== false,
                   fix,
                 },
                 log
               ),
-              { exitOnError: true }
+              { exitOnError: false }
             );
           },
         },
@@ -154,6 +158,16 @@ run(
     flags: {
       allowUnexpected: true,
       guessTypesForUnexpectedFlags: true,
+      help: `
+      --ignore-incompatible           Ignore mismatched keys in values and tokens in translations
+      --ignore-malformed              Ignore malformed ICU format usages
+      --ignore-missing                Ignore missing translations in locale files
+      --ignore-unused                 Ignore unused translations in locale files
+      --ignore-untracked              Ignore untracked files with i18n labels
+      --ignore-missing-formats        Ignore missing 'formats' key in locale files
+                                      (default: true, use --ignore-missing-formats=false to disable)
+      `,
     },
+    description: 'Checks i18n usage in code and validates translation files',
   }
 );