feat(pricing, types, utils): Soft delete pricing entities

.changeset/fuzzy-ears-look.md

@@ -0,0 +1,8 @@
+---
+"@medusajs/pricing": patch
+"@medusajs/types": patch
+"@medusajs/utils": patch
+---
+
+feat(pricing, types): add soft deletion for money-amounts
+feat(utils): cascade soft delete across 1:1 relationships

packages/pricing/integration-tests/__tests__/services/pricing-module/money-amount.spec.ts

@@ -6,6 +6,11 @@ import { initialize } from "../../../../src"
 import { createCurrencies } from "../../../__fixtures__/currency"
 import { createMoneyAmounts } from "../../../__fixtures__/money-amount"
 import { DB_URL, MikroOrmWrapper } from "../../../utils"
+import { createPriceSetMoneyAmounts } from "../../../__fixtures__/price-set-money-amount"
+import { createPriceSets } from "../../../__fixtures__/price-set"
+import { createRuleTypes } from "../../../__fixtures__/rule-type"
+import { createPriceRules } from "../../../__fixtures__/price-rule"
+import { createPriceSetMoneyAmountRules } from "../../../__fixtures__/price-set-money-amount-rules"
 
 jest.setTimeout(30000)
 
@@ -264,6 +269,94 @@ describe("PricingModule Service - MoneyAmount", () => {
     })
   })
 
+  describe("softDeleteMoneyAmounts", () => {
+    const id = "money-amount-USD"
+
+    it("should softDelete priceSetMoneyAmount and PriceRule when soft-deleting money amount", async () => {
+      await createPriceSets(testManager)
+      await createRuleTypes(testManager)
+      await createPriceSetMoneyAmounts(testManager)
+      await createPriceRules(testManager)
+      await createPriceSetMoneyAmountRules(testManager)
+      await service.softDeleteMoneyAmounts([id])
+
+      const [moneyAmount] = await service.listMoneyAmounts(
+        {
+          id: [id],
+        },
+        {
+          relations: [
+            "price_set_money_amount",
+            "price_set_money_amount.price_rules",
+          ],
+          withDeleted: true,
+        }
+      )
+
+      expect(moneyAmount).toBeTruthy()
+
+      const deletedAt = moneyAmount.deleted_at
+
+      expect(moneyAmount).toEqual(
+        expect.objectContaining({
+          deleted_at: deletedAt,
+          price_set_money_amount: expect.objectContaining({
+            deleted_at: deletedAt,
+            price_rules: [
+              expect.objectContaining({
+                deleted_at: deletedAt,
+              }),
+            ],
+          }),
+        })
+      )
+    })
+  })
+
+  describe("restoreDeletedMoneyAmounts", () => {
+    const id = "money-amount-USD"
+
+    it("should restore softDeleted priceSetMoneyAmount and PriceRule when restoring soft-deleting money amount", async () => {
+      await createPriceSets(testManager)
+      await createRuleTypes(testManager)
+      await createPriceSetMoneyAmounts(testManager)
+      await createPriceRules(testManager)
+      await createPriceSetMoneyAmountRules(testManager)
+      await service.softDeleteMoneyAmounts([id])
+      await service.restoreDeletedMoneyAmounts([id])
+
+      const [moneyAmount] = await service.listMoneyAmounts(
+        {
+          id: [id],
+        },
+        {
+          relations: [
+            "price_set_money_amount",
+            "price_set_money_amount.price_rules",
+          ],
+        }
+      )
+
+      expect(moneyAmount).toBeTruthy()
+
+      const deletedAt = null
+
+      expect(moneyAmount).toEqual(
+        expect.objectContaining({
+          deleted_at: deletedAt,
+          price_set_money_amount: expect.objectContaining({
+            deleted_at: deletedAt,
+            price_rules: [
+              expect.objectContaining({
+                deleted_at: deletedAt,
+              }),
+            ],
+          }),
+        })
+      )
+    })
+  })
+
   describe("updateMoneyAmounts", () => {
     const id = "money-amount-USD"
 

packages/pricing/src/migrations/.snapshot-medusa-pricing.json

@@ -390,6 +390,38 @@
           "primary": false,
           "nullable": true,
           "mappedType": "text"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
         }
       },
       "name": "price_set_money_amount",
@@ -423,6 +455,15 @@
           "primary": false,
           "unique": false
         },
+        {
+          "columnNames": [
+            "deleted_at"
+          ],
+          "composite": false,
+          "keyName": "IDX_price_set_money_amount_deleted_at",
+          "primary": false,
+          "unique": false
+        },
         {
           "keyName": "price_set_money_amount_pkey",
           "columnNames": ["id"],
@@ -750,6 +791,38 @@
           "primary": false,
           "nullable": false,
           "mappedType": "text"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
         }
       },
       "name": "price_rule",
@@ -776,6 +849,15 @@
           "primary": false,
           "unique": false
         },
