fix(currency,payment,pricing,region,order,store,cart,core-flows,medusa,utils): repo wide currency_code normalization (#13975)

* Unified utility normalizeCurrencyCode function

* Use new utility function to replace current isolated currency code normalization

* Update arg type

* Add missing currency code normalization in pricing module

* New util function tests

* Update previous pricing module tests to include lowercased currency codes

* Add changeset

* Update arg type and throw if something else is provided

* Migration script v1

* Include in transaction for compensation

* Remove unnecessary workflow, execute knex directly inside script

* Review fixes

* Add missing currency_code normalization to modules

* Avoid overriding currency_code when not provided

* Update tests

* Updated changeset

* Update script to normalize all potentially affected tables

* Keep one changeset

* Update tests

* Update test

* Migration to normalize prices ingested by index module

Author: NicolasGorga

.changeset/free-rings-happen.md

@@ -0,0 +1,14 @@
+---
+"@medusajs/currency": patch
+"@medusajs/core-flows": patch
+"@medusajs/payment": patch
+"@medusajs/pricing": patch
+"@medusajs/region": patch
+"@medusajs/order": patch
+"@medusajs/store": patch
+"@medusajs/cart": patch
+"@medusajs/utils": patch
+"@medusajs/medusa": patch
+---
+
+fix(currency,payment,pricing,region,order,store,cart,core-flows,medusa,utils): repo wide currency_code normalization

integration-tests/modules/__tests__/index/query-index.spec.ts

@@ -270,12 +270,12 @@ medusaIntegrationTestRunner({
                 ],
                 prices: expect.arrayContaining([
                   {
-                    currency_code: "CAD",
+                    currency_code: "cad",
                     amount: 20,
                     id: expect.any(String),
                   },
                   {
-                    currency_code: "USD",
+                    currency_code: "usd",
                     amount: 80,
                     id: expect.any(String),
                   },
@@ -294,12 +294,12 @@ medusaIntegrationTestRunner({
                 prices: expect.arrayContaining([
                   {
                     amount: 20,
-                    currency_code: "CAD",
+                    currency_code: "cad",
                     id: expect.any(String),
                   },
                   {
                     amount: 80,
-                    currency_code: "USD",
+                    currency_code: "usd",
                     id: expect.any(String),
                   },
                 ]),
@@ -337,12 +337,12 @@ medusaIntegrationTestRunner({
                 prices: expect.arrayContaining([
                   {
                     amount: 30,
-                    currency_code: "USD",
+                    currency_code: "usd",
                     id: expect.any(String),
                   },
                   {
                     amount: 50,
-                    currency_code: "EUR",
+                    currency_code: "eur",
                     id: expect.any(String),
                   },
                 ]),
@@ -400,7 +400,7 @@ medusaIntegrationTestRunner({
                 "variants.prices.currency_code",
               ],
               filters: {
-                "variants.prices.currency_code": "USD",
+                "variants.prices.currency_code": "usd",
               },
               pagination: {
                 take: 1,
@@ -422,12 +422,12 @@ medusaIntegrationTestRunner({
                 prices: expect.arrayContaining([
                   {
                     amount: 20,
-                    currency_code: "CAD",
+                    currency_code: "cad",
                     id: expect.any(String),
                   },
                   {
                     amount: 80,
-                    currency_code: "USD",
+                    currency_code: "usd",
                     id: expect.any(String),
                   },
                 ]),
@@ -448,7 +448,7 @@ medusaIntegrationTestRunner({
               filters: {
                 variants: {
                   prices: {
-                    currency_code: "USD",
+                    currency_code: "usd",
                   },
                 },
               },
@@ -476,12 +476,12 @@ medusaIntegrationTestRunner({
                 prices: expect.arrayContaining([
                   {
                     amount: 30,
-                    currency_code: "USD",
+                    currency_code: "usd",
                     id: expect.any(String),
                   },
                   {
                     amount: 50,
-                    currency_code: "EUR",
+                    currency_code: "eur",
                     id: expect.any(String),
                   },
                 ]),

integration-tests/modules/__tests__/index/search.spec.ts

@@ -150,7 +150,7 @@ medusaIntegrationTestRunner({
                   variants: {
                     prices: {
                       amount: { $gt: 50 },
-                      currency_code: { $eq: "AUD" },
+                      currency_code: { $eq: "aud" },
                     },
                   },
                 },
@@ -179,7 +179,7 @@ medusaIntegrationTestRunner({
         for (const variant of variants) {
           expect(variant.prices.length).toBe(1)
           expect(variant.prices[0].amount).toBeGreaterThan(50)
-          expect(variant.prices[0].currency_code).toBe("AUD")
+          expect(variant.prices[0].currency_code).toBe("aud")
         }
       })
 

packages/core/core-flows/src/product/helpers/normalize-for-import.ts

@@ -1,6 +1,6 @@
 import type { ProductTypes } from "@medusajs/framework/types"
 import type { HttpTypes, RegionTypes } from "@medusajs/framework/types"
-import { MedusaError, lowerCaseFirst } from "@medusajs/framework/utils"
+import { MedusaError, lowerCaseFirst, normalizeCurrencyCode } from "@medusajs/framework/utils"
 
 // We want to convert the csv data format to a standard DTO format.
 export const normalizeForImport = (
@@ -183,7 +183,7 @@ const normalizeVariantForImport = (
       if (!priceKey.endsWith("]")) {
         response["prices"] = [
           ...(response["prices"] || []),
-          { currency_code: priceKey.toLowerCase(), amount: normalizedValue },
+          { currency_code: normalizeCurrencyCode(priceKey), amount: normalizedValue },
         ]
       } else {
         const regionName = priceKey.split("_").slice(0, -1).join(" ")

packages/core/utils/src/common/__tests__/normalize-currency-code.spec.ts

@@ -0,0 +1,21 @@
+import { normalizeCurrencyCode } from "../normalize-currency-code"
+
+describe("normalizeCurrencyCode", () => {
+  it("returns lowercased currency code", () => {
+    const uppercased = "USD"
+    const result = normalizeCurrencyCode(uppercased)
+
+    expect(result).toEqual("usd")
+  })
+
+  it("throws when value is not a string", () => {
+    const errorMessage = "Currency code needs to be a string"
+
+    expect(() => {
+      normalizeCurrencyCode(1 as unknown as string)
+    }).toThrow(errorMessage)
+    expect(() => {
+      normalizeCurrencyCode(undefined as unknown as string)
+    }).toThrow(errorMessage)
+  })
+})

packages/core/utils/src/common/index.ts

@@ -53,6 +53,7 @@ export * from "./medusa-container"
 export * from "./merge-metadata"
 export * from "./merge-plugin-modules"
 export * from "./normalize-csv-value"
+export * from "./normalize-currency-code"
 export * from "./normalize-import-path-with-source"
 export * from "./normalize-locale"
 export * from "./object-from-string-path"

packages/core/utils/src/common/normalize-currency-code.ts

@@ -0,0 +1,13 @@
+import { MedusaError, MedusaErrorTypes } from "./errors"
+import { isString } from "./is-string"
+
+/**
+ * Normalizes `currencyCode` by transforming it to lowercase
+ */
+export function normalizeCurrencyCode(currencyCode: string) {
+    if (!isString(currencyCode)) {
+        throw new MedusaError(MedusaErrorTypes.INVALID_ARGUMENT, "Currency code needs to be a string")
+    }
+
+    return currencyCode.toLowerCase()
+}

packages/medusa/src/migration-scripts/migrate-normalize-currency-codes-normalization.ts

@@ -0,0 +1,38 @@
+import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
+import { ExecArgs } from "@medusajs/types"
+
+export default async function migrateNormalizeCurrencyCodes({
+  container,
+}: ExecArgs) {
+  const knex = container.resolve(ContainerRegistrationKeys.PG_CONNECTION)
+
+  await knex.transaction(async (trx) => {
+    const tables = [
+      "cart",
+      "payment_collection",
+      "payment_session",
+      "payment",
+      "order",
+      "order_transaction",
+      "price",
+      "region",
+      "store_currency",
+    ]
+
+    for (const table of tables) {
+      await trx(table)
+        .whereNotNull("currency_code")
+        .update({
+          currency_code: knex.raw("LOWER(currency_code)"),
+        })
+    }
+
+    await trx.raw(`
+      UPDATE index_data
+      SET data = jsonb_set(data, '{currency_code}', to_jsonb(LOWER(data->>'currency_code')))
+      WHERE name = 'Price'
+        AND data->>'currency_code' IS NOT NULL
+        AND data->>'currency_code' <> LOWER(data->>'currency_code')
+    `)
+  })
+}

packages/modules/cart/src/services/cart-module.ts

@@ -23,6 +23,7 @@ import {
   MedusaError,
   ModulesSdkUtils,
   promiseAll,
+  normalizeCurrencyCode,
 } from "@medusajs/framework/utils"
 import {
   Address,
@@ -297,7 +298,13 @@ export default class CartModuleService
     const cartsWithItems = data.map(({ items, ...cart }) => {
       const cartId = generateEntityId((cart as any).id, "cart")
       return {
-        cart: { ...cart, id: cartId },
+        cart: {
+          ...cart,
+          currency_code: cart.currency_code
+            ? normalizeCurrencyCode(cart.currency_code)
+            : cart.currency_code,
+          id: cartId,
+        },
         items: items || [],
       }
     })
@@ -395,10 +402,18 @@ export default class CartModuleService
         {
           id: dataOrIdOrSelector,
           ...data,
+          ...(data?.currency_code
+            ? { currency_code: normalizeCurrencyCode(data.currency_code) }
+            : {}),
         },
       ]
     } else if (Array.isArray(dataOrIdOrSelector)) {
-      toUpdate = dataOrIdOrSelector
+      toUpdate = dataOrIdOrSelector.map((d) => ({
+        ...d,
+        ...(d.currency_code
+          ? { currency_code: normalizeCurrencyCode(d.currency_code) }
+          : {}),
+      }))
     } else {
       const carts = await this.cartService_.list(
         { ...dataOrIdOrSelector },
@@ -410,6 +425,9 @@ export default class CartModuleService
         return {
           ...data,
           id: cart.id,
+          ...(data?.currency_code
+            ? { currency_code: normalizeCurrencyCode(data.currency_code) }
+            : {}),
         }
       })
     }

packages/modules/currency/src/services/currency-module-service.ts

@@ -10,7 +10,7 @@ import {
   ModulesSdkTypes,
 } from "@medusajs/framework/types"
 
-import { MedusaService } from "@medusajs/framework/utils"
+import { MedusaService, normalizeCurrencyCode } from "@medusajs/framework/utils"
 import { Currency } from "@models"
 
 type InjectedDependencies = {
@@ -86,7 +86,7 @@ export default class CurrencyModuleService
       FilterableCurrencyProps
     >(filters, (fieldName, value) => {
       if (fieldName === "code" && !!value) {
-        return value.toLowerCase()
+        return normalizeCurrencyCode(value)
       }
 
       return value