feat(medusa/product-export-strategy): Implement the Product export strategy (#1688)

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

@@ -12,7 +12,7 @@ Object {
       "id": "job_3",
       "result": null,
       "status": "created",
-      "type": "batch_2",
+      "type": "product-export",
       "updated_at": Any<String>,
     },
     Object {
@@ -24,7 +24,7 @@ Object {
       "id": "job_2",
       "result": null,
       "status": "created",
-      "type": "batch_2",
+      "type": "product-export",
       "updated_at": Any<String>,
     },
     Object {
@@ -36,7 +36,7 @@ Object {
       "id": "job_1",
       "result": null,
       "status": "created",
-      "type": "batch_1",
+      "type": "product-export",
       "updated_at": Any<String>,
     },
   ],
@@ -51,7 +51,26 @@ Object {
   "canceled_at": null,
   "completed_at": null,
   "confirmed_at": null,
-  "context": Object {},
+  "context": Object {
+    "list_config": Object {
+      "order": Object {
+        "created_at": "DESC",
+      },
+      "relations": Array [
+        "variants",
+        "variants.prices",
+        "variants.options",
+        "images",
+        "options",
+        "tags",
+        "type",
+        "collection",
+        "variants.prices.region",
+      ],
+      "skip": 0,
+      "take": 50,
+    },
+  },
   "created_at": Any<String>,
   "created_by": "admin_user",
   "deleted_at": null,
@@ -62,7 +81,7 @@ Object {
   "processing_at": null,
   "result": null,
   "status": "created",
-  "type": "batch_1",
+  "type": "product-export",
   "updated_at": Any<String>,
 }
 `;
@@ -83,7 +102,7 @@ Object {
   "processing_at": null,
   "result": null,
   "status": "canceled",
-  "type": "batch_1",
+  "type": "product-export",
   "updated_at": Any<String>,
 }
 `;

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

@@ -24,25 +24,23 @@ const setupJobDb = async (dbConnection) => {
 
     await simpleBatchJobFactory(dbConnection, {
       id: "job_1",
-      type: "batch_1",
+      type: "product-export",
       created_by: "admin_user",
     })
     await simpleBatchJobFactory(dbConnection, {
       id: "job_2",
-      type: "batch_2",
-      ready_at: new Date(),
+      type: "product-export",
       created_by: "admin_user",
     })
     await simpleBatchJobFactory(dbConnection, {
       id: "job_3",
-      type: "batch_2",
-      ready_at: new Date(),
+      type: "product-export",
       created_by: "admin_user",
     })
     await simpleBatchJobFactory(dbConnection, {
       id: "job_4",
-      type: "batch_1",
-      ready_at: new Date(),
+      type: "product-export",
+      status: "awaiting_confirmation",
       created_by: "member-user",
     })
   } catch (err) {
@@ -142,16 +140,11 @@ describe("/admin/batch-jobs", () => {
   })
 
   describe("POST /admin/batch-jobs/", () => {
-    beforeEach(async() => {
-      try {
-        await adminSeeder(dbConnection)
-      } catch (err) {
-        console.log(err)
-        throw err
-      }
+    beforeEach(async () => {
+      await setupJobDb(dbConnection)
     })
 
-    afterEach(async() => {
+    afterEach(async () => {
       const db = useDb()
       await db.teardown()
     })
@@ -162,7 +155,7 @@ describe("/admin/batch-jobs", () => {
       const response = await api.post(
         "/admin/batch-jobs",
         {
-          type: "batch_1",
+          type: "product-export",
           context: {},
         },
         adminReqConfig
@@ -212,7 +205,7 @@ describe("/admin/batch-jobs", () => {
         await setupJobDb(dbConnection)
         await simpleBatchJobFactory(dbConnection, {
           id: "job_complete",
-          type: "batch_1",
+          type: "product-export",
           created_by: "admin_user",
           completed_at: new Date(),
         })
@@ -222,7 +215,7 @@ describe("/admin/batch-jobs", () => {
       }
     })
 
-    afterEach(async () => {
+    afterEach(async() => {
       const db = useDb()
       await db.teardown()
     })

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

@@ -0,0 +1,150 @@
+const path = require("path")
+const fs = require('fs/promises')
+
+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 userSeeder = require("../../../helpers/user-seeder")
+const productSeeder = require("../../../helpers/product-seeder")
+
+const adminReqConfig = {
+  headers: {
+    Authorization: "Bearer test_token",
+  },
+}
+
+jest.setTimeout(1000000)
+
+describe("Batch job of product-export type", () => {
+  let medusaProcess
+  let dbConnection
+
+  beforeAll(async () => {
+    const cwd = path.resolve(path.join(__dirname, "..", "..", ".."))
+    dbConnection = await initDb({ cwd })
+    medusaProcess = await setupServer({
+      cwd,
+      redisUrl: "redis://127.0.0.1:6379",
+      uploadDir: __dirname,
+      verbose: false
+    })
+  })
+
+  let exportFilePath = ""
+
+  afterAll(async () => {
+    const db = useDb()
+    await db.shutdown()
+
+    medusaProcess.kill()
+  })
+
+  beforeEach(async () => {
+    try {
+      await productSeeder(dbConnection)
+      await adminSeeder(dbConnection)
+      await userSeeder(dbConnection)
+    } catch (e) {
+      console.log(e)
+      throw e
+    }
+  })
+
+  afterEach(async() => {
+    const db = useDb()
+    await db.teardown()
+
+    const isFileExists = (await fs.stat(exportFilePath))?.isFile()
+    if (isFileExists) {
+      await fs.unlink(exportFilePath)
+    }
+  })
+
+  it('should export a csv file containing the expected products', async () => {
+    jest.setTimeout(1000000)
+    const api = useApi()
+
+    const productPayload = {
+      title: "Test export product",
+      description: "test-product-description",
+      type: { value: "test-type" },
+      images: ["test-image.png", "test-image-2.png"],
+      collection_id: "test-collection",
+      tags: [{ value: "123" }, { value: "456" }],
+      options: [{ title: "size" }, { title: "color" }],
+      variants: [
+        {
+          title: "Test variant",
+          inventory_quantity: 10,
+          sku: "test-variant-sku-product-export",
+          prices: [
+            {
+              currency_code: "usd",
+              amount: 100,
+            },
+            {
+              currency_code: "eur",
+              amount: 45,
+            },
+            {
+              currency_code: "dkk",
+              amount: 30,
+            },
+          ],
+          options: [{ value: "large" }, { value: "green" }],
+        },
+      ],
+    }
+    const createProductRes =
+      await api.post("/admin/products", productPayload, adminReqConfig)
+    const productId = createProductRes.data.product.id
+    const variantId = createProductRes.data.product.variants[0].id
+
+    const batchPayload = {
+      type: "product-export",
+      context: {
+        filterable_fields: { title: "Test export product" }
+      },
+    }
+    const batchJobRes = await api.post("/admin/batch-jobs", batchPayload, adminReqConfig)
+    const batchJobId = batchJobRes.data.batch_job.id
+
+    expect(batchJobId).toBeTruthy()
+
+    // Pull to check the status until it is completed
+    let batchJob;
+    let shouldContinuePulling = true
+    while (shouldContinuePulling) {
+      const res = await api
+      .get(`/admin/batch-jobs/${batchJobId}`, adminReqConfig)
+
+      await new Promise((resolve, _) => {
+        setTimeout(resolve, 1000)
+      })
+
+      batchJob = res.data.batch_job
+      shouldContinuePulling = !(batchJob.status === "completed")
+    }
+
+    exportFilePath = path.resolve(__dirname, batchJob.result.file_key)
+    const isFileExists = (await fs.stat(exportFilePath)).isFile()
+
+    expect(isFileExists).toBeTruthy()
+
+    const data = (await fs.readFile(exportFilePath)).toString()
+    const [, ...lines] = data.split("\r\n").filter(l => l)
+
+    expect(lines.length).toBe(1)
+
+    const lineColumn = lines[0].split(";")
+
+    expect(lineColumn[0]).toBe(productId)
+    expect(lineColumn[2]).toBe(productPayload.title)
+    expect(lineColumn[4]).toBe(productPayload.description)
+    expect(lineColumn[23]).toBe(variantId)
+    expect(lineColumn[24]).toBe(productPayload.variants[0].title)
+    expect(lineColumn[25]).toBe(productPayload.variants[0].sku)
+  })
+})