CLM-8914 Cart Translations Issue

jest.config.js

@@ -74,7 +74,9 @@ module.exports = {
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
 
   // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
+  moduleNameMapper: {
+    'sortobject(.*)': '<rootDir>/node_modules/sortobject/edition-es2019/index.js'
+  },
 
   // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
   modulePathIgnorePatterns: [

packages/catalog/src/variants/filter-selector/sort-selector.tsx

@@ -1,20 +1,30 @@
+import { GlobalTypes } from '@thoughtindustries/content';
 import React from 'react';
 import { useTranslation } from 'react-i18next';
-import { CatalogParams, useCatalog } from '../../core';
-import { localizedSortMapping } from './constants';
+import { CatalogParams, SortField, useCatalog } from '../../core';
 import DropdownMenu from './dropdown-menu';
 
 const SortSelector = ({
   enabledSorts,
   sort
 }: Pick<CatalogParams, 'enabledSorts' | 'sort'>): JSX.Element => {
   const { t } = useTranslation();
+
+  const localizedSortMapping: { [key in SortField]: string } = {
+    [GlobalTypes.SortColumn.UpdatedAt]: t('catalog.sort-updated'),
+    [GlobalTypes.SortColumn.CreatedAt]: t('catalog.sort-created'),
+    [GlobalTypes.SortColumn.Title]: t('catalog.sort-title'),
+    [GlobalTypes.SortColumn.PublishDate]: t('catalog.sort-publish-date'),
+    [GlobalTypes.SortColumn.CourseStartDate]: t('catalog.sort-course-start-date'),
+    [GlobalTypes.SortColumn.Relevance]: t('catalog.sort-relevance')
+  };
+
   const { urlManager } = useCatalog();
   const { field: selectedField, direction: selectedDirection } = sort || {};
   const label = t('catalog.sort-by');
   const filters = enabledSorts.map(item => ({
     isSelected: selectedField === item.field && selectedDirection === item.direction,
-    name: t(localizedSortMapping[item.field]),
+    name: localizedSortMapping[item.field],
     link: urlManager.composeURLForSetSort(item)
   }));
 

tooling/cli/lib/command-modules/update-translations.js

@@ -27,7 +27,9 @@ exports.handler = argv => {
   };
 
   const updateScriptPath = path.resolve(__dirname, './../update-translations.js');
-  const updateProcess = exec(`node ${updateScriptPath}`, { env });
+  const updateProcess = exec(`node -e "require('${updateScriptPath}').updateTranslations()"`, {
+    env
+  });
 
   updateProcess.stdout.pipe(process.stdout);
   updateProcess.stderr.pipe(process.stderr);

tooling/cli/lib/deploy.js

@@ -208,7 +208,7 @@ async function gatherUsedTranslations() {
     const parserScript = path.join(__dirname, 'parse-translations.js');
     const exec = childProcess.exec;
 
-    const parseProcess = exec(`node ${parserScript}`);
+    const parseProcess = exec(`node -e "require('${parserScript}').mainFunction()"`);
 
     parseProcess.stdout.pipe(process.stdout);
     parseProcess.stderr.pipe(process.stderr);

tooling/cli/lib/helpers/filepaths.js

@@ -24,7 +24,9 @@ const getFilePaths = async (dir, filePaths = [], skipNodeModules = true) => {
         await getFilePaths(filePath, newFilePaths);
       }
     }
-  } catch {}
+  } catch (error) {
+    console.log(error);
+  }
   return newFilePaths;
 };
 
@@ -33,7 +35,8 @@ const filePathIsValid = filePath => {
     filePath.endsWith('.js') ||
     filePath.endsWith('.jsx') ||
     filePath.endsWith('.ts') ||
-    filePath.endsWith('.tsx')
+    filePath.endsWith('.tsx') ||
+    filePath.endsWith('.mjs')
   );
 };
 

tooling/cli/lib/helpers/translations.js

@@ -62,7 +62,8 @@ const writeTranslationFile = async (dir, translations, generateBackup = false) =
   }
 
   const devFileName = path.join(dirPath, 'translations.json');
-  return writeFile(devFileName, stringifiedTranslations);
+
+  await writeFile(devFileName, stringifiedTranslations);
 };
 
 // react-i18next handles pluralizations differently than the

