MWPW-156357 Price-literals - fail gracefully (#2815)

* MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * Trigger Build * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * MWPW-156357 Price-literals - fail gracefully * Trigger Build * MWPW-156357 Price-literals - fail gracefully --------- Co-authored-by: Bozo Jovicic <bozo@hitthecode.com>
adobecom · Sep 10, 2024 · 3fd877c · 3fd877c
1 parent 5ad94df
commit 3fd877c
Show file tree

Hide file tree

Showing 29 changed files with 44 additions and 666 deletions.
diff --git a/libs/blocks/merch/merch.js b/libs/blocks/merch/merch.js
@@ -3,7 +3,6 @@ import {
 } from '../../utils/utils.js';
 import { replaceKey } from '../../features/placeholders.js';
 
-export const PRICE_LITERALS_URL = 'https://www.adobe.com/federal/commerce/price-literals.json';
 export const CHECKOUT_LINK_CONFIG_PATH = '/commerce/checkout-link.json'; // relative to libs.
 
 export const PRICE_TEMPLATE_DISCOUNT = 'discount';
@@ -179,14 +178,6 @@ export async function fetchEntitlements() {
   return fetchEntitlements.promise;
 }
 
-export async function fetchLiterals(url) {
-  fetchLiterals.promise = fetchLiterals.promise ?? new Promise((resolve) => {
-    fetch(url)
-      .then((response) => response.json().then(({ data }) => resolve(data)));
-  });
-  return fetchLiterals.promise;
-}
-
 export async function fetchCheckoutLinkConfigs(base = '') {
   fetchCheckoutLinkConfigs.promise = fetchCheckoutLinkConfigs.promise
     ?? fetch(`${base}${CHECKOUT_LINK_CONFIG_PATH}`).catch((e) => {
@@ -430,7 +421,6 @@ export async function initService(force = false) {
     fetchCheckoutLinkConfigs.promise = undefined;
   }
   const { env, commerce = {}, locale } = getConfig();
-  commerce.priceLiteralsPromise = fetchLiterals(PRICE_LITERALS_URL);
   initService.promise = initService.promise ?? polyfills().then(async () => {
     const { hostname, searchParams } = new URL(window.location.href);
     let commerceLibPath = '../../deps/mas/commerce.js';

diff --git a/libs/deps/mas/commerce.js b/libs/deps/mas/commerce.js
diff --git a/libs/features/mas/commerce/libs/commerce.d.ts b/libs/features/mas/commerce/libs/commerce.d.ts
@@ -22,7 +22,7 @@ declare global {
                 Commerce.Checkout.Settings &
                     Commerce.Price.Settings &
                     Commerce.Wcs.Settings,
-                'locale' | 'priceLiteralsURL' | 'quantity'
+                'locale' | 'quantity'
             > & {
                 quantity: number;
             }
@@ -514,8 +514,6 @@ declare global {
                 displayRecurrence: boolean;
                 displayTax: boolean;
                 forceTaxExclusive: boolean;
-                priceLiteralsURL: string;
-                priceLiteralsPromise: Promise<Response>;
             }
         }
 

diff --git a/libs/features/mas/commerce/price-literals.json b/libs/features/mas/commerce/price-literals.json
diff --git a/libs/features/mas/commerce/src/index.d.ts b/libs/features/mas/commerce/src/index.d.ts
@@ -22,7 +22,7 @@ declare global {
                 Commerce.Checkout.Settings &
                     Commerce.Price.Settings &
                     Commerce.Wcs.Settings,
-                'locale' | 'priceLiteralsURL' | 'quantity'
+                'locale' | 'quantity'
             > & {
                 quantity: number;
             }
@@ -514,8 +514,6 @@ declare global {
                 displayRecurrence: boolean;
                 displayTax: boolean;
                 forceTaxExclusive: boolean;
-                priceLiteralsURL: string;
-                priceLiteralsPromise: Promise<Response>;
             }
         }
 

diff --git a/libs/features/mas/commerce/src/literals.js b/libs/features/mas/commerce/src/literals.js
@@ -1,29 +1,17 @@
-import { ERROR_MESSAGE_MISSING_LITERALS_URL } from './constants.js';
 import { Defaults } from './defaults.js';
 import { equalsCaseInsensitive } from './external.js';
 
-function generateLiteralsPromise(settings) {
-    if (!settings.priceLiteralsURL) {
-        throw new Error(ERROR_MESSAGE_MISSING_LITERALS_URL);
-    }
-    return new Promise((resolve) => {
-        window.fetch(settings.priceLiteralsURL).then((response) => {
-            response.json().then(({ data }) => {
-                resolve(data);
-            });
-        });
-    });
-}
-
 /**
+ * Method resolves price literals for the given language from the group of price literals.
+ * That group is either imported from json file or it is received as a parameter (in case of unit tests).
+ *
  * @param {Commerce.Price.Settings} settings
+ * @param priceLiterals
  * @returns {Promise<Record<string, string>>}
  */
-export async function fetchPriceLiterals(settings) {
-    const priceLiteralsPromise =
-        settings.priceLiteralsPromise || generateLiteralsPromise(settings);
+export async function getPriceLiterals(settings, priceLiterals) {
     //we are expecting an array of objects with lang and literals
-    const data = await priceLiteralsPromise;
+    const { data } = priceLiterals ? priceLiterals : await import('../price-literals.json');
     if (Array.isArray(data)) {
         const find = (language) =>
             data.find((candidate) =>

diff --git a/libs/features/mas/commerce/src/service.js b/libs/features/mas/commerce/src/service.js
@@ -4,7 +4,7 @@ import { EVENT_TYPE_READY, TAG_NAME_SERVICE } from './constants.js';
 import { Defaults } from './defaults.js';
 import { isFunction } from './external.js';
 import { Ims } from './ims.js';
-import { fetchPriceLiterals } from './literals.js';
+import { getPriceLiterals } from './literals.js';
 import { Log } from './log.js';
 import { Price } from './price.js';
 import { getSettings } from './settings.js';
@@ -43,7 +43,7 @@ async function activateService(config, dataProviders) {
     const settings = Object.freeze(getSettings(config));
     // Fetch price literals
     try {
-        literals.price = await fetchPriceLiterals(settings);
+        literals.price = await getPriceLiterals(settings, config.commerce.priceLiterals);
     } catch (error) {
         log.warn('Price literals were not fetched:', error);
     }

diff --git a/libs/features/mas/commerce/src/settings.js b/libs/features/mas/commerce/src/settings.js
@@ -218,8 +218,6 @@ function getSettings(config = {}) {
         modal,
         env,
         forceTaxExclusive,
-        priceLiteralsURL: commerce.priceLiteralsURL,
-        priceLiteralsPromise: commerce.priceLiteralsPromise,
         promotionCode,
         quantity,
         wcsApiKey,

diff --git a/libs/features/mas/commerce/test/checkout.test.js b/libs/features/mas/commerce/test/checkout.test.js
@@ -19,7 +19,6 @@ import { mockConfig } from './mocks/config.js';
 import { mockFetch } from './mocks/fetch.js';
 import { mockIms, unmockIms } from './mocks/ims.js';
 import { mockLana, unmockLana } from './mocks/lana.js';
-import { withLiterals } from './mocks/literals.js';
 import { mockProviders } from './mocks/providers.js';
 import { withWcs } from './mocks/wcs.js';
 import { expect, sinon } from './utilities.js';
@@ -48,7 +47,7 @@ afterEach(() => {
 });
 
 beforeEach(async () => {
-    await mockFetch(withWcs, withLiterals);
+    await mockFetch(withWcs);
     mockLana();
 });
 

diff --git a/libs/features/mas/commerce/test/literals.test.js b/libs/features/mas/commerce/test/literals.test.js
@@ -1,44 +1,24 @@
 import { Defaults } from '../src/index.js';
-import { fetchPriceLiterals } from '../src/literals.js';
-
-import { mockFetch } from './mocks/fetch.js';
-import { priceLiteralsURL, withLiterals } from './mocks/literals.js';
+import { getPriceLiterals } from '../src/literals.js';
 import { expect } from './utilities.js';
+import { readFile } from '@web/test-runner-commands';
 
-describe('function "fetchPriceLiterals"', () => {
-    beforeEach(async () => {
-        await mockFetch(withLiterals);
-    });
-
-    it('throws if settings argument does not have `priceLiteralsURL` nor `priceLiteralsPromise` property', async () => {
-        // @ts-ignore
-        expect(fetchPriceLiterals({})).eventually.be.rejected;
-    });
-
-    it('returns literals from promise', async () => {
-        const priceLiteralsPromise = new Promise((resolve) =>
-            resolve([
-                {
-                    lang: 'en',
-                    recurrenceLabel:
-                        '{recurrenceTerm, select, MONTH {/mo} YEAR {/yr} other {}}',
-                },
-            ]),
-        );
+describe('function "getPriceLiterals"', () => {
+    it('returns literals', async () => {
+        const priceLiterals = await (readFile({ path: '../price-literals.json' }));
         // @ts-ignore
-        const literals = await fetchPriceLiterals({
+        const literals = await getPriceLiterals({
             language: 'en',
-            priceLiteralsPromise,
-        });
+        }, JSON.parse(priceLiterals));
         expect(literals.lang).to.equal(Defaults.language);
     });
 
     it('returns literals for default language if requested does not exist', async () => {
+      const priceLiterals = await (readFile({ path: '../price-literals.json' }));
         // @ts-ignore
-        const literals = await fetchPriceLiterals({
+        const literals = await getPriceLiterals({
             language: 'test',
-            priceLiteralsURL,
-        });
+        }, JSON.parse(priceLiterals));
         expect(literals.lang).to.equal(Defaults.language);
     });
 });
diff --git a/libs/features/mas/commerce/test/placeholder.test.js b/libs/features/mas/commerce/test/placeholder.test.js
@@ -14,7 +14,6 @@ import { mockLana, unmockLana } from './mocks/lana.js';
 import { expect } from './utilities.js';
 import { initService } from '../src/service.js';
 import { mockFetch } from './mocks/fetch.js';
-import { withLiterals } from './mocks/literals.js';
 
 let id = 1;
 /**
@@ -62,8 +61,7 @@ describe('custom span-based placeholder', () => {
         document.body.innerHTML = '';
     });
 
-    before(async () => {
-        await mockFetch(withLiterals);
+    before( () => {
         mockLana();
     });
 

diff --git a/libs/features/mas/commerce/test/price.test.js b/libs/features/mas/commerce/test/price.test.js
@@ -9,7 +9,6 @@ import { initService, resetService } from '../src/service.js';
 import { mockConfig } from './mocks/config.js';
 import { mockFetch } from './mocks/fetch.js';
 import { mockLana, unmockLana } from './mocks/lana.js';
-import { withLiterals } from './mocks/literals.js';
 import snapshots from './mocks/snapshots.js';
 import { withWcs } from './mocks/wcs.js';
 import { expect } from './utilities.js';
@@ -32,7 +31,7 @@ afterEach(() => {
 });
 
 beforeEach(async () => {
-    await mockFetch(withWcs, withLiterals);
+    await mockFetch(withWcs);
     mockLana();
 });
 

diff --git a/libs/features/mas/commerce/test/service.test.js b/libs/features/mas/commerce/test/service.test.js
@@ -1,3 +1,4 @@
+import { readFile } from '@web/test-runner-commands';
 import { delay } from '../src/external.js';
 import { TAG_NAME_SERVICE, Defaults, init, reset } from '../src/index.js';
 import { HTMLWcmsCommerceElement } from '../src//service.js';
@@ -8,11 +9,10 @@ import { mockIms, unmockIms } from './mocks/ims.js';
 import { expect } from './utilities.js';
 import { mockProviders } from './mocks/providers.js';
 import { withWcs } from './mocks/wcs.js';
-import { withLiterals } from './mocks/literals.js';
 
 describe('commerce service', () => {
     before(async () => {
-        await mockFetch(withWcs, withLiterals);
+        await mockFetch(withWcs);
     });
 
     afterEach(() => {
@@ -71,7 +71,11 @@ describe('commerce service', () => {
 
         describe('property "literals"', () => {
             it('returns "price literals" object', async () => {
-                const instance = await init(mockConfig());
+                const priceLiterals = await (readFile({ path: '../price-literals.json' }));
+                const commerce = {
+                  priceLiterals: JSON.parse(priceLiterals),
+                };
+                const instance = await init(mockConfig(commerce));
                 [
                     'alternativePriceAriaLabel',
                     'freeAriaLabel',

diff --git a/libs/features/mas/commerce/test/settings.test.js b/libs/features/mas/commerce/test/settings.test.js
@@ -27,8 +27,6 @@ describe('getSettings', () => {
         expect(getSettings()).to.deep.equal({
             ...Defaults,
             locale: `${Defaults.language}_${Defaults.country}`,
-            priceLiteralsURL: undefined,
-            priceLiteralsPromise: undefined,
             quantity: [Defaults.quantity],
         });
     });
@@ -76,8 +74,6 @@ describe('getSettings', () => {
           quantity: [2],
           wcsApiKey: 'testapikey',
           locale: "en_US",
-          priceLiteralsURL: undefined,
-          priceLiteralsPromise: undefined,
           env: "STAGE",
           wcsURL: WCS_STAGE_URL
       });
@@ -111,8 +107,6 @@ describe('getSettings', () => {
             env: Env.STAGE,
             language: 'nb',
             locale: 'nb_NO',
-            priceLiteralsURL: undefined,
-            priceLiteralsPromise: undefined,
             quantity: [Defaults.quantity],
             wcsApiKey,
             wcsURL: WCS_STAGE_URL,

diff --git a/libs/features/mas/mas/src/mas.js b/libs/features/mas/mas/src/mas.js
@@ -10,13 +10,9 @@ const isStage = searchParams.get('env') === 'stage';
 const envName = isStage ? 'stage' : 'prod';
 const commerceEnv = isStage ? 'STAGE' : 'PROD';
 
-const priceLiteralsPromise = fetch(
-    'https://www.adobe.com/federal/commerce/price-literals.json',
-).then((response) => response.json().then(({ data }) => data));
-
 const config = () => ({
     env: { name: envName },
-    commerce: { 'commerce.env': commerceEnv, priceLiteralsPromise },
+    commerce: { 'commerce.env': commerceEnv },
     locale: { prefix: locale },
 });
 

diff --git a/libs/features/mas/mocks/config.js b/libs/features/mas/mocks/config.js
@@ -1,5 +1,3 @@
-import { priceLiteralsURL } from './literals.js';
-
 export const mockConfig =
     (
         commerce = {},
@@ -11,7 +9,6 @@ export const mockConfig =
     ) =>
     () => ({
         commerce: {
-            priceLiteralsURL,
             ...commerce,
         },
         env,

diff --git a/libs/features/mas/mocks/literals.js b/libs/features/mas/mocks/literals.js