fix(core-flows): lock draft order workflows (#13668)

I added a lock in all workflows of the draft order. I don't think there are drawbacks and it will make sure we don't run into concurrency issues in with draft orders. I don't see why we would not add this in the order workflows, let me know and I can add it too.

I also didn't see any workflow that is long enough to justify adding a timeout of more than 2 seconds, but let me know if you think otherwise, we can discuss adjustments :)

CLOSES-1228

Author: willbouch

.changeset/old-zebras-destroy.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/core-flows": patch
+---
+
+fix(core-flows): lock draft order workflows

packages/core/core-flows/src/draft-order/workflows/add-draft-order-items.ts

@@ -25,6 +25,7 @@ import {
 import { validateDraftOrderChangeStep } from "../steps/validate-draft-order-change"
 import { draftOrderFieldsForRefreshSteps } from "../utils/fields"
 import { refreshDraftOrderAdjustmentsWorkflow } from "./refresh-draft-order-adjustments"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const addDraftOrderItemsWorkflowId = "add-draft-order-items"
 
@@ -56,6 +57,12 @@ export const addDraftOrderItemsWorkflow = createWorkflow(
   function (
     input: WorkflowData<OrderWorkflow.OrderEditAddNewItemWorkflowInput>
   ) {
+    acquireLockStep({
+      key: input.order_id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order: OrderDTO & { promotions: { code: string }[] } =
       useRemoteQueryStep({
         entry_point: "orders",
@@ -142,6 +149,10 @@ export const addDraftOrderItemsWorkflow = createWorkflow(
       input: orderChangeActionInput,
     })
 
+    releaseLockStep({
+      key: input.order_id,
+    })
+
     return new WorkflowResponse(previewOrderChangeStep(input.order_id))
   }
 )

packages/core/core-flows/src/draft-order/workflows/add-draft-order-promotions.ts

@@ -23,6 +23,7 @@ import { validateDraftOrderChangeStep } from "../steps/validate-draft-order-chan
 import { validatePromoCodesToAddStep } from "../steps/validate-promo-codes-to-add"
 import { draftOrderFieldsForRefreshSteps } from "../utils/fields"
 import { refreshDraftOrderAdjustmentsWorkflow } from "./refresh-draft-order-adjustments"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const addDraftOrderPromotionWorkflowId = "add-draft-order-promotion"
 
@@ -63,6 +64,12 @@ export interface AddDraftOrderPromotionWorkflowInput {
 export const addDraftOrderPromotionWorkflow = createWorkflow(
   addDraftOrderPromotionWorkflowId,
   function (input: WorkflowData<AddDraftOrderPromotionWorkflowInput>) {
+    acquireLockStep({
+      key: input.order_id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order: OrderDTO = useRemoteQueryStep({
       entry_point: "orders",
       fields: draftOrderFieldsForRefreshSteps,
@@ -131,6 +138,10 @@ export const addDraftOrderPromotionWorkflow = createWorkflow(
       input: orderChangeActionInput,
     })
 
+    releaseLockStep({
+      key: input.order_id,
+    })
+
     return new WorkflowResponse(previewOrderChangeStep(input.order_id))
   }
 )

packages/core/core-flows/src/draft-order/workflows/add-draft-order-shipping-methods.ts

@@ -31,6 +31,7 @@ import { prepareShippingMethod } from "../../order/utils/prepare-shipping-method
 import { validateDraftOrderChangeStep } from "../steps/validate-draft-order-change"
 import { draftOrderFieldsForRefreshSteps } from "../utils/fields"
 import { refreshDraftOrderAdjustmentsWorkflow } from "./refresh-draft-order-adjustments"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 const validateShippingOptionStep = createStep(
   "validate-shipping-option",
@@ -99,6 +100,12 @@ export interface AddDraftOrderShippingMethodsWorkflowInput {
 export const addDraftOrderShippingMethodsWorkflow = createWorkflow(
   addDraftOrderShippingMethodsWorkflowId,
   function (input: WorkflowData<AddDraftOrderShippingMethodsWorkflowInput>) {
+    acquireLockStep({
+      key: input.order_id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order: OrderDTO & {
       promotions: {
         code: string
@@ -232,6 +239,10 @@ export const addDraftOrderShippingMethodsWorkflow = createWorkflow(
       input: [orderChangeActionInput],
     })
 
+    releaseLockStep({
+      key: input.order_id,
+    })
+
     return new WorkflowResponse(previewOrderChangeStep(order.id))
   }
 )

packages/core/core-flows/src/draft-order/workflows/begin-draft-order-edit.ts

@@ -8,6 +8,7 @@ import type { OrderDTO, OrderWorkflow } from "@medusajs/framework/types"
 import { useRemoteQueryStep } from "../../common"
 import { createOrderChangeStep, previewOrderChangeStep } from "../../order"
 import { validateDraftOrderStep } from "../steps"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const beginDraftOrderEditWorkflowId = "begin-draft-order-edit"
 
@@ -35,6 +36,12 @@ export const beginDraftOrderEditWorkflowId = "begin-draft-order-edit"
 export const beginDraftOrderEditWorkflow = createWorkflow(
   beginDraftOrderEditWorkflowId,
   function (input: WorkflowData<OrderWorkflow.BeginorderEditWorkflowInput>) {
+    acquireLockStep({
+      key: input.order_id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order: OrderDTO = useRemoteQueryStep({
       entry_point: "orders",
       fields: ["id", "status", "is_draft_order"],
@@ -57,6 +64,10 @@ export const beginDraftOrderEditWorkflow = createWorkflow(
 
     createOrderChangeStep(orderChangeInput)
 
+    releaseLockStep({
+      key: input.order_id,
+    })
+
     return new WorkflowResponse(previewOrderChangeStep(input.order_id))
   }
 )

packages/core/core-flows/src/draft-order/workflows/cancel-draft-order-edit.ts

@@ -17,6 +17,7 @@ import { restoreDraftOrderShippingMethodsStep } from "../steps/restore-draft-ord
 import { validateDraftOrderChangeStep } from "../steps/validate-draft-order-change"
 import { draftOrderFieldsForRefreshSteps } from "../utils/fields"
 import { refreshDraftOrderAdjustmentsWorkflow } from "./refresh-draft-order-adjustments"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const cancelDraftOrderEditWorkflowId = "cancel-draft-order-edit"
 
@@ -52,6 +53,12 @@ export interface CancelDraftOrderEditWorkflowInput {
 export const cancelDraftOrderEditWorkflow = createWorkflow(
   cancelDraftOrderEditWorkflowId,
   function (input: WorkflowData<CancelDraftOrderEditWorkflowInput>) {
+    acquireLockStep({
+      key: input.order_id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order: OrderDTO & {
       promotions: {
         code: string
@@ -166,5 +173,9 @@ export const cancelDraftOrderEditWorkflow = createWorkflow(
         shippingMethods: shippingToRestore as any,
       })
     })
+
+    releaseLockStep({
+      key: input.order_id,
+    })
   }
 )

packages/core/core-flows/src/draft-order/workflows/confirm-draft-order-edit.ts

@@ -1,31 +1,17 @@
-import {
-  ChangeActionType,
-  MathBN,
-  OrderChangeStatus,
-} from "@medusajs/framework/utils"
-import {
-  createWorkflow,
-  transform,
-  WorkflowResponse,
-} from "@medusajs/framework/workflows-sdk"
-import {
-  BigNumberInput,
-  OrderChangeDTO,
-  OrderDTO,
-} from "@medusajs/framework/types"
+import { ChangeActionType, MathBN, OrderChangeStatus, } from "@medusajs/framework/utils"
+import { createWorkflow, transform, WorkflowResponse, } from "@medusajs/framework/workflows-sdk"
+import { BigNumberInput, OrderChangeDTO, OrderDTO, } from "@medusajs/framework/types"
 import { reserveInventoryStep } from "../../cart"
 import {
   prepareConfirmInventoryInput,
   requiredOrderFieldsForInventoryConfirmation,
 } from "../../cart/utils/prepare-confirm-inventory-input"
 import { useRemoteQueryStep } from "../../common"
-import {
-  createOrUpdateOrderPaymentCollectionWorkflow,
-  previewOrderChangeStep,
-} from "../../order"
+import { createOrUpdateOrderPaymentCollectionWorkflow, previewOrderChangeStep, } from "../../order"
 import { confirmOrderChanges } from "../../order/steps/confirm-order-changes"
 import { deleteReservationsByLineItemsStep } from "../../reservation"
 import { validateDraftOrderChangeStep } from "../steps/validate-draft-order-change"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const confirmDraftOrderEditWorkflowId = "confirm-draft-order-edit"
 
@@ -63,6 +49,12 @@ export interface ConfirmDraftOrderEditWorkflowInput {
 export const confirmDraftOrderEditWorkflow = createWorkflow(
   confirmDraftOrderEditWorkflowId,
   function (input: ConfirmDraftOrderEditWorkflowInput) {
+    acquireLockStep({
+      key: input.order_id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order: OrderDTO = useRemoteQueryStep({
       entry_point: "orders",
       fields: [
@@ -221,6 +213,10 @@ export const confirmDraftOrderEditWorkflow = createWorkflow(
       },
     })
 
+    releaseLockStep({
+      key: input.order_id,
+    })
+
     return new WorkflowResponse(orderPreview)
   }
 )

packages/core/core-flows/src/draft-order/workflows/convert-draft-order.ts

@@ -6,13 +6,15 @@ import {
 import {
   createStep,
   createWorkflow,
+  parallelize,
   StepResponse,
   WorkflowData,
   WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
 import type { IOrderModuleService, OrderDTO } from "@medusajs/framework/types"
 import { emitEventStep, useRemoteQueryStep } from "../../common"
 import { validateDraftOrderStep } from "../steps/validate-draft-order"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const convertDraftOrderWorkflowId = "convert-draft-order"
 
@@ -99,6 +101,12 @@ export const convertDraftOrderWorkflow = createWorkflow(
   function (
     input: WorkflowData<ConvertDraftOrderWorkflowInput>
   ): WorkflowResponse<OrderDTO> {
+    acquireLockStep({
+      key: input.id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const order = useRemoteQueryStep({
       entry_point: "orders",
       fields: ["id", "status", "is_draft_order"],
@@ -113,10 +121,15 @@ export const convertDraftOrderWorkflow = createWorkflow(
 
     const updatedOrder = convertDraftOrderStep({ id: input.id })
 
-    emitEventStep({
-      eventName: OrderWorkflowEvents.PLACED,
-      data: { id: updatedOrder.id },
-    })
+    parallelize(
+      releaseLockStep({
+        key: input.id,
+      }),
+      emitEventStep({
+        eventName: OrderWorkflowEvents.PLACED,
+        data: { id: updatedOrder.id },
+      })
+    )
 
     return new WorkflowResponse(updatedOrder)
   }

packages/core/core-flows/src/draft-order/workflows/delete-draft-order.ts

@@ -1,9 +1,9 @@
 import {
-  WorkflowData,
-  WorkflowResponse,
   createStep,
   createWorkflow,
   transform,
+  WorkflowData,
+  WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
 import type { OrderDTO } from "@medusajs/framework/types"
 import { Modules } from "@medusajs/framework/utils"

packages/core/core-flows/src/draft-order/workflows/refresh-draft-order-adjustments.ts

@@ -16,6 +16,7 @@ import { createDraftOrderShippingMethodAdjustmentsStep } from "../steps/create-d
 import { removeDraftOrderLineItemAdjustmentsStep } from "../steps/remove-draft-order-line-item-adjustments"
 import { removeDraftOrderShippingMethodAdjustmentsStep } from "../steps/remove-draft-order-shipping-method-adjustments"
 import { updateDraftOrderPromotionsStep } from "../steps/update-draft-order-promotions"
+import { acquireLockStep, releaseLockStep } from "../../locking"
 
 export const refreshDraftOrderAdjustmentsWorkflowId =
   "refresh-draft-order-adjustments"
@@ -78,6 +79,12 @@ export interface RefreshDraftOrderAdjustmentsWorkflowInput {
 export const refreshDraftOrderAdjustmentsWorkflow = createWorkflow(
   refreshDraftOrderAdjustmentsWorkflowId,
   function (input: WorkflowData<RefreshDraftOrderAdjustmentsWorkflowInput>) {
+    acquireLockStep({
+      key: input.order.id,
+      timeout: 2,
+      ttl: 10,
+    })
+
     const promotionCodesToApply = getPromotionCodesToApply({
       cart: input.order,
       promo_codes: input.promo_codes,
@@ -118,6 +125,10 @@ export const refreshDraftOrderAdjustmentsWorkflow = createWorkflow(
       })
     )
 
+    releaseLockStep({
+      key: input.order.id,
+    })
+
     return new WorkflowResponse(void 0)
   }
 )