tooling/cli/lib/parse-translations.js

@@ -2,15 +2,13 @@ const path = require('path');
 const { readFile, writeFile } = require('fs/promises');
 const Parser = require('i18next-scanner').Parser;
 const { getFilePaths, filePathIsValid } = require('./helpers/filepaths');
+const fsPromises = require('fs/promises');
 
-const OP_DIR = process.cwd();
-const TI_TRANSLATIONS_PATH = path.join(OP_DIR, 'locales/translations.json');
-const TI_TRANSLATIONS = require(TI_TRANSLATIONS_PATH);
-const FINAL_TRANSLATIONS = {};
-const KEYS_WITH_PLURALS = [];
-
-(async function () {
+async function processTranslations(TI_TRANSLATIONS, OP_DIR) {
+  const FINAL_TRANSLATIONS = {};
+  const KEYS_WITH_PLURALS = [];
   const compiledProjectPath = path.join(OP_DIR, 'dist');
+
   const compiledProjectFiles = await getFilePaths(compiledProjectPath);
 
   // i18next-scanner's pluralization uses the `_plural` suffix,
@@ -22,6 +20,38 @@ const KEYS_WITH_PLURALS = [];
     interpolation: { prefix: '%{', suffix: '}' }
   });
 
+  function addToTranslations(key) {
+    const translatedLanguages = Object.keys(TI_TRANSLATIONS);
+    for (const lang of translatedLanguages) {
+      if (!FINAL_TRANSLATIONS[lang]) {
+        FINAL_TRANSLATIONS[lang] = { lms: {} };
+      }
+
+      if (translationExists(lang, key)) {
+        const sourceTranslation = TI_TRANSLATIONS[lang].lms[key];
+        FINAL_TRANSLATIONS[lang].lms[key] = sourceTranslation;
+
+        if (KEYS_WITH_PLURALS.includes(key)) {
+          const pluralizedKey = `${key}_other`;
+          if (translationExists(lang, pluralizedKey)) {
+            FINAL_TRANSLATIONS[lang].lms[pluralizedKey] = TI_TRANSLATIONS[lang].lms[pluralizedKey];
+          }
+        }
+      }
+    }
+  }
+  function gatherPluralizedKeys() {
+    const pluralizedKeys = Object.keys(TI_TRANSLATIONS.en.lms).filter(key =>
+      key.includes('_other')
+    );
+    for (const pluralKey of pluralizedKeys) {
+      KEYS_WITH_PLURALS.push(pluralKey.replace('_other', ''));
+    }
+  }
+  function translationExists(lang, key) {
+    return TI_TRANSLATIONS[lang] && TI_TRANSLATIONS[lang].lms[key];
+  }
+
   for (const filePath of compiledProjectFiles) {
     if (filePathIsValid(filePath)) {
       const fileContents = await readFile(filePath, 'utf8');
@@ -35,8 +65,10 @@ const KEYS_WITH_PLURALS = [];
   gatherPluralizedKeys();
 
   const i18nStore = parser.get();
+
   // en is default lang and lms is default namespace, so all keys used should be in that object
   const i18nNSObject = i18nStore.en && i18nStore.en.lms ? i18nStore.en.lms : {};
+
   const usedTranslationKeys = Object.keys(i18nNSObject);
 
   for (const key of usedTranslationKeys) {
@@ -58,49 +90,37 @@ const KEYS_WITH_PLURALS = [];
       }
     }
   }
+  return FINAL_TRANSLATIONS;
+}
 
+async function readTranslations(OP_DIR) {
+  const TI_TRANSLATIONS_PATH = path.join(OP_DIR, 'locales/translations.json');
+  const fileContent = await fsPromises.readFile(TI_TRANSLATIONS_PATH, 'utf8');
+  const TI_TRANSLATIONS = JSON.parse(fileContent);
+  return TI_TRANSLATIONS;
+}
+
+async function writeTranslations(FINAL_TRANSLATIONS, OP_DIR) {
   await writeFile(
     path.join(OP_DIR, 'locales/translations.json'),
     JSON.stringify(FINAL_TRANSLATIONS, null, 2)
   );
-})()
-  .then(() => {
-    console.log('>>> Translations parsed');
-    process.exit(0);
-  })
-  .catch(err => {
-    console.error('>>> Error parsing translations', err.message);
-    process.exit(1);
-  });
+}
 
