feat(medusa): Cart and totals computational optimizations (#2475)

medusajs · Nov 14, 2022 · d2b1848 · d2b1848
1 parent 755ba90
commit d2b1848
Show file tree

Hide file tree

Showing 29 changed files with 2,992 additions and 653 deletions.
diff --git a/integration-tests/api/__tests__/admin/product.js b/integration-tests/api/__tests__/admin/product.js
@@ -1866,25 +1866,28 @@ describe("/admin/products", () => {
 
  expect(res.status).toEqual(200)
 
- expect(insertedVariant.prices).toEqual([
- expect.objectContaining({
- currency_code: "usd",
- amount: 100,
- min_quantity: null,
- max_quantity: null,
- variant_id: insertedVariant.id,
- region_id: null,
- }),
- expect.objectContaining({
- currency_code: "usd",
- amount: 200,
- min_quantity: null,
- max_quantity: null,
- price_list_id: null,
- variant_id: insertedVariant.id,
- region_id: "test-region",
- }),
- ])
+ expect(insertedVariant.prices).toHaveLength(2)
+ expect(insertedVariant.prices).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ currency_code: "usd",
+ amount: 100,
+ min_quantity: null,
+ max_quantity: null,
+ variant_id: insertedVariant.id,
+ region_id: null,
+ }),
+ expect.objectContaining({
+ currency_code: "usd",
+ amount: 200,
+ min_quantity: null,
+ max_quantity: null,
+ price_list_id: null,
+ variant_id: insertedVariant.id,
+ region_id: "test-region",
+ }),
+ ])
+ )
  })
  })
 

diff --git a/integration-tests/api/__tests__/store/cart/cart.js b/integration-tests/api/__tests__/store/cart/cart.js
@@ -66,7 +66,9 @@ describe("/store/carts", () => {
  tax_rate: 0,
  })
  await manager.query(
- `UPDATE "country" SET region_id='region' WHERE iso_2 = 'us'`
+ `UPDATE "country"
+ SET region_id='region'
+ WHERE iso_2 = 'us'`
  )
  })
 
