feat(utils): Fix big number decorator and cleanup (#6473)

**What**
- Fix big number decorator and cleanup

.changeset/fair-panthers-nail.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/utils": patch
+---
+
+feat(utils): Fix big number decorator and cleanup

packages/order/src/models/adjustment-line.ts

@@ -1,5 +1,5 @@
 import { BigNumberRawValue, DAL } from "@medusajs/types"
-import { BigNumber, BigNumberField } from "@medusajs/utils"
+import { BigNumber, MikroOrmBigNumberProperty } from "@medusajs/utils"
 import { OptionalProps, PrimaryKey, Property } from "@mikro-orm/core"
 
 type OptionalAdjustmentLineProps = DAL.EntityDateColumns
@@ -26,8 +26,7 @@ export default abstract class AdjustmentLine {
   @Property({ columnType: "text", nullable: true })
   code: string | null = null
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   amount: BigNumber | number
 
   @Property({ columnType: "jsonb" })

packages/order/src/models/line-item.ts

@@ -1,9 +1,9 @@
 import { BigNumberRawValue, DAL } from "@medusajs/types"
 import {
   BigNumber,
-  BigNumberField,
   createPsqlIndexStatementHelper,
   generateEntityId,
+  MikroOrmBigNumberProperty,
 } from "@medusajs/utils"
 import {
   BeforeCreate,
@@ -11,8 +11,8 @@ import {
   Collection,
   Entity,
   ManyToOne,
-  OnInit,
   OneToMany,
+  OnInit,
   OptionalProps,
   PrimaryKey,
   Property,
@@ -114,15 +114,17 @@ export default class LineItem {
   @Property({ columnType: "boolean" })
   is_tax_inclusive = false
 
-  @Property({ columnType: "numeric", nullable: true })
+  @MikroOrmBigNumberProperty({
-  @BigNumberField({ nullable: true })
+    nullable: true,
+  })
   compare_at_unit_price?: BigNumber | number | null = null
 
   @Property({ columnType: "jsonb", nullable: true })
   raw_compare_at_unit_price: BigNumberRawValue | null = null
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty({
-  @BigNumberField()
+    nullable: true,
+  })
   unit_price: BigNumber | number
 
   @Property({ columnType: "jsonb" })

packages/order/src/models/order-detail.ts

@@ -1,9 +1,9 @@
 import { BigNumberRawValue, DAL } from "@medusajs/types"
 import {
   BigNumber,
-  BigNumberField,
   createPsqlIndexStatementHelper,
   generateEntityId,
+  MikroOrmBigNumberProperty,
 } from "@medusajs/utils"
 import {
   BeforeCreate,
@@ -57,50 +57,43 @@ export default class OrderDetail {
   })
   item: LineItem
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })
   raw_quantity: BigNumberRawValue
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   fulfilled_quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })
   raw_fulfilled_quantity: BigNumberRawValue
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   shipped_quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })
   raw_shipped_quantity: BigNumberRawValue
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   return_requested_quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })
   raw_return_requested_quantity: BigNumberRawValue
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   return_received_quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })
   raw_return_received_quantity: BigNumberRawValue
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   return_dismissed_quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })
   raw_return_dismissed_quantity: BigNumberRawValue
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   written_off_quantity: BigNumber | number
 
   @Property({ columnType: "jsonb" })

packages/order/src/models/shipping-method.ts