-function addToTranslations(key) {
-  const translatedLanguages = Object.keys(TI_TRANSLATIONS);
-  for (const lang of translatedLanguages) {
-    if (!FINAL_TRANSLATIONS[lang]) {
-      FINAL_TRANSLATIONS[lang] = { lms: {} };
-    }
-
-    if (translationExists(lang, key)) {
-      const sourceTranslation = TI_TRANSLATIONS[lang].lms[key];
-      FINAL_TRANSLATIONS[lang].lms[key] = sourceTranslation;
-
-      if (KEYS_WITH_PLURALS.includes(key)) {
-        const pluralizedKey = `${key}_other`;
-        if (translationExists(lang, pluralizedKey)) {
-          FINAL_TRANSLATIONS[lang].lms[pluralizedKey] = TI_TRANSLATIONS[lang].lms[pluralizedKey];
-        }
-      }
+async function mainFunction() {
+  try {
+    const OP_DIR = process.cwd();
+    const TI_TRANSLATIONS = await readTranslations(OP_DIR);
+    const translation_to_write = await processTranslations(TI_TRANSLATIONS, OP_DIR);
+    if (Object.keys(translation_to_write).length !== 0) {
+      await writeTranslations(translation_to_write, OP_DIR);
+      console.log('>>> Translations parsed');
+      process.exit(0);
     }
+  } catch (err) {
+    console.log('>>> Error parsing translations:', err.message);
+    process.exit(1);
   }
 }
 
-function translationExists(lang, key) {
-  return TI_TRANSLATIONS[lang] && TI_TRANSLATIONS[lang].lms[key];
-}
-
-function gatherPluralizedKeys() {
-  const pluralizedKeys = Object.keys(TI_TRANSLATIONS.en.lms).filter(key => key.includes('_other'));
-  for (const pluralKey of pluralizedKeys) {
-    KEYS_WITH_PLURALS.push(pluralKey.replace('_other', ''));
-  }
-}
+module.exports = { processTranslations, readTranslations, writeTranslations, mainFunction };

tooling/cli/lib/update-translations.js

@@ -1,29 +1,7 @@
 const { fetchTranslations, writeTranslationFile } = require('./helpers/translations');
 const path = require('path');
 
-const OP_DIR = process.cwd();
-const configPath = path.join(OP_DIR, '/ti-config');
-const config = require(configPath);
-const INSTANCE_NAME = process.env.INSTANCE_NAME;
-
-(async function () {
-  const instance = findTIInstance();
-  const instanceTranslations = await fetchTranslations(instance);
-
-  if (instanceTranslations && instanceTranslations.length) {
-    await writeTranslationFile(OP_DIR, instanceTranslations);
-  }
-})()
-  .then(() => {
-    console.log('>>> Translations updated successfully');
-    process.exit(0);
-  })
-  .catch(err => {
-    console.error('>>> Error updating translations: ', err);
-    process.exit(1);
-  });
-
-function findTIInstance() {
+function findTIInstance(config, INSTANCE_NAME) {
   const { instances = [] } = config;
   let instance;
 
@@ -40,3 +18,27 @@ function findTIInstance() {
 
   return instance;
 }
+
+async function updateTranslations(pathToWrite) {
+  if (pathToWrite === undefined) {
+    pathToWrite = process.cwd();
+  }
+  const configPath = path.resolve(pathToWrite, 'ti-config.json');
+  const config = require(configPath);
+  const INSTANCE_NAME = process.env.INSTANCE_NAME;
+  try {
+    const instance = findTIInstance(config, INSTANCE_NAME);
+    const instanceTranslations = await fetchTranslations(instance);
+
+    if (instanceTranslations && instanceTranslations.length) {
+      await writeTranslationFile(pathToWrite, instanceTranslations);
+      console.log('>>> Translations updated successfully');
+      process.exit(0);
+    }
+  } catch (err) {
+    console.error('>>> Error updating translations: ', err);
+    process.exit(1);
+  }
+}
+
+module.exports = { updateTranslations, findTIInstance };

tooling/cli/package.json

@@ -4,7 +4,8 @@
   "description": "The Helium CLI",
   "main": "lib/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "jest": "jest"
   },
   "bin": {
     "helium": "lib/index.js"