Feat(medusa): request order edit (#2239)

**What** - Implement `admin/order-edits/:id/request` Fixes CORE-499
2022-09-22 10:17:00 +00:00
parent 14e808c724
commit 6da29c72c4
12 changed files with 428 additions and 14 deletions
@@ -0,0 +1,39 @@
+import { IdMap } from "medusa-test-utils"
+import { request } from "../../../../../helpers/test-request"
+import { orderEditServiceMock } from "../../../../../services/__mocks__/order-edit"
+import OrderEditingFeatureFlag from "../../../../../loaders/feature-flags/order-editing"
+
+describe("GET /admin/order-edits/:id", () => {
+  describe("successfully requests an order edit confirmation", () => {
+    const orderEditId = IdMap.getId("testRequestOrder")
+    let subject
+
+    beforeAll(async () => {
+      subject = await request("POST", `/admin/order-edits/${orderEditId}/request`, {
+        adminSession: {
+          jwt: {
+            userId: IdMap.getId("admin_user"),
+          },
+        },
+        flags: [OrderEditingFeatureFlag],
+      })
+    })
+
+    afterAll(() => {
+      jest.clearAllMocks()
+    })
+
+    it("calls orderEditService requestConfirmation", () => {
+      expect(orderEditServiceMock.requestConfirmation).toHaveBeenCalledTimes(1)
+      expect(orderEditServiceMock.requestConfirmation).toHaveBeenCalledWith(orderEditId, {loggedInUser: IdMap.getId("admin_user")})
+    })
+
+    it("returns updated orderEdit", () => {
+      expect(subject.body.order_edit).toEqual(expect.objectContaining({
+        id: orderEditId, 
+        requested_at: expect.any(String),
+        requested_by: IdMap.getId("admin_user")
+      }))
+    })
+  })
+})
@@ -53,6 +53,10 @@ export default (app) => {
    middlewares.wrap(require("./delete-order-edit-item-change").default)
  )

+  route.post(
+    "/:id/request",
+    middlewares.wrap(require("./request-confirmation").default)
+  )
  return app
 }

@@ -0,0 +1,79 @@
+import { EntityManager } from "typeorm"
+import { OrderEditService } from "../../../../services"
+import {
+  defaultOrderEditFields,
+  defaultOrderEditRelations,
+} from "../../../../types/order-edit"
+
+/**
+ * @oas [post] /order-edits/{id}/request
+ * operationId: "PostOrderEditsOrderEditRequest"
+ * summary: "Request order edit confirmation"
+ * description: "Request customer confirmation of an Order Edit"
+ * x-authenticated: true
+ * parameters:
+ *   - (path) id=* {string} The ID of the Order Edit to request confirmation from.
+ * 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.orderEdits.requestConfirmation(edit_id)
+ *         .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}/request' \
+ *       --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, res) => {
+  const { id } = req.params
+
+  const orderEditService: OrderEditService =
+    req.scope.resolve("orderEditService")
+
+  const manager: EntityManager = req.scope.resolve("manager")
+
+  const loggedInUser = (req.user?.id ?? req.user?.userId) as string
+
+  await manager.transaction(async (transactionManager) => {
+    await orderEditService
+      .withTransaction(transactionManager)
+      .requestConfirmation(id, { loggedInUser })
+  })
+
+  const orderEdit = await orderEditService.retrieve(id, {
+    relations: defaultOrderEditRelations,
+    select: defaultOrderEditFields,
+  })
+
+  res.status(200).send({
+    order_edit: orderEdit,
+  })
+}