feat(order): bundled actions (#7133)

This commit is contained in:
Carlos R. L. Rodrigues
2024-04-25 07:06:23 -03:00
committed by GitHub
parent e4898fb00d
commit d02905cefa
23 changed files with 1114 additions and 232 deletions
@@ -123,7 +123,7 @@ moduleIntegrationTestRunner({
id: expect.stringContaining("order_"),
version: 1,
summary: expect.objectContaining({
total: expect.any(Number),
// TODO: add all summary fields
}),
shipping_address: expect.objectContaining({
id: expect.stringContaining("ordaddr_"),
@@ -326,6 +326,209 @@ moduleIntegrationTestRunner({
)
expect(orders4.length).toEqual(0)
})
it("should create an order, fulfill, ship and return the items", async function () {
const createdOrder = await service.create(input)
// Fullfilment
await service.registerFulfillment({
order_id: createdOrder.id,
items: createdOrder.items!.map((item) => {
return {
id: item.id,
quantity: item.quantity,
}
}),
})
let getOrder = await service.retrieve(createdOrder.id, {
select: [
"id",
"version",
"items.id",
"items.quantity",
"items.detail.id",
"items.detail.version",
"items.detail.quantity",
"items.detail.shipped_quantity",
"items.detail.fulfilled_quantity",
],
relations: ["items", "items.detail"],
})
let serializedOrder = JSON.parse(JSON.stringify(getOrder))
expect(serializedOrder).toEqual(
expect.objectContaining({
version: 2,
items: [
expect.objectContaining({
quantity: 1,
detail: expect.objectContaining({
version: 2,
quantity: 1,
fulfilled_quantity: 1,
shipped_quantity: 0,
}),
}),
expect.objectContaining({
quantity: 2,
detail: expect.objectContaining({
version: 2,
quantity: 2,
fulfilled_quantity: 2,
shipped_quantity: 0,
}),
}),
expect.objectContaining({
quantity: 1,
detail: expect.objectContaining({
version: 2,
quantity: 1,
fulfilled_quantity: 1,
shipped_quantity: 0,
}),
}),
],
})
)
// Shipment
await service.registerShipment({
order_id: createdOrder.id,
reference: Modules.FULFILLMENT,
shipping_method: createdOrder.shipping_methods![0].id,
items: createdOrder.items!.map((item) => {
return {
id: item.id,
quantity: item.quantity,
}
}),
})
getOrder = await service.retrieve(createdOrder.id, {
select: [
"id",
"version",
"items.id",
"items.quantity",
"items.detail.id",
"items.detail.version",
"items.detail.quantity",
"items.detail.shipped_quantity",
"items.detail.fulfilled_quantity",
],
relations: ["items", "items.detail"],
})
serializedOrder = JSON.parse(JSON.stringify(getOrder))
expect(serializedOrder).toEqual(
expect.objectContaining({
version: 3,
items: [
expect.objectContaining({
quantity: 1,
detail: expect.objectContaining({
version: 3,
quantity: 1,
fulfilled_quantity: 1,
shipped_quantity: 1,
}),
}),
expect.objectContaining({
quantity: 2,
detail: expect.objectContaining({
version: 3,
quantity: 2,
fulfilled_quantity: 2,
shipped_quantity: 2,
}),
}),
expect.objectContaining({
quantity: 1,
detail: expect.objectContaining({
version: 3,
quantity: 1,
fulfilled_quantity: 1,
shipped_quantity: 1,
}),
}),
],
})
)
// Return
await service.createReturn({
order_id: createdOrder.id,
reference: Modules.FULFILLMENT,
description: "Return all the items",
internal_note: "user wants to return all items",
shipping_method: createdOrder.shipping_methods![0].id,
items: createdOrder.items!.map((item) => {
return {
id: item.id,
quantity: item.quantity,
}
}),
})
getOrder = await service.retrieve(createdOrder.id, {
select: [
"id",
"version",
"items.id",
"items.quantity",
"items.detail.id",
"items.detail.version",
"items.detail.quantity",
"items.detail.shipped_quantity",
"items.detail.fulfilled_quantity",
"items.detail.return_requested_quantity",
],
relations: ["items", "items.detail"],
})
serializedOrder = JSON.parse(JSON.stringify(getOrder))
expect(serializedOrder).toEqual(
expect.objectContaining({
version: 4,
items: [
expect.objectContaining({
quantity: 1,
detail: expect.objectContaining({
version: 4,
quantity: 1,
fulfilled_quantity: 1,
shipped_quantity: 1,
return_requested_quantity: 1,
}),
}),
expect.objectContaining({
quantity: 2,
detail: expect.objectContaining({
version: 4,
quantity: 2,
fulfilled_quantity: 2,
shipped_quantity: 2,
return_requested_quantity: 2,
}),
}),
expect.objectContaining({
quantity: 1,
detail: expect.objectContaining({
version: 4,
quantity: 1,
fulfilled_quantity: 1,
shipped_quantity: 1,
return_requested_quantity: 1,
}),
}),
],
})
)
})
})
},
})
@@ -1,5 +1,10 @@
import { Modules } from "@medusajs/modules-sdk"
import { CreateOrderDTO, IOrderModuleService } from "@medusajs/types"
import {
CreateOrderChangeActionDTO,
CreateOrderChangeDTO,
CreateOrderDTO,
IOrderModuleService,
} from "@medusajs/types"
import { BigNumber } from "@medusajs/utils"
import { SuiteOptions, moduleIntegrationTestRunner } from "medusa-test-utils"
import { ChangeActionType } from "../../src/utils"
@@ -7,7 +12,7 @@ import { ChangeActionType } from "../../src/utils"
jest.setTimeout(100000)
moduleIntegrationTestRunner({
debug: 0,
debug: false,
moduleName: Modules.ORDER,
testSuite: ({ service }: SuiteOptions<IOrderModuleService>) => {
describe("Order Module Service - Order Edits", () => {
@@ -132,9 +137,10 @@ moduleIntegrationTestRunner({
version: createdOrder.version,
internal_note: "adding an item",
reference: "order_line_item",
reference_id: createdOrder.items[0].id,
reference_id: createdOrder.items![0].id,
amount:
createdOrder.items[0].unit_price * createdOrder.items[0].quantity,
createdOrder.items![0].unit_price *
createdOrder.items![0].quantity,
details: {
quantity: 1,
},
@@ -144,9 +150,10 @@ moduleIntegrationTestRunner({
order_id: createdOrder.id,
version: createdOrder.version,
reference: "order_line_item",
reference_id: createdOrder.items[1].id,
reference_id: createdOrder.items![1].id,
amount:
createdOrder.items[1].unit_price * createdOrder.items[1].quantity,
createdOrder.items![1].unit_price *
createdOrder.items![1].quantity,
details: {
quantity: 3,
},
@@ -158,7 +165,7 @@ moduleIntegrationTestRunner({
reference: "fullfilment",
reference_id: "fulfill_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -169,7 +176,7 @@ moduleIntegrationTestRunner({
reference: "fullfilment",
reference_id: "shipping_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -181,7 +188,7 @@ moduleIntegrationTestRunner({
reference: "return",
reference_id: "return_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -193,11 +200,11 @@ moduleIntegrationTestRunner({
reference: "return",
reference_id: "return_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
])
] as CreateOrderChangeActionDTO[])
await service.applyPendingOrderActions(createdOrder.id)
@@ -327,7 +334,7 @@ moduleIntegrationTestRunner({
])
})
it("should create an order change, add actions to it and confirm the changes.", async function () {
it("should create an order change, add actions to it, confirm the changes, revert all the changes and restore the changes again.", async function () {
const createdOrder = await service.create(input)
const orderChange = await service.createOrderChange({
@@ -339,10 +346,10 @@ moduleIntegrationTestRunner({
{
action: ChangeActionType.ITEM_ADD,
reference: "order_line_item",
reference_id: createdOrder.items[0].id,
reference_id: createdOrder.items![0].id,
amount:
createdOrder.items[0].unit_price *
createdOrder.items[0].quantity,
createdOrder.items![0].unit_price *
createdOrder.items![0].quantity,
details: {
quantity: 1,
},
@@ -350,10 +357,10 @@ moduleIntegrationTestRunner({
{
action: ChangeActionType.ITEM_ADD,
reference: "order_line_item",
reference_id: createdOrder.items[1].id,
reference_id: createdOrder.items![1].id,
amount:
createdOrder.items[1].unit_price *
createdOrder.items[1].quantity,
createdOrder.items![1].unit_price *
createdOrder.items![1].quantity,
details: {
quantity: 3,
},
@@ -363,7 +370,7 @@ moduleIntegrationTestRunner({
reference: "fullfilment",
reference_id: "fulfill_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -372,7 +379,7 @@ moduleIntegrationTestRunner({
reference: "fullfilment",
reference_id: "shipping_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -381,7 +388,7 @@ moduleIntegrationTestRunner({
reference: "return",
reference_id: "return_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -391,7 +398,7 @@ moduleIntegrationTestRunner({
reference: "return",
reference_id: "return_123",
details: {
reference_id: createdOrder.items[2].id,
reference_id: createdOrder.items![2].id,
quantity: 1,
},
},
@@ -427,6 +434,9 @@ moduleIntegrationTestRunner({
})
)
expect(serializedModifiedOrder.shipping_methods).toHaveLength(1)
expect(serializedModifiedOrder.shipping_methods[0].amount).toEqual(10)
expect(serializedModifiedOrder.items).toEqual([
expect.objectContaining({
quantity: 2,
@@ -466,6 +476,72 @@ moduleIntegrationTestRunner({
}),
}),
])
// Revert Last Changes
await service.revertLastVersion(createdOrder.id)
const revertedOrder = await service.retrieve(createdOrder.id, {
select: [
"id",
"version",
"items.detail",
"summary",
"shipping_methods",
],
relations: ["items"],
})
const serializedRevertedOrder = JSON.parse(
JSON.stringify(revertedOrder)
)
expect(serializedRevertedOrder).toEqual(
expect.objectContaining({
version: 1,
})
)
expect(serializedRevertedOrder.shipping_methods).toHaveLength(1)
expect(serializedRevertedOrder.shipping_methods[0].amount).toEqual(10)
expect(serializedRevertedOrder.items).toEqual([
expect.objectContaining({
quantity: 1,
unit_price: 8,
detail: expect.objectContaining({
version: 1,
quantity: 1,
}),
}),
expect.objectContaining({
title: "Item 2",
unit_price: 5,
quantity: 2,
detail: expect.objectContaining({
version: 1,
quantity: 2,
fulfilled_quantity: 0,
shipped_quantity: 0,
return_requested_quantity: 0,
return_received_quantity: 0,
return_dismissed_quantity: 0,
written_off_quantity: 0,
}),
}),
expect.objectContaining({
title: "Item 3",
unit_price: 30,
quantity: 1,
detail: expect.objectContaining({
version: 1,
quantity: 1,
fulfilled_quantity: 0,
shipped_quantity: 0,
return_requested_quantity: 0,
return_received_quantity: 0,
return_dismissed_quantity: 0,
written_off_quantity: 0,
}),
}),
])
})
it("should create order changes, cancel and reject them.", async function () {
@@ -487,16 +563,16 @@ moduleIntegrationTestRunner({
{
action: ChangeActionType.ITEM_ADD,
reference: "order_line_item",
reference_id: createdOrder.items[0].id,
reference_id: createdOrder.items![0].id,
amount:
createdOrder.items[0].unit_price *
createdOrder.items[0].quantity,
createdOrder.items![0].unit_price *
createdOrder.items![0].quantity,
details: {
quantity: 1,
},
},
],
})
} as CreateOrderChangeDTO)
await service.cancelOrderChange({
id: orderChange.id,
@@ -790,7 +790,7 @@ moduleIntegrationTestRunner({
},
])
const methods = await service.createShippingMethods([
const [eurMethod, usdMethod] = await service.createShippingMethods([
{
order_id: eurOrder.id,
amount: 100,
@@ -811,47 +811,14 @@ moduleIntegrationTestRunner({
eurOrder = orders.find((c) => c.currency_code === "eur")!
usdOrder = orders.find((c) => c.currency_code === "usd")!
const eurMethods = methods.filter((m) => m.order_id === eurOrder.id)
const usdMethods = methods.filter((m) => m.order_id === usdOrder.id)
expect(eurOrder.shipping_methods![0].id).toBe(eurMethods[0].id)
expect(usdOrder.shipping_methods![0].id).toBe(usdMethods[0].id)
expect(eurOrder.shipping_methods![0].id).toBe(eurMethod.id)
expect(usdOrder.shipping_methods![0].id).toBe(usdMethod.id)
expect(eurOrder.shipping_methods?.length).toBe(1)
expect(usdOrder.shipping_methods?.length).toBe(1)
})
})
describe("deleteShippingMethods", () => {
it("should delete a line item succesfully", async () => {
const [createdOrder] = await service.create([
{
currency_code: "eur",
},
])
const [method] = await service.createShippingMethods(
createdOrder.id,
[
{
amount: 100,
name: "test",
},
]
)
expect(method.id).not.toBe(null)
await service.deleteShippingMethods(method.id)
const order = await service.retrieve(createdOrder.id, {
relations: ["shipping_methods"],
})
expect(order.shipping_methods?.length).toBe(0)
})
})
describe("setLineItemAdjustments", () => {
it("should set line item adjustments for an order", async () => {
const [createdOrder] = await service.create([
@@ -1457,6 +1424,7 @@ moduleIntegrationTestRunner({
})
const serialized = JSON.parse(JSON.stringify(order))
expect(serialized.shipping_methods).toEqual(
expect.arrayContaining([
expect.objectContaining({
@@ -1750,39 +1718,43 @@ moduleIntegrationTestRunner({
},
])
const orderOneMethods = await service.listShippingMethods(
const orderOneMethods = await service.listOrderShippingMethods(
{ order_id: orderOne.id },
{ relations: ["adjustments", "order"] }
{ relations: ["shipping_method.adjustments"] }
)
const orderTwoMethods = await service.listShippingMethods(
const orderTwoMethods = await service.listOrderShippingMethods(
{ order_id: orderTwo.id },
{ relations: ["adjustments", "order"] }
{ relations: ["shipping_method.adjustments"] }
)
expect(orderOneMethods).toEqual(
expect.arrayContaining([
expect.objectContaining({
adjustments: expect.arrayContaining([
expect.objectContaining({
shipping_method_id: shippingMethodOne.id,
amount: 100,
code: "FREE",
}),
]),
shipping_method: expect.objectContaining({
adjustments: expect.arrayContaining([
expect.objectContaining({
shipping_method_id: shippingMethodOne.id,
amount: 100,
code: "FREE",
}),
]),
}),
}),
])
)
expect(orderTwoMethods).toEqual(
expect.arrayContaining([
expect.objectContaining({
adjustments: expect.arrayContaining([
expect.objectContaining({
shipping_method_id: shippingMethodTwo.id,
amount: 150,
code: "CODE-2",
}),
]),
shipping_method: expect.objectContaining({
adjustments: expect.arrayContaining([
expect.objectContaining({
shipping_method_id: shippingMethodTwo.id,
amount: 150,
code: "CODE-2",
}),
]),
}),
}),
])
)
@@ -1828,7 +1800,7 @@ moduleIntegrationTestRunner({
})
describe("deleteShippingMethodAdjustments", () => {
it("should delete a shipping method succesfully", async () => {
it("should delete a shipping method adjustment succesfully", async () => {
const [createdOrder] = await service.create([
{
currency_code: "eur",