Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core-flows,dashboard,medusa): fixes set of tiny bugs in claims flow #8551

Merged
merged 4 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 116 additions & 13 deletions integration-tests/http/__tests__/claims/claims.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ medusaIntegrationTestRunner({
let baseClaim
let order, order2
let returnShippingOption
let outboundShippingOption
let shippingProfile
let fulfillmentSet
let returnReason
Expand Down Expand Up @@ -348,6 +349,37 @@ medusaIntegrationTestRunner({
],
}

const outboundShippingOptionPayload = {
name: "Oubound shipping",
service_zone_id: fulfillmentSet.service_zones[0].id,
shipping_profile_id: shippingProfile.id,
provider_id: shippingProviderId,
price_type: "flat",
type: {
label: "Test type",
description: "Test description",
code: "test-code",
},
prices: [
{
currency_code: "usd",
amount: 1000,
},
],
rules: [
{
operator: RuleOperator.EQ,
attribute: "is_return",
value: "false",
},
{
operator: RuleOperator.EQ,
attribute: "enabled_in_store",
value: "true",
},
],
}

returnShippingOption = (
await api.post(
"/admin/shipping-options",
Expand All @@ -356,6 +388,14 @@ medusaIntegrationTestRunner({
)
).data.shipping_option

outboundShippingOption = (
await api.post(
"/admin/shipping-options",
outboundShippingOptionPayload,
adminHeaders
)
).data.shipping_option

item = order.items[0]

await api.post(
Expand Down Expand Up @@ -411,30 +451,69 @@ medusaIntegrationTestRunner({
const claimId2 = r2.data.claim.id
const item2 = order2.items[0]

await api.post(
const {
data: {
order_preview: {
items: [previewItem],
},
},
} = await api.post(
`/admin/claims/${claimId2}/inbound/items`,
{ items: [{ id: item2.id, quantity: 1 }] },
adminHeaders
)

// Delete & recreate again to ensure it works for both delete and create
await api.delete(
`/admin/claims/${claimId2}/inbound/items/${previewItem.actions[0].id}`,
adminHeaders
)

const {
data: { return: returnData },
} = await api.post(
`/admin/claims/${claimId2}/inbound/items`,
{ items: [{ id: item2.id, quantity: 1 }] },
adminHeaders
)

await api.post(
`/admin/returns/${returnData.id}`,
{
items: [
{
id: item2.id,
quantity: 1,
},
],
location_id: location.id,
no_notification: true,
},
adminHeaders
)

const {
data: {
order_preview: { shipping_methods: inboundShippingMethods },
},
} = await api.post(
`/admin/claims/${claimId2}/inbound/shipping-method`,
{ shipping_option_id: returnShippingOption.id },
adminHeaders
)
const inboundShippingMethod = inboundShippingMethods.find(
(m) => m.shipping_option_id == returnShippingOption.id
)

// Delete & recreate again to ensure it works for both delete and create
await api.delete(
`/admin/claims/${claimId2}/inbound/shipping-method/${inboundShippingMethod.actions[0].id}`,
adminHeaders
)

await api.post(
`/admin/claims/${claimId2}/inbound/shipping-method`,
{
shipping_option_id: returnShippingOption.id,
},
{ shipping_option_id: returnShippingOption.id },
adminHeaders
)

await api.post(`/admin/claims/${claimId2}/request`, {}, adminHeaders)

const claimId = baseClaim.id

const item = order.items[0]

let result = await api.post(
Expand All @@ -453,9 +532,33 @@ medusaIntegrationTestRunner({

await api.post(
`/admin/claims/${claimId}/inbound/shipping-method`,
{
shipping_option_id: returnShippingOption.id,
{ shipping_option_id: returnShippingOption.id },
adminHeaders
)

const {
data: {
order_preview: { shipping_methods: outboundShippingMethods },
},
} = await api.post(
`/admin/claims/${claimId}/outbound/shipping-method`,
{ shipping_option_id: outboundShippingOption.id },
adminHeaders
)

const outboundShippingMethod = outboundShippingMethods.find(
(m) => m.shipping_option_id == outboundShippingOption.id
)

// Delete & recreate again to ensure it works for both delete and create
await api.delete(
`/admin/claims/${claimId}/outbound/shipping-method/${outboundShippingMethod.actions[0].id}`,
adminHeaders
)

await api.post(
`/admin/claims/${claimId}/outbound/shipping-method`,
{ shipping_option_id: outboundShippingOption.id },
adminHeaders
)

Expand Down
3 changes: 2 additions & 1 deletion packages/admin-next/dashboard/src/hooks/api/claims.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -486,8 +486,9 @@ export const useDeleteClaimOutboundShipping = (
})
}

export const useRequestClaim = (
export const useClaimConfirmRequest = (
id: string,
orderId: string,
options?: UseMutationOptions<
HttpTypes.AdminClaimResponse,
Error,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import {
useAddClaimInboundItems,
useAddClaimInboundShipping,
useCancelClaimRequest,
useClaimConfirmRequest,
useDeleteClaimInboundShipping,
useRemoveClaimInboundItem,
useUpdateClaimInboundItem,
Expand Down Expand Up @@ -86,15 +87,16 @@ export const ClaimCreateForm = ({
* MUTATIONS
*/
// TODO: implement confirm claim request
const { mutateAsync: confirmClaimRequest, isPending: isConfirming } = {} // useConfirmClaimRequest(claim.id, order.id)
const { mutateAsync: confirmClaimRequest, isPending: isConfirming } =
useClaimConfirmRequest(claim.id, order.id)

const { mutateAsync: cancelClaimRequest, isPending: isCanceling } =
useCancelClaimRequest(claim.id, order.id)

// TODO: implement update claim request

const { mutateAsync: updateReturn, isPending: isUpdating } = useUpdateReturn(
claim.return_id!,
preview?.order_change?.return_id!,
order.id
)

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { IOrderModuleService, UpdateOrderChangeDTO } from "@medusajs/types"
import {
ModuleRegistrationName,
getSelectsAndRelationsFromObjectArray,
} from "@medusajs/utils"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"

export const updateOrderChangesStepId = "update-order-shopping-methods"
/**
* This step updates order change.
*/
export const updateOrderChangesStep = createStep(
updateOrderChangesStepId,
async (data: UpdateOrderChangeDTO[], { container }) => {
const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)

const { selects, relations } = getSelectsAndRelationsFromObjectArray(data, {
objectFields: ["metadata"],
})

const dataBeforeUpdate = await service.listOrderChanges(
{ id: data.map((d) => d.id) },
{ relations, select: selects }
)

const updated = await service.updateOrderChanges(data)

return new StepResponse(updated, dataBeforeUpdate)
},
async (dataBeforeUpdate, { container }) => {
if (!dataBeforeUpdate?.length) {
return
}

const service = container.resolve<IOrderModuleService>(
ModuleRegistrationName.ORDER
)

await service.updateOrderChanges(dataBeforeUpdate as UpdateOrderChangeDTO[])
}
)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { StepResponse, createStep } from "@medusajs/workflows-sdk"

export const updateOrderShippingMethodsStepId = "update-order-shopping-methods"
/**
* This step updats order shipping methods.
* This step updates order shipping methods.
*/
export const updateOrderShippingMethodsStep = createStep(
updateOrderShippingMethodsStepId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { updateOrderClaimsStep } from "../../steps/claim/update-order-claims"
import { createOrderChangeActionsStep } from "../../steps/create-order-change-actions"
import { previewOrderChangeStep } from "../../steps/preview-order-change"
import { createReturnsStep } from "../../steps/return/create-returns"
import { updateOrderChangesStep } from "../../steps/update-order-changes"
import {
throwIfIsCancelled,
throwIfItemsDoesNotExistsInOrder,
Expand Down Expand Up @@ -121,6 +122,17 @@ export const orderClaimRequestItemReturnWorkflow = createWorkflow(
name: "order-change-query",
})

when({ createdReturn }, ({ createdReturn }) => {
return !!createdReturn?.length
}).then(() => {
updateOrderChangesStep([
{
id: orderChange.id,
return_id: createdReturn?.[0]?.id,
},
])
})

orderClaimRequestItemReturnValidationStep({
order,
items: input.items,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ function prepareFulfillmentData({
order.items!.map((i) => [i.id, i])
)
const fulfillmentItems = items.map((i) => {
const orderItem = orderItemsMap.get(i.item_id) ?? i.item
const orderItem = orderItemsMap.get(i.id) ?? i.item

return {
line_item_id: i.item_id,
quantity: !isReturn ? i.quantity : undefined,
return_quantity: isReturn ? i.quantity : undefined,
quantity: i.quantity,
title: orderItem.variant_title ?? orderItem.title,
sku: orderItem.variant_sku || "",
barcode: orderItem.variant_barcode || "",
Expand Down Expand Up @@ -160,7 +160,7 @@ function extractShippingOption({ orderPreview, orderClaim, returnId }) {

for (const action of modifiedShippingMethod_.actions) {
if (action.action === ChangeActionType.SHIPPING_ADD) {
if (action.return_id === returnId) {
if (action.return?.id === returnId) {
returnShippingMethod = shippingMethod
} else if (action.claim_id === orderClaim.id) {
claimShippingMethod = shippingMethod
Expand All @@ -181,7 +181,9 @@ export const confirmClaimRequestWorkflowId = "confirm-claim-request"
*/
export const confirmClaimRequestWorkflow = createWorkflow(
confirmClaimRequestWorkflowId,
function (input: ConfirmClaimRequestWorkflowInput): WorkflowResponse<OrderDTO> {
function (
input: ConfirmClaimRequestWorkflowInput
): WorkflowResponse<OrderDTO> {
const orderClaim: OrderClaimDTO = useRemoteQueryStep({
entry_point: "order_claim",
fields: ["id", "status", "order_id", "canceled_at"],
Expand All @@ -196,11 +198,8 @@ export const confirmClaimRequestWorkflow = createWorkflow(
"id",
"version",
"canceled_at",
"items.id",
"items.title",
"items.variant_title",
"items.variant_sku",
"items.variant_barcode",
"items.*",
"items.item.id",
"shipping_address.*",
],
variables: { id: orderClaim.order_id },
Expand Down
5 changes: 5 additions & 0 deletions packages/core/types/src/order/mutations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -922,6 +922,11 @@ export interface UpdateOrderChangeDTO {
*/
description?: string

/**
* The associated return's ID.
*/
return_id?: string | null

/**
* The internal note of the order change.
*/
Expand Down
Loading
Loading