+        {
+          "columnNames": [
+            "deleted_at"
+          ],
+          "composite": false,
+          "keyName": "IDX_price_rule_deleted_at",
+          "primary": false,
+          "unique": false
+        },
         {
           "keyName": "price_rule_pkey",
           "columnNames": ["id"],

packages/pricing/src/migrations/Migration20231212134238.ts

@@ -0,0 +1,37 @@
+import { Migration } from "@mikro-orm/migrations"
+
+export class Migration20231212134238 extends Migration {
+  async up(): Promise<void> {
+    this.addSql(
+      'alter table "price_set_money_amount" add column if not exists "created_at" timestamptz not null default now(), add column if not exists "updated_at" timestamptz not null default now(), add column if not exists "deleted_at" timestamptz null;'
+    )
+    this.addSql(
+      'create index if not exists "IDX_price_set_money_amount_deleted_at" on "price_set_money_amount" ("deleted_at");'
+    )
+
+    this.addSql(
+      'alter table "price_rule" add column if not exists "created_at" timestamptz not null default now(), add column if not exists "updated_at" timestamptz not null default now(), add column if not exists "deleted_at" timestamptz null;'
+    )
+    this.addSql(
+      'create index if not exists "IDX_price_rule_deleted_at" on "price_rule" ("deleted_at");'
+    )
+  }
+
+  async down(): Promise<void> {
+    this.addSql('drop index if exists "IDX_price_set_money_amount_deleted_at";')
+    this.addSql(
+      'alter table "price_set_money_amount" drop column if exists "created_at";'
+    )
+    this.addSql(
+      'alter table "price_set_money_amount" drop column if exists "updated_at";'
+    )
+    this.addSql(
+      'alter table "price_set_money_amount" drop column if exists "deleted_at";'
+    )
+
+    this.addSql('drop index if exists "IDX_price_rule_deleted_at";')
+    this.addSql('alter table "price_rule" drop column if exists "created_at";')
+    this.addSql('alter table "price_rule" drop column if exists "updated_at";')
+    this.addSql('alter table "price_rule" drop column if exists "deleted_at";')
+  }
+}

packages/pricing/src/models/money-amount.ts

@@ -1,8 +1,9 @@
-import { generateEntityId } from "@medusajs/utils"
+import { DALUtils, generateEntityId } from "@medusajs/utils"
 import {
   BeforeCreate,
   Collection,
   Entity,
+  Filter,
   Index,
   ManyToMany,
   ManyToOne,
@@ -17,6 +18,7 @@ import { PriceSetMoneyAmount } from "./index"
 import PriceSet from "./price-set"
 
 @Entity()
+@Filter(DALUtils.mikroOrmSoftDeletableFilterOptions)
 class MoneyAmount {
   [OptionalProps]?:
     | "created_at"
@@ -39,6 +41,7 @@ class MoneyAmount {
   @OneToOne({
     entity: () => PriceSetMoneyAmount,
     mappedBy: (psma) => psma.money_amount,
+    cascade: ["soft-remove"] as any,
   })
   price_set_money_amount: PriceSetMoneyAmount
 

packages/pricing/src/models/price-rule.ts

@@ -1,21 +1,30 @@
 import {
   BeforeCreate,
   Entity,
+  Filter,
+  Index,
   ManyToOne,
   OptionalProps,
   PrimaryKey,
   Property,
 } from "@mikro-orm/core"
+import { DALUtils, generateEntityId } from "@medusajs/utils"
 
-import { generateEntityId } from "@medusajs/utils"
 import PriceSet from "./price-set"
 import PriceSetMoneyAmount from "./price-set-money-amount"
 import RuleType from "./rule-type"
 
-type OptionalFields = "id" | "is_dynamic" | "priority"
+type OptionalFields =
+  | "id"
+  | "is_dynamic"
+  | "priority"
+  | "created_at"
+  | "updated_at"
+  | "deleted_at"
 type OptionalRelations = "price_set" | "rule_type" | "price_set_money_amount"
 
 @Entity()
+@Filter(DALUtils.mikroOrmSoftDeletableFilterOptions)
 export default class PriceRule {
   [OptionalProps]: OptionalFields | OptionalRelations
 
@@ -54,6 +63,25 @@ export default class PriceRule {
   })
   price_set_money_amount: PriceSetMoneyAmount
 
+  @Property({
+    onCreate: () => new Date(),
+    columnType: "timestamptz",
+    defaultRaw: "now()",
+  })
+  created_at: Date
+
+  @Property({
+    onCreate: () => new Date(),
+    onUpdate: () => new Date(),
+    columnType: "timestamptz",
+    defaultRaw: "now()",
+  })
+  updated_at: Date
+
+  @Index({ name: "IDX_price_rule_deleted_at" })
+  @Property({ columnType: "timestamptz", nullable: true })
+  deleted_at: Date
+
   @BeforeCreate()
   beforeCreate() {
     this.id = generateEntityId(this.id, "prule")