feat(promotion,dashboard,types,utils,medusa): Add statuses to promotions (#10950)

what: - adds a status column to promotion table - introduce active promotion query - scope revert, register and compute actions to active promotions - admin to create and update promotion with statuses RESOLVES CMRC-845 RESOLVES CMRC-846 RESOLVES CMRC-847 RESOLVES CMRC-848 RESOLVES CMRC-849 RESOLVES CMRC-850
2025-01-16 19:17:22 +00:00
1 parent effee5c8bb
commit 5eab9e7399
@@ -3,7 +3,11 @@ import {
  IPromotionModuleService,
  PromotionDTO,
 } from "@medusajs/framework/types"
-import { isPresent, toMikroORMEntity } from "@medusajs/framework/utils"
+import {
+  isPresent,
+  PromotionStatus,
+  toMikroORMEntity,
+} from "@medusajs/framework/utils"
 import { SqlEntityManager } from "@mikro-orm/postgresql"
 import { Promotion } from "@models"
 import { defaultPromotionsData } from "./data"
@@ -51,6 +55,7 @@ export async function createDefaultPromotion(
  return await service.createPromotions({
    code: "PROMOTION_TEST",
    type: "standard",
+    status: PromotionStatus.ACTIVE,
    campaign_id: "campaign-id-1",
    ...promotion,
    application_method: {
@@ -2,6 +2,7 @@ import { IPromotionModuleService } from "@medusajs/framework/types"
 import {
  ApplicationMethodType,
  Modules,
+  PromotionStatus,
  PromotionType,
 } from "@medusajs/framework/utils"
 import { moduleIntegrationTestRunner, SuiteOptions } from "@medusajs/test-utils"
@@ -17,13 +18,85 @@ moduleIntegrationTestRunner({
    service,
  }: SuiteOptions<IPromotionModuleService>) => {
    describe("Promotion Service: computeActions", () => {
+      beforeAll(() => {
+        jest.useFakeTimers()
+        jest.setSystemTime(new Date("02/02/2023"))
+      })
+
+      afterAll(() => {
+        jest.useRealTimers()
+      })
+
      beforeEach(async () => {
        await createCampaigns(MikroOrmWrapper.forkManager())
      })

+      it("should return empty array when promotion is not active (draft or inactive)", async () => {
+        const promotion = await createDefaultPromotion(service, {
+          status: PromotionStatus.DRAFT,
+          rules: [
+            {
+              attribute: "customer.customer_group.id",
+              operator: "in",
+              values: ["VIP", "top100"],
+            },
+          ],
+          application_method: {
+            type: "fixed",
+            target_type: "items",
+            allocation: "each",
+            value: 200,
+            max_quantity: 1,
+            target_rules: [
+              {
+                attribute: "product_category.id",
+                operator: "eq",
+                values: ["catg_cotton"],
+              },
+            ],
+          },
+        })
+
+        const result = await service.computeActions([promotion.code!], {
+          currency_code: "usd",
+          customer: {
+            customer_group: {
+              id: "VIP",
+            },
+          },
+          items: [
+            {
+              id: "item_cotton_tshirt",
+              quantity: 1,
+              subtotal: 100,
+              product_category: {
+                id: "catg_cotton",
+              },
+              product: {
+                id: "prod_tshirt",
+              },
+            },
+            {
+              id: "item_cotton_sweater",
+              quantity: 5,
+              subtotal: 750,
+              product_category: {
+                id: "catg_cotton",
+              },
+              product: {
+                id: "prod_sweater",
+              },
+            },
+          ],
+        })
+
+        expect(result).toEqual([])
+      })
+
      describe("when code is not present in database", () => {
        it("should return empty array when promotion does not exist", async () => {
          const response = await service.computeActions(["DOES_NOT_EXIST"], {
+            currency_code: "usd",
            customer: {
              customer_group: {
                id: "VIP",
@@ -87,6 +160,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -136,6 +210,7 @@ moduleIntegrationTestRunner({
            const resultWithoutCustomer = await service.computeActions(
              ["PROMOTION_TEST"],
              {
+                currency_code: "usd",
                items: [
                  {
                    id: "item_cotton_tshirt",
@@ -221,6 +296,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -257,19 +333,7 @@ moduleIntegrationTestRunner({
              {
                action: "addItemAdjustment",
                item_id: "item_cotton_tshirt",
-                amount: 30,
-                code: "PROMOTION_TEST",
-              },
-              {
-                action: "addItemAdjustment",
-                item_id: "item_cotton_sweater",
-                amount: 30,
-                code: "PROMOTION_TEST",
-              },
-              {
-                action: "addItemAdjustment",
-                item_id: "item_cotton_tshirt",
-                amount: 20,
+                amount: 50,
                code: "PROMOTION_TEST_2",
              },
              {
@@ -278,6 +342,12 @@ moduleIntegrationTestRunner({
                amount: 50,
                code: "PROMOTION_TEST_2",
              },
+              {
+                action: "addItemAdjustment",
+                item_id: "item_cotton_sweater",
+                amount: 30,
+                code: "PROMOTION_TEST",
+              },
            ])
          })

@@ -334,6 +404,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -408,6 +479,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -469,6 +541,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -522,6 +595,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -622,6 +696,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -735,6 +810,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -809,6 +885,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -866,6 +943,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -921,6 +999,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -994,6 +1073,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions([], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1093,6 +1173,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -1126,18 +1207,6 @@ moduleIntegrationTestRunner({
            )

            expect(JSON.parse(JSON.stringify(result))).toEqual([
-              {
-                action: "addItemAdjustment",
-                item_id: "item_cotton_tshirt",
-                amount: 7.5,
-                code: "PROMOTION_TEST",
-              },
-              {
-                action: "addItemAdjustment",
-                item_id: "item_cotton_sweater",
-                amount: 22.5,
-                code: "PROMOTION_TEST",
-              },
              {
                action: "addItemAdjustment",
                item_id: "item_cotton_tshirt",
@@ -1150,6 +1219,18 @@ moduleIntegrationTestRunner({
                amount: 37.5,
                code: "PROMOTION_TEST_2",
              },
+              {
+                action: "addItemAdjustment",
+                item_id: "item_cotton_tshirt",
+                amount: 7.5,
+                code: "PROMOTION_TEST",
+              },
+              {
+                action: "addItemAdjustment",
+                item_id: "item_cotton_sweater",
+                amount: 22.5,
+                code: "PROMOTION_TEST",
+              },
            ])
          })

@@ -1205,6 +1286,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -1278,6 +1360,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1334,6 +1417,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1386,6 +1470,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1459,6 +1544,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions([], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1557,6 +1643,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -1668,6 +1755,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -1753,6 +1841,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1809,6 +1898,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1864,6 +1954,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -1937,6 +2028,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions([], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -2012,6 +2104,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              [],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -2100,6 +2193,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -2206,6 +2300,7 @@ moduleIntegrationTestRunner({
            const result = await service.computeActions(
              ["PROMOTION_TEST", "PROMOTION_TEST_2"],
              {
+                currency_code: "usd",
                customer: {
                  customer_group: {
                    id: "VIP",
@@ -2279,6 +2374,7 @@ moduleIntegrationTestRunner({
            })

            const result = await service.computeActions(["PROMOTION_TEST"], {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -3974,6 +4070,7 @@ moduleIntegrationTestRunner({
          const result = await service.computeActions(
            ["PROMOTION_TEST", "PROMOTION_TEST_2"],
            {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -4007,18 +4104,6 @@ moduleIntegrationTestRunner({
          )

          expect(JSON.parse(JSON.stringify(result))).toEqual([
-            {
-              action: "addItemAdjustment",
-              item_id: "item_cotton_tshirt",
-              amount: 7.5,
-              code: "PROMOTION_TEST",
-            },
-            {
-              action: "addItemAdjustment",
-              item_id: "item_cotton_sweater",
-              amount: 22.5,
-              code: "PROMOTION_TEST",
-            },
            {
              action: "addItemAdjustment",
              item_id: "item_cotton_tshirt",
@@ -4031,6 +4116,18 @@ moduleIntegrationTestRunner({
              amount: 37.5,
              code: "PROMOTION_TEST_2",
            },
+            {
+              action: "addItemAdjustment",
+              item_id: "item_cotton_tshirt",
+              amount: 7.5,
+              code: "PROMOTION_TEST",
+            },
+            {
+              action: "addItemAdjustment",
+              item_id: "item_cotton_sweater",
+              amount: 22.5,
+              code: "PROMOTION_TEST",
+            },
          ])
        })

@@ -4073,6 +4170,7 @@ moduleIntegrationTestRunner({
          const result = await service.computeActions(
            ["PROMOTION_TEST", "PROMOTION_TEST_2"],
            {
+              currency_code: "usd",
              customer: {
                customer_group: {
                  id: "VIP",
@@ -6,8 +6,8 @@ import {
  Modules,
  PromotionType,
 } from "@medusajs/framework/utils"
-import { PromotionModuleService } from "@services"
 import { SuiteOptions, moduleIntegrationTestRunner } from "@medusajs/test-utils"
+import { PromotionModuleService } from "@services"
 import { createCampaigns } from "../../../__fixtures__/campaigns"
 import {
  createDefaultPromotion,
@@ -24,6 +24,15 @@ moduleIntegrationTestRunner({
    service,
  }: SuiteOptions<IPromotionModuleService>) => {
    describe("Promotion Service", () => {
+      beforeAll(() => {
+        jest.useFakeTimers()
+        jest.setSystemTime(new Date("02/02/2023"))
+      })
+
+      afterAll(() => {
+        jest.useRealTimers()
+      })
+
      beforeEach(async () => {
        await createCampaigns(MikroOrmWrapper.forkManager())
      })
@@ -809,30 +818,32 @@ moduleIntegrationTestRunner({

          expect(count).toEqual(2)
          expect(promotions).toEqual([
-            {
+            expect.objectContaining({
              id: "promotion-id-1",
              code: "PROMOTION_1",
              campaign_id: null,
              campaign: null,
+              status: "draft",
              is_automatic: false,
              type: "standard",
              application_method: expect.any(Object),
              created_at: expect.any(Date),
              updated_at: expect.any(Date),
              deleted_at: null,
-            },
-            {
+            }),
+            expect.objectContaining({
              id: "promotion-id-2",
              code: "PROMOTION_2",
              campaign_id: null,
              campaign: null,
+              status: "draft",
              is_automatic: false,
              type: "standard",
              application_method: null,
              created_at: expect.any(Date),
              updated_at: expect.any(Date),
              deleted_at: null,
-            },
+            }),
          ])
        })

@@ -1,8 +1,8 @@
 import { IPromotionModuleService } from "@medusajs/framework/types"
+import { Modules } from "@medusajs/framework/utils"
 import { moduleIntegrationTestRunner, SuiteOptions } from "@medusajs/test-utils"
 import { createCampaigns } from "../../../__fixtures__/campaigns"
 import { createDefaultPromotion } from "../../../__fixtures__/promotion"
-import { Modules } from "@medusajs/framework/utils"

 jest.setTimeout(30000)

@@ -13,6 +13,15 @@ moduleIntegrationTestRunner({
    service,
  }: SuiteOptions<IPromotionModuleService>) => {
    describe("Promotion Service: campaign usage", () => {
+      beforeAll(() => {
+        jest.useFakeTimers()
+        jest.setSystemTime(new Date("02/02/2023"))
+      })
+
+      afterAll(() => {
+        jest.useRealTimers()
+      })
+
      beforeEach(async () => {
        await createCampaigns(MikroOrmWrapper.forkManager())
      })
@@ -13,6 +13,15 @@ moduleIntegrationTestRunner({
    service,
  }: SuiteOptions<IPromotionModuleService>) => {
    describe("Promotion Service: campaign usage", () => {
+      beforeAll(() => {
+        jest.useFakeTimers()
+        jest.setSystemTime(new Date("02/02/2023"))
+      })
+
+      afterAll(() => {
+        jest.useRealTimers()
+      })
+
      beforeEach(async () => {
        await createCampaigns(MikroOrmWrapper.forkManager())
      })