Feat(medusa): cancel order edit (#2240)

**What**
- cancel an order edit

Fixes CORE-500
This commit is contained in:
Philip Korsholm
2022-09-27 03:13:15 +00:00
committed by GitHub
parent d138baf460
commit 1807bff029
12 changed files with 393 additions and 16 deletions
@@ -0,0 +1,43 @@
import { IdMap } from "medusa-test-utils"
import { request } from "../../../../../helpers/test-request"
import OrderEditingFeatureFlag from "../../../../../loaders/feature-flags/order-editing"
import { orderEditServiceMock } from "../../../../../services/__mocks__/order-edit"
describe("POST /admin/order-edits/:id/cancel", () => {
describe("cancels an order edit", () => {
const orderEditId = IdMap.getId("testCancelOrderEdit")
let subject
beforeAll(async () => {
subject = await request("POST", `/admin/order-edits/${orderEditId}/cancel`, {
adminSession: {
jwt: {
userId: IdMap.getId("admin_user"),
},
},
flags: [OrderEditingFeatureFlag],
})
})
afterAll(() => {
jest.clearAllMocks()
})
it("calls orderService cancel", () => {
expect(orderEditServiceMock.cancel).toHaveBeenCalledTimes(1)
expect(orderEditServiceMock.cancel).toHaveBeenCalledWith(orderEditId, {loggedInUser: IdMap.getId("admin_user")})
})
it("returns 200", () => {
expect(subject.status).toEqual(200)
})
it("returns cancel result", () => {
expect(subject.body.order_edit).toEqual(expect.objectContaining({
id: orderEditId,
canceled_at: expect.any(String),
status: 'canceled'
}))
})
})
})
@@ -0,0 +1,73 @@
import { Request, Response } from "express"
import { OrderEditService } from "../../../../services"
import { IsOptional, IsString } from "class-validator"
import { EntityManager } from "typeorm"
/**
* @oas [post] /order-edits/{id}/cancel
* operationId: "PostOrderEditsOrderEditCancel"
* summary: "Cancel an OrderEdit"
* description: "Cancels an OrderEdit."
* x-authenticated: true
* parameters:
* - (path) id=* {string} The ID of the OrderEdit.
* x-codeSamples:
* - lang: JavaScript
* label: JS Client
* source: |
* import Medusa from "@medusajs/medusa-js"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.orderEdit.cancel(orderEditId)
* .then(({ order_edit }) => {
* console.log(order_edit.id)
* })
* - lang: Shell
* label: cURL
* source: |
* curl --location --request POST 'https://medusa-url.com/admin/order-edits/:id/cancel' \
* --header 'Authorization: Bearer {api_token}'
* security:
* - api_token: []
* - cookie_auth: []
* tags:
* - OrderEdit
* responses:
* 200:
* description: OK
* content:
* application/json:
* schema:
* properties:
* order_edit:
* $ref: "#/components/schemas/order_edit"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "500":
* $ref: "#/components/responses/500_error"
*/
export default async (req: Request, res: Response) => {
const { id } = req.params
const orderEditService = req.scope.resolve(
"orderEditService"
) as OrderEditService
const manager = req.scope.resolve("manager") as EntityManager
const userId = req.user?.id ?? req.user?.userId
await manager.transaction(async (transactionManager) => {
await orderEditService
.withTransaction(transactionManager)
.cancel(id, { loggedInUser: userId })
})
const orderEdit = await orderEditService.retrieve(id)
return res.json({ order_edit: orderEdit })
}
@@ -11,7 +11,7 @@ import {
* @oas [post] /order-edits
* operationId: "PostOrderEdits"
* summary: "Create an OrderEdit"
* description: "Created a OrderEdit."
* description: "Creates an OrderEdit."
* x-authenticated: true
* x-codeSamples:
* - lang: JavaScript
@@ -46,6 +46,11 @@ export default (app) => {
middlewares.wrap(require("./update-order-edit").default)
)
route.post(
"/:id/cancel",
middlewares.wrap(require("./cancel-order-edit").default)
)
route.delete("/:id", middlewares.wrap(require("./delete-order-edit").default))
route.delete(