STCOR-1027 Use GET mod-settings /locale API to get tenant language & locale settings

Author: BogdanDenis

CHANGELOG.md

@@ -36,6 +36,7 @@
 * Add `tr` Türkçe (Turkish) locale. Refs STCOR-1026.
 * Remove the `/users-keycloak/_self` (and `/bl-users/_self`) requests. They were included in `isAuthenticationRequest`, which caused them to bypass the RTR queue (`getPromise`). Fixes STCOR-1029.
 * Define a permission-set containing values necessary for session-init API requests. Refs STCOR-1031.
+* Use GET mod-settings `/locale` API to get tenant language & locale settings. Refs STCOR-1027.
 
 ## [11.0.0](https://github.com/folio-org/stripes-core/tree/v11.0.0) (2025-02-24)
 [Full Changelog](https://github.com/folio-org/stripes-core/compare/v10.2.0...v11.0.0)

src/loginServices.js

@@ -327,77 +327,13 @@ export async function loadTranslations(store, locale, defaultTranslations = {})
  * @param {string} tenant
  * @returns {Promise}
  */
-async function dispatchLocale(url, store, tenant) {
-  const response = await fetch(url, {
-    headers: getHeaders(tenant, store.getState().okapi.token),
-    credentials: 'include',
-    mode: 'cors',
-  });
-
-  if (response.ok) {
-    const json = await response.json();
-    if (json.configs?.length) {
-      const localeValues = JSON.parse(json.configs[0].value);
-      const { locale, timezone, currency } = localeValues;
-      if (locale) {
-        await loadTranslations(store, locale);
-      }
-      if (timezone) store.dispatch(setTimezone(timezone));
-      if (currency) store.dispatch(setCurrency(currency));
-    }
+async function dispatchLocale(localeValues, store) {
+  const { locale, timezone, currency } = localeValues;
+  if (locale) {
+    await loadTranslations(store, locale);
   }
-
-  return response;
-}
-
-/**
- * getLocale
- * return a promise that retrieves the tenant's locale-settings then
- * loads the translations and dispatches the timezone and currency.
- * @param {string} okapiUrl
- * @param {redux store} store
- * @param {string} tenant
- *
- * @returns {Promise}
- */
-export async function getLocale(okapiUrl, store, tenant) {
-  const query = [
-    'module==ORG',
-    'configName == localeSettings',
-    '(cql.allRecords=1 NOT userId="" NOT code="")'
-  ].join(' AND ');
-
-  const res = await dispatchLocale(
-    `${okapiUrl}/configurations/entries?query=(${query})`,
-    store,
-    tenant
-  );
-
-  return res;
-}
-
-/**
- * getUserLocale
- * return a promise that retrieves the user's locale-settings then
- * loads the translations and dispatches the timezone and currency.
- * @param {*} okapiUrl
- * @param {*} store
- * @param {*} tenant
- *
- * @returns {Promise}
- */
-export async function getUserLocale(okapiUrl, store, tenant, userId) {
-  const query = Object.entries(userLocaleConfig)
-    .map(([k, v]) => `"${k}"=="${v}"`)
-    .join(' AND ');
-
-  const res = await dispatchLocale(
-    `${okapiUrl}/configurations/entries?query=(${query} and userId=="${userId}")`,
-    store,
-    tenant
-  );
-
-  return res;
+  if (timezone) store.dispatch(setTimezone(timezone));
+  if (currency) store.dispatch(setCurrency(currency));
 }
 
 /**
@@ -484,6 +420,7 @@ const fetchLocale = async (url, store, tenant) => {
   return res;
 };
 
+
 /**
  * Retrieves the tenant's locale setting from the mod-settings.
  *
@@ -496,15 +433,23 @@ const fetchLocale = async (url, store, tenant) => {
  * @returns {Promise} A promise that resolves with the locale configuration data.
  */
 const getTenantLocale = async (url, store, tenant) => {
-  const query = `scope=="${settings.SCOPE}" and key=="${tenantLocaleConfig.KEY}"`;
+  const response = await fetch(`${url}/locale`, {
+    headers: getHeaders(tenant, store.getState().okapi.token),
+    credentials: 'include',
+    mode: 'cors',
+  });
 
-  const res = await fetchLocale(
-    `${url}/settings/entries?query=(${query})`,
-    store,
-    tenant
-  );
+  if (response.ok) {
+    const locale = await response.json();
 
-  return res;
+    dispatchLocale(
+      locale,
+      store,
+      tenant
+    );
+  }
+
+  return response;
 };
 
 /**
@@ -523,13 +468,27 @@ const getTenantLocale = async (url, store, tenant) => {
 const getUserOwnLocale = async (url, store, tenant, userId) => {
   const query = `userId=="${userId}" and scope=="${settings.SCOPE}" and key=="${userOwnLocaleConfig.KEY}"`;
 
-  const res = await fetchLocale(
-    `${url}/settings/entries?query=(${query})`,
-    store,
-    tenant
-  );
+  const response = await fetch(`${url}/settings/entries?query=(${query})`, {
+    headers: getHeaders(tenant, store.getState().okapi.token),
+    credentials: 'include',
+    mode: 'cors',
+  });
 
-  return res;
+  if (response.ok) {
+    const json = await response.json();
+
+    if (json.items?.length) {
+      const localeValues = JSON.parse(json.items[0]?.value);
+
+      dispatchLocale(
+        localeValues,
+        store,
+        tenant
+      );
+    }
+  }
+
+  return response;
 };
 
 /**
@@ -584,7 +543,7 @@ export const getFullLocale = (languageRegion, numberingSystem) => {
  * @returns {Promise}
  */
 const processLocaleSettings = async (store, tenantLocaleData, userLocaleData) => {
-  const tenantLocaleSettings = tenantLocaleData?.items[0]?.value;
+  const tenantLocaleSettings = tenantLocaleData;
   const userLocaleSettings = userLocaleData?.items[0]?.value;
 
   const locale = userLocaleSettings?.locale || tenantLocaleSettings?.locale;
@@ -598,15 +557,6 @@ const processLocaleSettings = async (store, tenantLocaleData, userLocaleData) =>
   return res;
 };
 
-// This function is used to support the deprecated mod-configuration API.
-// It is only used when the new mod-settings API returns empty settings.
-const getLocalesPromise = (url, store, tenant, userId) => {
-  return Promise.all([
-    getLocale(url, store, tenant),
-    getUserLocale(url, store, tenant, userId),
-  ]);
-};
-
 /**
  * loadResources
  * return a promise that retrieves the tenant's locale, user's locale,
@@ -642,20 +592,15 @@ export async function loadResources(store, tenant, userId) {
       getTenantLocale(okapiUrl, store, tenant),
       getUserOwnLocale(okapiUrl, store, tenant, userId),
     ]);
-    const [tenantLocaleData, userLocaleData] = await Promise.all(responses.map(res => res.value?.json?.()));
-    hasSetting = tenantLocaleData?.items[0] || userLocaleData?.items[0];
+    const [tenantLocaleData, userLocaleData] = [responses];
+    hasSetting = tenantLocaleData || userLocaleData?.items[0].value;
 
     if (hasSetting) {
       await processLocaleSettings(store, tenantLocaleData, userLocaleData);
       promises.push(responses.map(res => res?.value));
     }
   }
 
-  // only read from legacy mod-config if we haven't already read from mod-settings
-  if (hasReadConfigPerm && !hasSetting) {
-    promises.push(getLocalesPromise(okapiUrl, store, tenant, userId));
-  }
-
   // tenant's locale, plugin, bindings, and user's locale are all stored
   // in mod-configuration so we can only retrieve them if the user has
   // read-permission for configuration entries.