fix(core-flows): customer id filter not working in getOrderDetails (medusajs#13695)

As discussed, fixed the get order detail and also changed the remotequery to graph a bunch of workflows

Author: willbouch

.changeset/little-falcons-count.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/core-flows": patch
+---
+
+fix(core-flows): customer id filter not working in getOrderDetails

integration-tests/modules/__tests__/order/workflows/get-order-detail.spec.ts

@@ -0,0 +1,72 @@
+import { getOrderDetailWorkflow } from "@medusajs/core-flows"
+import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
+import { OrderDTO } from "@medusajs/types"
+import { createOrderFixture, prepareDataFixtures } from "./__fixtures__"
+
+jest.setTimeout(50000)
+
+medusaIntegrationTestRunner({
+  env: {},
+  testSuite: ({ getContainer }) => {
+    let container
+
+    beforeAll(() => {
+      container = getContainer()
+    })
+
+    describe("Get order detail workflow", () => {
+      let order: OrderDTO
+
+      describe("createOrderChangeWorkflow", () => {
+        beforeEach(async () => {
+          const fixtures = await prepareDataFixtures({
+            container,
+          })
+
+          order = await createOrderFixture({
+            container,
+            product: fixtures.product,
+            location: fixtures.location,
+            inventoryItem: fixtures.inventoryItem,
+          })
+        })
+
+        it("should get an order based on filters", async () => {
+          const response = await getOrderDetailWorkflow(container).run({
+            input: {
+              fields: [],
+              filters: {
+                customer_id: order.customer_id ?? "",
+              },
+              order_id: order.id,
+            },
+            throwOnError: false,
+          })
+
+          expect(response).toBeDefined()
+        })
+
+        it("should throw an error when getting order if none is found with the provided customer id", async () => {
+          const {
+            errors: [error],
+          } = await getOrderDetailWorkflow(container).run({
+            input: {
+              fields: [],
+              filters: {
+                customer_id: "wrong-id",
+              },
+              order_id: order.id,
+            },
+            throwOnError: false,
+          })
+
+          expect(error.error).toEqual(
+            expect.objectContaining({
+              message: `Order id not found: ${order.id}`,
+            })
+          )
+        })
+      })
+    })
+  },
+})

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

@@ -21,7 +21,7 @@ import { requiredVariantFieldsForInventoryConfirmation } from "../../cart/utils/
 import { pricingContextResult } from "../../cart/utils/schemas"
 import { confirmVariantInventoryWorkflow } from "../../cart/workflows/confirm-variant-inventory"
 import { getVariantsAndItemsWithPrices } from "../../cart/workflows/get-variants-and-items-with-prices"
-import { useRemoteQueryStep } from "../../common"
+import { useQueryGraphStep } from "../../common"
 import { createOrderLineItemsStep } from "../steps"
 import { productVariantsFields } from "../utils/fields"
 
@@ -98,8 +98,9 @@ export const addOrderLineItemsWorkflow = createWorkflow(
       OrderWorkflow.OrderAddLineItemWorkflowInput & AdditionalData
     >
   ) => {
-    const order = useRemoteQueryStep({
-      entry_point: "orders",
+    const { data: order } = useQueryGraphStep({
+      entity: "order",
+      filters: { id: input.order_id },
       fields: [
         "id",
         "sales_channel_id",
@@ -108,9 +109,7 @@ export const addOrderLineItemsWorkflow = createWorkflow(
         "email",
         "currency_code",
       ],
-      variables: { id: input.order_id },
-      list: false,
-      throw_if_key_not_found: true,
+      options: { throwIfKeyNotFound: true, isList: false },
     }).config({ name: "order-query" })
 
     const variantIds = transform({ input }, (data) => {

packages/core/core-flows/src/order/workflows/cancel-order-fulfillment.ts

@@ -16,24 +16,30 @@ import {
   OrderWorkflowEvents,
 } from "@medusajs/framework/utils"
 import {
-  WorkflowData,
-  WorkflowResponse,
   createHook,
   createStep,
   createWorkflow,
   parallelize,
   transform,
+  WorkflowData,
+  WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
-import { emitEventStep, useRemoteQueryStep } from "../../common"
+import {
+  emitEventStep,
+  useQueryGraphStep,
+  useRemoteQueryStep,
+} from "../../common"
 import { cancelFulfillmentWorkflow } from "../../fulfillment"
 import { adjustInventoryLevelsStep } from "../../inventory"
 import { cancelOrderFulfillmentStep } from "../steps/cancel-fulfillment"
 import {
   throwIfItemsDoesNotExistsInOrder,
   throwIfOrderIsCancelled,
 } from "../utils/order-validation"
-import { createReservationsStep } from "../../reservation"
-import { updateReservationsStep } from "../../reservation"
+import {
+  createReservationsStep,
+  updateReservationsStep,
+} from "../../reservation"
 
 type OrderItemWithVariantDTO = OrderLineItemDTO & {
   variant?: ProductVariantDTO & {
@@ -307,31 +313,29 @@ export const cancelOrderFulfillmentWorkflowId = "cancel-order-fulfillment"
 export const cancelOrderFulfillmentWorkflow = createWorkflow(
   cancelOrderFulfillmentWorkflowId,
   (input: WorkflowData<CancelOrderFulfillmentWorkflowInput>) => {
-    const order: OrderDTO & { fulfillments: FulfillmentDTO[] } =
-      useRemoteQueryStep({
-        entry_point: "orders",
-        fields: [
-          "id",
-          "status",
-          "items.id",
-          "items.quantity",
-          "items.variant.allow_backorder",
-          "items.variant.manage_inventory",
-          "items.variant.inventory_items.inventory.id",
-          "items.variant.inventory_items.required_quantity",
-          "fulfillments.id",
-          "fulfillments.canceled_at",
-          "fulfillments.shipped_at",
-          "fulfillments.location_id",
-          "fulfillments.items.id",
-          "fulfillments.items.quantity",
-          "fulfillments.items.line_item_id",
-          "fulfillments.items.inventory_item_id",
-        ],
-        variables: { id: input.order_id },
-        list: false,
-        throw_if_key_not_found: true,
-      })
+    const { data: order } = useQueryGraphStep({
+      entity: "order",
+      filters: { id: input.order_id },
+      fields: [
+        "id",
+        "status",
+        "items.id",
+        "items.quantity",
+        "items.variant.allow_backorder",
+        "items.variant.manage_inventory",
+        "items.variant.inventory_items.inventory.id",
+        "items.variant.inventory_items.required_quantity",
+        "fulfillments.id",
+        "fulfillments.canceled_at",
+        "fulfillments.shipped_at",
+        "fulfillments.location_id",
+        "fulfillments.items.id",
+        "fulfillments.items.quantity",
+        "fulfillments.items.line_item_id",
+        "fulfillments.items.inventory_item_id",
+      ],
+      options: { throwIfKeyNotFound: true, isList: false },
+    }).config({ name: "get-order" })
 
     cancelOrderFulfillmentValidateOrder({ order, input })
 

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

@@ -5,21 +5,21 @@ import {
   PaymentCollectionDTO,
 } from "@medusajs/framework/types"
 import {
+  deepFlatMap,
   MathBN,
   MedusaError,
   OrderWorkflowEvents,
   PaymentCollectionStatus,
-  deepFlatMap,
 } from "@medusajs/framework/utils"
 import {
-  WorkflowData,
-  WorkflowResponse,
   createHook,
   createStep,
   createWorkflow,
   parallelize,
   transform,
   when,
+  WorkflowData,
+  WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
 import { emitEventStep, useQueryGraphStep } from "../../common"
 import { updatePaymentCollectionStep } from "../../payment-collection"
@@ -47,14 +47,14 @@ export type CancelValidateOrderStepInput = {
 /**
  * This step validates that an order can be canceled. If the order has fulfillments that
  * aren't canceled, or the order was canceled previously, the step throws an error.
- * 
+ *
  * :::note
- * 
+ *
  * You can retrieve an order's details using [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query),
  * or [useQueryGraphStep](https://docs.medusajs.com/resources/references/medusa-workflows/steps/useQueryGraphStep).
- * 
+ *
  * :::
- * 
+ *
  * @example
  * const data = cancelValidateOrder({
  *   order: {
@@ -68,9 +68,7 @@ export type CancelValidateOrderStepInput = {
  */
 export const cancelValidateOrder = createStep(
   "cancel-validate-order",
-  ({
-    order,
-  }: CancelValidateOrderStepInput) => {
+  ({ order }: CancelValidateOrderStepInput) => {
     const order_ = order as OrderDTO & {
       payment_collections: PaymentCollectionDTO[]
       fulfillments: FulfillmentDTO[]
@@ -102,33 +100,33 @@ export const cancelOrderWorkflowId = "cancel-order"
  * This workflow cancels an order. An order can only be canceled if it doesn't have
  * any fulfillments, or if all fulfillments are canceled. The workflow will also cancel
  * any uncaptured payments, and refund any captured payments.
- * 
+ *
  * This workflow is used by the [Cancel Order Admin API Route](https://docs.medusajs.com/api/admin#orders_postordersidcancel).
- * 
- * This workflow has a hook that allows you to perform custom actions on the canceled order. For example, you can 
+ *
+ * This workflow has a hook that allows you to perform custom actions on the canceled order. For example, you can
  * make changes to custom models linked to the order.
- * 
+ *
  * You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling an order.
- * 
+ *
  * @example
  * const { result } = await cancelOrderWorkflow(container)
  * .run({
  *   input: {
  *     order_id: "order_123",
  *   }
  * })
- * 
+ *
  * @summary
- * 
+ *
  * Cancel an order.
- * 
+ *
  * @property hooks.orderCanceled - This hook is executed after the order is canceled. You can consume this hook to perform custom actions on the canceled order.
  */
 export const cancelOrderWorkflow = createWorkflow(
   cancelOrderWorkflowId,
   (input: WorkflowData<OrderWorkflow.CancelOrderWorkflowInput>) => {
     const orderQuery = useQueryGraphStep({
-      entity: "orders",
+      entity: "order",
       fields: [
         "id",
         "status",
@@ -143,7 +141,7 @@ export const cancelOrderWorkflow = createWorkflow(
       ],
       filters: { id: input.order_id },
       options: { throwIfKeyNotFound: true },
-    }).config({ name: "get-cart" })
+    }).config({ name: "get-order" })
 
     const order = transform(
       { orderQuery },

packages/core/core-flows/src/order/workflows/create-fulfillment.ts

@@ -18,17 +18,18 @@ import {
   OrderWorkflowEvents,
 } from "@medusajs/framework/utils"
 import {
-  WorkflowData,
-  WorkflowResponse,
   createHook,
   createStep,
   createWorkflow,
   parallelize,
   transform,
+  WorkflowData,
+  WorkflowResponse,
 } from "@medusajs/framework/workflows-sdk"
 import {
   createRemoteLinkStep,
   emitEventStep,
+  useQueryGraphStep,
   useRemoteQueryStep,
 } from "../../common"
 import { createFulfillmentWorkflow } from "../../fulfillment"
@@ -393,8 +394,9 @@ export const createOrderFulfillmentWorkflowId = "create-order-fulfillment"
 export const createOrderFulfillmentWorkflow = createWorkflow(
   createOrderFulfillmentWorkflowId,
   (input: WorkflowData<CreateOrderFulfillmentWorkflowInput>) => {
-    const order: OrderDTO = useRemoteQueryStep({
-      entry_point: "orders",
+    const { data: order } = useQueryGraphStep({
+      entity: "order",
+      filters: { id: input.order_id },
       fields: [
         "id",
         "display_id",
@@ -444,10 +446,8 @@ export const createOrderFulfillmentWorkflow = createWorkflow(
         "shipping_methods.data",
         "shipping_methods.amount",
       ],
-      variables: { id: input.order_id },
-      list: false,
-      throw_if_key_not_found: true,
-    })
+      options: { throwIfKeyNotFound: true, isList: false },
+    }).config({ name: "get-order" })
 
     createFulfillmentValidateOrder({ order, inputItems: input.items })