@@ -88,9 +90,12 @@ describe("/store/carts", () => {
  const api = useApi()
 
  await dbConnection.manager.query(
- `UPDATE "country" SET region_id=null WHERE iso_2 = 'us'`
+ `UPDATE "country"
+ SET region_id=null
+ WHERE iso_2 = 'us'`
  )
- await dbConnection.manager.query(`DELETE from region`)
+ await dbConnection.manager.query(`DELETE
+ from region`)
 
  try {
  await api.post("/store/carts")
@@ -1679,7 +1684,9 @@ describe("/store/carts", () => {
  const manager = dbConnection.manager
  const api = useApi()
  await manager.query(
- `UPDATE "cart" SET completed_at=current_timestamp WHERE id = 'test-cart-2'`
+ `UPDATE "cart"
+ SET completed_at=current_timestamp
+ WHERE id = 'test-cart-2'`
  )
  try {
  await api.post(`/store/carts/test-cart-2/complete-cart`)
@@ -1982,7 +1989,8 @@ describe("/store/carts", () => {
  try {
  await cartSeeder(dbConnection)
  await dbConnection.manager.query(
- `INSERT INTO "cart_discounts" (cart_id, discount_id) VALUES ('test-cart', 'free-shipping')`
+ `INSERT INTO "cart_discounts" (cart_id, discount_id)
+ VALUES ('test-cart', 'free-shipping')`
  )
  } catch (err) {
  console.log(err)

diff --git a/integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap b/integration-tests/plugins/__tests__/medusa-plugin-sendgrid/__snapshots__/index.js.snap
@@ -432,21 +432,17 @@ Object {
  "claim_order_id": null,
  "created_at": Any<Date>,
  "description": "",
- "discount_total": 0,
  "fulfilled_quantity": 2,
  "has_shipping": null,
  "id": Any<String>,
  "is_giftcard": false,
  "is_return": false,
  "metadata": null,
  "order_id": Any<String>,
- "original_tax_total": 400,
- "original_total": 2400,
  "quantity": 2,
  "returned_quantity": 1,
  "shipped_quantity": 2,
  "should_merge": true,
- "subtotal": 2000,
  "swap_id": null,
  "tax_lines": Array [
  Object {
@@ -460,10 +456,8 @@ Object {
  "updated_at": Any<Date>,
  },
  ],
- "tax_total": 400,
  "thumbnail": "",
  "title": "Intelligent Plastic Chips",
- "total": 2400,
  "unit_price": 1000,
  "updated_at": Any<Date>,
  "variant": Object {
@@ -774,22 +768,18 @@ Object {
  "claim_order_id": null,
  "created_at": Any<Date>,
  "description": "",
- "discount_total": 0,
  "fulfilled_quantity": null,
  "has_shipping": null,
  "id": "test-item",
  "is_giftcard": false,
  "is_return": false,
  "metadata": null,
  "order_id": Any<String>,
- "original_tax_total": 400,
- "original_total": 2400,
  "price": "10.00 USD",
  "quantity": 2,
  "returned_quantity": null,
  "shipped_quantity": null,
  "should_merge": true,
- "subtotal": 2000,
  "swap_id": null,
  "tax_lines": Array [
  Object {
@@ -803,10 +793,8 @@ Object {
  "updated_at": Any<Date>,
  },
  ],
- "tax_total": 400,
  "thumbnail": null,
  "title": "Intelligent Plastic Chips",
- "total": 2400,
  "unit_price": 1000,
  "updated_at": Any<Date>,
  "variant": Object {
@@ -1003,7 +991,6 @@ Object {
  "claim_order_id": null,
  "created_at": Any<Date>,
  "description": "",
- "discount_total": 0,
  "discounted_price": "12.00 USD",
  "fulfilled_quantity": 2,
  "has_shipping": null,
@@ -1012,14 +999,11 @@ Object {
  "is_return": false,
  "metadata": null,
  "order_id": Any<String>,
- "original_tax_total": 400,
- "original_total": 2400,
  "price": "12.00 USD",
  "quantity": 2,
  "returned_quantity": null,
  "shipped_quantity": 2,
  "should_merge": true,
- "subtotal": 2000,
  "swap_id": null,
  "tax_lines": Array [
  Object {
@@ -1033,10 +1017,8 @@ Object {
  "updated_at": Any<Date>,
  },
  ],
- "tax_total": 400,
  "thumbnail": null,
  "title": "Intelligent Plastic Chips",
- "total": 2400,
  "totals": Object {
  "discount_total": 0,
  "original_tax_total": 400,
@@ -1276,21 +1258,17 @@ Object {
  "claim_order_id": null,
  "created_at": Any<Date>,
  "description": "",
- "discount_total": 0,
  "fulfilled_quantity": 2,
  "has_shipping": null,
  "id": "test-item",
  "is_giftcard": false,
  "is_return": false,
  "metadata": null,
  "order_id": Any<String>,
- "original_tax_total": 400,
- "original_total": 2400,
  "quantity": 2,
  "returned_quantity": null,
  "shipped_quantity": 2,
  "should_merge": true,
- "subtotal": 2000,
  "swap_id": null,
  "tax_lines": Array [
  Object {
@@ -1304,10 +1282,8 @@ Object {
  "updated_at": Any<Date>,
  },
  ],
- "tax_total": 400,
  "thumbnail": "",
  "title": "Intelligent Plastic Chips",
- "total": 2400,
  "unit_price": 1000,
  "updated_at": Any<Date>,
  "variant": Object {
@@ -1603,21 +1579,17 @@ Object {
  "claim_order_id": null,
  "created_at": Any<Date>,
  "description": "",
- "discount_total": 0,
  "fulfilled_quantity": 2,
  "has_shipping": null,
  "id": Any<String>,
  "is_giftcard": false,
  "is_return": false,
  "metadata": null,
  "order_id": Any<String>,
- "original_tax_total": 400,
- "original_total": 2400,
  "quantity": 2,
  "returned_quantity": null,
  "shipped_quantity": 2,
  "should_merge": true,
- "subtotal": 2000,
  "swap_id": null,
  "tax_lines": Array [
  Object {
@@ -1631,10 +1603,8 @@ Object {
  "updated_at": Any<Date>,
  },
  ],
- "tax_total": 400,
  "thumbnail": "",
  "title": "Intelligent Plastic Chips",
- "total": 2400,
  "unit_price": 1000,
  "updated_at": Any<Date>,
  "variant": Object {

diff --git a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts
@@ -71,9 +71,15 @@ export default async (req, res) => {
  relations: defaultAdminDraftOrdersRelations,
  })
 
- draftOrder.cart = await cartService.retrieveWithTotals(draftOrder.cart_id, {
- relations: defaultAdminDraftOrdersCartRelations,
- })
+ draftOrder.cart = await cartService.retrieveWithTotals(
+ draftOrder.cart_id,
+ {
+ relations: defaultAdminDraftOrdersCartRelations,
+ },
+ {
+ force_taxes: true,
+ }
+ )
 
  res.json({ draft_order: draftOrder })
 }
diff --git a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts b/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts
@@ -83,16 +83,7 @@ export default async (req, res) => {
 
  const cart = await cartService
  .withTransaction(manager)
- .retrieve(draftOrder.cart_id, {
- select: ["total"],
- relations: [
- "discounts",
- "discounts.rule",
- "shipping_methods",
- "region",
- "items",
- ],
- })
+ .retrieveWithTotals(draftOrder.cart_id)
 
  await paymentProviderService
  .withTransaction(manager)

diff --git a/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js b/packages/medusa/src/api/routes/admin/orders/__tests__/get-order.js
@@ -26,11 +26,23 @@ describe("GET /admin/orders", () => {
  })
 
  it("calls orderService retrieve", () => {
- expect(OrderServiceMock.retrieve).toHaveBeenCalledTimes(1)
- expect(OrderServiceMock.retrieve).toHaveBeenCalledWith(
+ expect(OrderServiceMock.retrieveWithTotals).toHaveBeenCalledTimes(1)
+ expect(OrderServiceMock.retrieveWithTotals).toHaveBeenCalledWith(
  IdMap.getId("test-order"),
  {
- select: defaultAdminOrdersFields,
+ select: defaultAdminOrdersFields.filter((field) => {
+ return ![
+ "shipping_total",
+ "discount_total",
+ "tax_total",
+ "refunded_total",
+ "total",
+ "subtotal",
+ "refundable_amount",
+ "gift_card_total",
+ "gift_card_tax_total",
+ ].includes(field)
+ }),
  relations: defaultAdminOrdersRelations,
  }
  )

diff --git a/packages/medusa/src/api/routes/admin/orders/get-order.ts b/packages/medusa/src/api/routes/admin/orders/get-order.ts
@@ -56,7 +56,7 @@ export default async (req, res) => {
 
  const orderService: OrderService = req.scope.resolve("orderService")
 
- const order = await orderService.retrieve(id, req.retrieveConfig)
+ const order = await orderService.retrieveWithTotals(id, req.retrieveConfig)
 
  res.json({ order })
 }
diff --git a/packages/medusa/src/api/routes/admin/orders/index.ts b/packages/medusa/src/api/routes/admin/orders/index.ts
@@ -43,7 +43,19 @@ export default (app, featureFlagRouter: FlagRouter) => {
  "/:id",
  transformQuery(FindParams, {
  defaultRelations: relations,
- defaultFields: defaultAdminOrdersFields,
+ defaultFields: defaultAdminOrdersFields.filter((field) => {
+ return ![
+ "shipping_total",
+ "discount_total",
+ "tax_total",
+ "refunded_total",
+ "total",
+ "subtotal",
+ "refundable_amount",
+ "gift_card_total",
+ "gift_card_tax_total",
+ ].includes(field)
+ }),
  allowedFields: allowedAdminOrdersFields,
  allowedRelations: allowedAdminOrdersRelations,
  isList: false,