@@ -1,9 +1,9 @@
 import { BigNumberRawValue } from "@medusajs/types"
 import {
   BigNumber,
-  BigNumberField,
   createPsqlIndexStatementHelper,
   generateEntityId,
+  MikroOrmBigNumberProperty,
 } from "@medusajs/utils"
 import {
   BeforeCreate,
@@ -12,8 +12,8 @@ import {
   Collection,
   Entity,
   ManyToOne,
-  OnInit,
   OneToMany,
+  OnInit,
   PrimaryKey,
   Property,
 } from "@mikro-orm/core"
@@ -54,8 +54,7 @@ export default class ShippingMethod {
   @Property({ columnType: "jsonb", nullable: true })
   description: string | null = null
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   amount: BigNumber | number
 
   @Property({ columnType: "jsonb" })

packages/order/src/models/tax-line.ts

@@ -1,5 +1,5 @@
 import { BigNumberRawValue } from "@medusajs/types"
-import { BigNumber, BigNumberField } from "@medusajs/utils"
+import {BigNumber, MikroOrmBigNumberProperty} from "@medusajs/utils"
 import { PrimaryKey, Property } from "@mikro-orm/core"
 
 /**
@@ -22,8 +22,7 @@ export default abstract class TaxLine {
   @Property({ columnType: "text" })
   code: string
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   rate: BigNumber | number
 
   @Property({ columnType: "jsonb" })

packages/order/src/models/transaction.ts

@@ -1,9 +1,9 @@
 import { BigNumberRawValue, DAL } from "@medusajs/types"
 import {
   BigNumber,
-  BigNumberField,
   createPsqlIndexStatementHelper,
   generateEntityId,
+  MikroOrmBigNumberProperty,
 } from "@medusajs/utils"
 import {
   BeforeCreate,
@@ -52,8 +52,7 @@ export default class Transaction {
   })
   order: Order
 
-  @Property({ columnType: "numeric" })
+  @MikroOrmBigNumberProperty()
-  @BigNumberField()
   amount: BigNumber | number
 
   @Property({ columnType: "jsonb" })

packages/payment/integration-tests/__tests__/services/payment-module/index.spec.ts

@@ -1,45 +1,34 @@
 import { IPaymentModuleService } from "@medusajs/types"
-import { initModules } from "medusa-test-utils"
 import { Modules } from "@medusajs/modules-sdk"
 
-import { MikroOrmWrapper } from "../../../utils"
 import {
   createPaymentCollections,
-  createPaymentSessions,
   createPayments,
+  createPaymentSessions,
 } from "../../../__fixtures__"
-import { getInitModuleConfig } from "../../../utils/get-init-module-config"
+import {
+  moduleIntegrationTestRunner,
+  SuiteOptions,
+} from "medusa-test-utils/dist"
 
 jest.setTimeout(30000)
 
+moduleIntegrationTestRunner({
+  moduleName: Modules.PAYMENT,
+  testSuite: ({
+    MikroOrmWrapper,
+    service,
+  }: SuiteOptions<IPaymentModuleService>) => {
     describe("Payment Module Service", () => {
       describe("Payment Flow", () => {
-    let service: IPaymentModuleService
-    let shutdownFunc: () => Promise<void>
-
-    afterAll(async () => {
-      await shutdownFunc()
-    })
-
         beforeEach(async () => {
-      await MikroOrmWrapper.setupDatabase()
+          const repositoryManager = MikroOrmWrapper.forkManager()
-      const repositoryManager = await MikroOrmWrapper.forkManager()
-
-      const initModulesConfig = getInitModuleConfig()
-      const { medusaApp, shutdown } = await initModules(initModulesConfig)
-      service = medusaApp.modules[Modules.PAYMENT]
-
-      shutdownFunc = shutdown
 
           await createPaymentCollections(repositoryManager)
           await createPaymentSessions(repositoryManager)
           await createPayments(repositoryManager)
         })
 
-    afterEach(async () => {
-      await MikroOrmWrapper.clearDatabase()
-      await shutdownFunc()
-    })
         it("complete payment flow successfully", async () => {
           let paymentCollection = await service.createPaymentCollections({
             currency_code: "USD",
@@ -121,33 +110,14 @@ describe("Payment Module Service", () => {
       })
 
       describe("PaymentCollection", () => {
-    let service: IPaymentModuleService
-    let shutdownFunc: () => Promise<void>
-
-    afterAll(async () => {
-      await shutdownFunc()
-    })
-
         beforeEach(async () => {
-      await MikroOrmWrapper.setupDatabase()
           const repositoryManager = await MikroOrmWrapper.forkManager()
 
-      const initModulesConfig = getInitModuleConfig()
-      const { medusaApp, shutdown } = await initModules(initModulesConfig)
-      service = medusaApp.modules[Modules.PAYMENT]
-
-      shutdownFunc = shutdown
-
           await createPaymentCollections(repositoryManager)
           await createPaymentSessions(repositoryManager)
           await createPayments(repositoryManager)
         })
 
-    afterEach(async () => {
-      await MikroOrmWrapper.clearDatabase()
-      await shutdownFunc()
-    })
-
         describe("create", () => {
           it("should throw an error when required params are not passed", async () => {
             let error = await service
@@ -230,7 +200,9 @@ describe("Payment Module Service", () => {
 
         describe("retrieve", () => {
           it("should retrieve a Payment Collection", async () => {
-        let collection = await service.retrievePaymentCollection("pay-col-id-2")
+            let collection = await service.retrievePaymentCollection(
+              "pay-col-id-2"
+            )
 
             expect(collection).toEqual(
               expect.objectContaining({
@@ -352,33 +324,14 @@ describe("Payment Module Service", () => {
       })
 
       describe("PaymentSession", () => {
-    let service: IPaymentModuleService
-    let shutdownFunc: () => Promise<void>
-
-    afterAll(async () => {
-      await shutdownFunc()
-    })
-
         beforeEach(async () => {
-      await MikroOrmWrapper.setupDatabase()
           const repositoryManager = await MikroOrmWrapper.forkManager()
 
-      const initModulesConfig = getInitModuleConfig()
-      const { medusaApp, shutdown } = await initModules(initModulesConfig)
-      service = medusaApp.modules[Modules.PAYMENT]
-
-      shutdownFunc = shutdown
-
           await createPaymentCollections(repositoryManager)
           await createPaymentSessions(repositoryManager)
           await createPayments(repositoryManager)
         })
 
-    afterEach(async () => {
-      await MikroOrmWrapper.clearDatabase()
-      await shutdownFunc()
-    })
-
         describe("create", () => {
           it("should create a payment session successfully", async () => {
             await service.createPaymentSession("pay-col-id-1", {
@@ -483,7 +436,10 @@ describe("Payment Module Service", () => {
               },
             })
 
-        const payment = await service.authorizePaymentSession(session.id, {})
+            const payment = await service.authorizePaymentSession(
+              session.id,
+              {}
+            )
 
             expect(payment).toEqual(
               expect.objectContaining({
@@ -510,6 +466,7 @@ describe("Payment Module Service", () => {
                   id: expect.any(String),
                   currency_code: "usd",
                   amount: 100,
+                  raw_amount: { value: "100.00000000000000000", precision: 20 },
                   provider_id: "system",
                   data: {},
                   status: "authorized",
@@ -541,33 +498,14 @@ describe("Payment Module Service", () => {
       })
 
       describe("Payment", () => {
-    let service: IPaymentModuleService
-    let shutdownFunc: () => Promise<void>
-
-    afterAll(async () => {
-      await shutdownFunc()
-    })
-
         beforeEach(async () => {
-      await MikroOrmWrapper.setupDatabase()
           const repositoryManager = await MikroOrmWrapper.forkManager()
 
-      const initModulesConfig = getInitModuleConfig()
-      const { medusaApp, shutdown } = await initModules(initModulesConfig)
-      service = medusaApp.modules[Modules.PAYMENT]
-
-      shutdownFunc = shutdown
-
           await createPaymentCollections(repositoryManager)
           await createPaymentSessions(repositoryManager)
           await createPayments(repositoryManager)
         })
 
-    afterEach(async () => {
-      await MikroOrmWrapper.clearDatabase()
-      await shutdownFunc()
-    })
-
         describe("update", () => {
           it("should update a payment successfully", async () => {
             const updatedPayment = await service.updatePayment({
@@ -733,3 +671,5 @@ describe("Payment Module Service", () => {
         })
       })
     })
+  },
+})

packages/payment/src/models/payment-session.ts

@@ -9,7 +9,13 @@ import {
   PrimaryKey,
   Property,
 } from "@mikro-orm/core"
-import { generateEntityId, PaymentSessionStatus } from "@medusajs/utils"
+import {
+  BigNumber,
+  generateEntityId,
+  MikroOrmBigNumberProperty,
+  PaymentSessionStatus,
+} from "@medusajs/utils"
+import { BigNumberRawValue } from "@medusajs/types"
 
 import PaymentCollection from "./payment-collection"
 import Payment from "./payment"
@@ -24,11 +30,13 @@ export default class PaymentSession {
   @Property({ columnType: "text" })
   currency_code: string
 
+  @MikroOrmBigNumberProperty()
+  amount: BigNumber | number
+
   @Property({
-    columnType: "numeric",
+    columnType: "jsonb",
-    serializer: Number,
   })
-  amount: number
+  raw_amount: BigNumberRawValue
 
   @Property({ columnType: "text" })
   provider_id: string

packages/utils/jest.config.js

@@ -3,7 +3,7 @@ module.exports = {
     "^.+\\.[jt]s?$": [
       "ts-jest",
       {
-        tsConfig: "tsconfig.json",
+        tsConfig: "tsconfig.spec.json",
         isolatedModules: true,
       },
     ],

packages/utils/src/dal/mikro-orm/__tests__/big-number-field.spec.ts

@@ -0,0 +1,47 @@
+import { MikroOrmBigNumberProperty } from "../big-number-field"
+import { BigNumberRawValue } from "@medusajs/types"
+import { BigNumber } from "../../../totals/big-number"
+
+describe("@MikroOrmBigNumberProperty", () => {
+  it("should correctly assign and update BigNumber values", () => {
+    class TestAmount {
+      @MikroOrmBigNumberProperty()
+      amount: BigNumber | number
+
+      raw_amount: BigNumberRawValue
+    }
+
+    const testAmount = new TestAmount()
+
+    expect(testAmount.amount).toBeUndefined()
+    expect(testAmount.raw_amount).toBeUndefined()
+
+    testAmount.amount = 100
+
+    expect(testAmount.amount).toEqual(100)
+    expect((testAmount as any).amount_).toEqual(100)
+    expect(testAmount.raw_amount).toEqual({
+      value: "100.00000000000000000",
+      precision: 20,
+    })
+
+    // Update the amount
+
+    testAmount.amount = 200
+
+    expect(testAmount.amount).toEqual(200)
+    expect((testAmount as any).amount_).toEqual(200)
+    expect(testAmount.raw_amount).toEqual({
+      value: "200.00000000000000000",
+      precision: 20,
+    })
+
+    // Update with big number
+
+    testAmount.amount = new BigNumber(300, { precision: 5 })
+
+    expect(testAmount.amount).toEqual(300)
+    expect((testAmount as any).amount_).toEqual(300)
+    expect(testAmount.raw_amount).toEqual({ value: "300.00", precision: 5 })
+  })
+})

packages/utils/src/dal/mikro-orm/big-number-field.ts

@@ -1,78 +1,54 @@
 import { BigNumber } from "../../totals/big-number"
+import { Property } from "@mikro-orm/core"
+import { BigNumberInput } from "@medusajs/types"
 
-const bigNumberFields = new WeakMap<
+export function MikroOrmBigNumberProperty(
-  object,
+  options: Parameters<typeof Property>[0] & {
-  { prop: string; options: { nullable?: boolean } }[]
+    rawColumnName?: string
->()
+  } = {}
+) {
+  return function (target: any, columnName: string) {
+    const targetColumn = columnName + "_"
+    const rawColumnName = options.rawColumnName ?? `raw_${columnName}`
 
-export function BigNumberField(options: { nullable?: boolean } = {}) {
+    Object.defineProperty(target, columnName, {
-  return function (target: any, prop: string) {
+      get() {
-    const entity = target.constructor
+        return this[targetColumn]
-    if (!bigNumberFields.has(entity)) {
+      },
-      bigNumberFields.set(entity, [])
+      set(value: BigNumberInput) {
+        let bigNumber: BigNumber
+        if (value instanceof BigNumber) {
+          bigNumber = value
+        } else if (this[rawColumnName]) {
+          const precision = this[rawColumnName].precision
+          this[rawColumnName].value = new BigNumber(value, {
+            precision,
+          }).raw!.value
+          bigNumber = new BigNumber(this[rawColumnName])
+        } else {
+          bigNumber = new BigNumber(value)
         }
 
-    if (prop.startsWith("raw_")) {
+        this[targetColumn] = bigNumber.numeric
-      const suggestedPropName = prop.replace("raw_", "")
+        this[rawColumnName] = bigNumber.raw
-      throw new Error(
+      },
-        `BigNumberField decorator has to be used on the property "${suggestedPropName}" and ${prop} typed as BigNumberRawValue.`
+    })
-      )
-    }
 
-    bigNumberFields.get(entity)?.push({ prop, options })
+    Property({
+      type: "number",
+      columnType: "numeric",
+      fieldName: columnName,
+      serializer: () => {
+        return undefined
+      },
+      ...options,
+    })(target, targetColumn)
 
-    if (!entity.prototype.__bigNumberInitialized) {
+    Property({
-      entity.prototype.__bigNumberInitialized = true
+      type: "number",
-
+      persist: false,
-      registerGlobalHook(entity)
+      getter: true,
-    }
+      setter: true,
-  }
+    })(target, columnName)
-}
-
-function registerGlobalHook(entity: any) {
-  const originalOnInit = entity.prototype.onInit
-  const originalOnCreate = entity.prototype.onCreate
-  const originalOnUpdate = entity.prototype.onUpdate
-
-  entity.prototype.onInit = function (...args: any[]) {
-    initializeBigNumberFields(this)
-
-    if (originalOnInit) {
-      originalOnInit.apply(this, args)
-    }
-  }
-
-  entity.prototype.onCreate = function (...args: any[]) {
-    initializeBigNumberFields(this)
-
-    if (originalOnCreate) {
-      originalOnCreate.apply(this, args)
-    }
-  }
-
-  entity.prototype.onUpdate = function (...args: any[]) {
-    initializeBigNumberFields(this)
-
-    if (originalOnUpdate) {
-      originalOnUpdate.apply(this, args)
-    }
-  }
-}
-
-function initializeBigNumberFields(entity: any) {
-  const fields = bigNumberFields.get(entity.constructor) ?? []
-
-  for (const field of fields) {
-    const { prop, options } = field
-
-    const rawValue = entity[`raw_${prop}`]
-    const value = entity[prop]
-    if (options.nullable && rawValue === null && value === null) {
-      return
-    }
-
-    const val = new BigNumber(rawValue ?? value)
-    entity[prop] = val.numeric
-    entity[`raw_${prop}`] = val.raw
   }
 }

packages/utils/src/totals/big-number.ts

@@ -8,11 +8,16 @@ export class BigNumber {
   private numeric_: number
   private raw_?: BigNumberRawValue
 
-  constructor(rawPrice: BigNumberInput) {
+  constructor(rawPrice: BigNumberInput, options?: { precision?: number }) {
-    this.setRawPriceOrThrow(rawPrice)
+    this.setRawPriceOrThrow(rawPrice, options)
   }
 
-  setRawPriceOrThrow(rawPrice: BigNumberInput) {
+  setRawPriceOrThrow(
+    rawPrice: BigNumberInput,
+    { precision }: { precision?: number } = {}
+  ) {
+    precision ??= BigNumber.DEFAULT_PRECISION
+
     if (BigNumberJS.isBigNumber(rawPrice)) {
       /**
        * Example:
@@ -21,7 +26,8 @@ export class BigNumber {
        */
       this.numeric_ = rawPrice.toNumber()
       this.raw_ = {
-        value: rawPrice.toPrecision(BigNumber.DEFAULT_PRECISION),
+        value: rawPrice.toPrecision(precision),
+        precision,
       }
     } else if (isString(rawPrice)) {
       /**
@@ -31,7 +37,8 @@ export class BigNumber {
 
       this.numeric_ = bigNum.toNumber()
       this.raw_ = this.raw_ = {
-        value: bigNum.toPrecision(BigNumber.DEFAULT_PRECISION),
+        value: bigNum.toPrecision(precision),
+        precision,
       }
     } else if (isBigNumber(rawPrice)) {
       /**
@@ -41,6 +48,7 @@ export class BigNumber {
 
       this.raw_ = {
         ...rawPrice,
+        precision,
       }
     } else if (typeof rawPrice === `number` && !Number.isNaN(rawPrice)) {
       /**
@@ -49,7 +57,8 @@ export class BigNumber {
       this.numeric_ = rawPrice as number
 
       this.raw_ = {
-        value: BigNumberJS(rawPrice as number).toString(),
+        value: BigNumberJS(rawPrice as number).toPrecision(precision),
+        precision,
       }
     } else {
       throw new Error(

packages/utils/tsconfig.spec.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"],
+  "compilerOptions": {
+    "sourceMap": true
+  }
+}