feat(medusa): List batch jobs + Introduce composable handler pattern (#1541)

integration-tests/api/__tests__/batch-jobs/__snapshots__/api.js.snap

@@ -0,0 +1,44 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`/admin/batch GET /admin/batch lists batch jobs created by the user 1`] = `
+Object {
+  "batch_jobs": Array [
+    Object {
+      "context": Object {},
+      "created_at": Any<String>,
+      "created_by": "admin_user",
+      "deleted_at": null,
+      "id": "job_3",
+      "result": null,
+      "status": "created",
+      "type": "batch_2",
+      "updated_at": Any<String>,
+    },
+    Object {
+      "context": Object {},
+      "created_at": Any<String>,
+      "created_by": "admin_user",
+      "deleted_at": null,
+      "id": "job_2",
+      "result": null,
+      "status": "created",
+      "type": "batch_2",
+      "updated_at": Any<String>,
+    },
+    Object {
+      "context": Object {},
+      "created_at": Any<String>,
+      "created_by": "admin_user",
+      "deleted_at": null,
+      "id": "job_1",
+      "result": null,
+      "status": "created",
+      "type": "batch_1",
+      "updated_at": Any<String>,
+    },
+  ],
+  "count": 3,
+  "limit": 10,
+  "offset": 0,
+}
+`;

integration-tests/api/__tests__/batch-jobs/api.js

@@ -0,0 +1,94 @@
+const path = require("path")
+
+const setupServer = require("../../../helpers/setup-server")
+const { useApi } = require("../../../helpers/use-api")
+const { initDb, useDb } = require("../../../helpers/use-db")
+
+const adminSeeder = require("../../helpers/admin-seeder")
+const { simpleBatchJobFactory } = require("../../factories")
+
+jest.setTimeout(50000)
+
+const adminReqConfig = {
+  headers: {
+    Authorization: "Bearer test_token",
+  },
+}
+
+describe("/admin/batch", () => {
+  let medusaProcess
+  let dbConnection
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", ".."))
+    dbConnection = await initDb({ cwd })
+    medusaProcess = await setupServer({ cwd, verbose: false })
+  })
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+
+    medusaProcess.kill()
+  })
+
+  describe("GET /admin/batch", () => {
+    beforeEach(async () => {
+      try {
+        await simpleBatchJobFactory(dbConnection, {
+          id: "job_1",
+          type: "batch_1",
+          created_by: "admin_user",
+        })
+        await simpleBatchJobFactory(dbConnection, {
+          id: "job_2",
+          type: "batch_2",
+          created_by: "admin_user",
+        })
+        await simpleBatchJobFactory(dbConnection, {
+          id: "job_3",
+          type: "batch_2",
+          created_by: "admin_user",
+        })
+        await simpleBatchJobFactory(dbConnection, {
+          id: "job_4",
+          type: "batch_1",
+          created_by: "not_this_user",
+        })
+        await adminSeeder(dbConnection)
+      } catch (err) {
+        console.log(err)
+        throw err
+      }
+    })
+
+    afterEach(async () => {
+      const db = useDb()
+      await db.teardown()
+    })
+
+    it("lists batch jobs created by the user", async () => {
+      const api = useApi()
+      const response = await api.get("/admin/batch", adminReqConfig)
+
+      expect(response.status).toEqual(200)
+      expect(response.data.batch_jobs.length).toEqual(3)
+      expect(response.data).toMatchSnapshot({
+        batch_jobs: [
+          {
+            created_at: expect.any(String),
+            updated_at: expect.any(String),
+          },
+          {
+            created_at: expect.any(String),
+            updated_at: expect.any(String),
+          },
+          {
+            created_at: expect.any(String),
+            updated_at: expect.any(String),
+          },
+        ],
+      })
+    })
+  })
+})

integration-tests/api/factories/index.ts

@@ -1,4 +1,5 @@
 export * from "./simple-payment-factory"
+export * from "./simple-batch-job-factory"
 export * from "./simple-order-factory"
 export * from "./simple-cart-factory"
 export * from "./simple-region-factory"

integration-tests/api/factories/simple-batch-job-factory.ts

@@ -0,0 +1,27 @@
+import { Connection } from "typeorm"
+import { BatchJob, BatchJobStatus } from "@medusajs/medusa"
+
+export type BatchJobFactoryData = {
+  id?: string
+  type?: string
+  status?: BatchJobStatus
+  created_by?: string
+  context?: Record<string, unknown>
+}
+
+export const simpleBatchJobFactory = async (
+  connection: Connection,
+  data: BatchJobFactoryData = {}
+): Promise<BatchJob> => {
+  const manager = connection.manager
+
+  const job = manager.create(BatchJob, {
+    id: data.id,
+    status: data.status ?? BatchJobStatus.CREATED,
+    type: data.type ?? "test-job",
+    created_by: data.created_by ?? null,
+    context: data.context ?? {},
+  })
+
+  return await manager.save(job)
+}