feat(index): Add http/module api to interact with the index engine (#13869)

* feat(index): Add support to trigger sync manually

* feat(index): Add API route to interact with

* feat(index): Add API route to interact with

* feat(index): Add API route to interact with

* test(): Add http integration tests

* Create weak-elephants-reply.md

integration-tests/http/__tests__/index/index.spec.ts

@@ -0,0 +1,162 @@
+import { medusaIntegrationTestRunner } from "@medusajs/test-utils"
+import {
+  adminHeaders,
+  createAdminUser,
+} from "../../../helpers/create-admin-user"
+import { setTimeout } from "timers/promises"
+
+process.env.ENABLE_INDEX_MODULE = "true"
+
+jest.setTimeout(300000)
+
+medusaIntegrationTestRunner({
+  testSuite: ({ dbConnection, getContainer, api }) => {
+    let container
+
+    beforeEach(async () => {
+      container = getContainer()
+      await createAdminUser(dbConnection, adminHeaders, container)
+    })
+
+    afterAll(() => {
+      delete process.env.ENABLE_INDEX_MODULE
+    })
+
+    describe("Admin Index API", () => {
+      describe("GET /admin/index/details", () => {
+        it("should return index information with metadata", async () => {
+          await setTimeout(3000)
+
+          const response = await api.get(`/admin/index/details`, adminHeaders)
+
+          expect(response.status).toEqual(200)
+          expect(response.data).toHaveProperty("metadata")
+          expect(response.data.metadata.length).toBe(7)
+
+          // Verify all expected entities are present with correct structure
+          const entities = [
+            "Product",
+            "ProductVariant",
+            "LinkProductVariantPriceSet",
+            "Price",
+            "SalesChannel",
+            "LinkProductSalesChannel",
+            "PriceSet",
+          ]
+
+          entities.forEach((entityName) => {
+            const entityMetadata = response.data.metadata.find(
+              (m) => m.entity === entityName
+            )
+            expect(entityMetadata).toBeDefined()
+            expect(entityMetadata).toMatchObject({
+              id: expect.any(String),
+              entity: entityName,
+              status: expect.stringMatching(/^(pending|processing|done)$/),
+              fields: expect.any(Array),
+              updated_at: expect.any(String),
+            })
+            expect(entityMetadata).toHaveProperty("last_synced_key")
+          })
+
+          // Verify specific field structures for key entities
+          const productMetadata = response.data.metadata.find(
+            (m) => m.entity === "Product"
+          )
+          expect(productMetadata.fields).toEqual(
+            expect.arrayContaining(["id", "title", "handle", "status"])
+          )
+
+          const variantMetadata = response.data.metadata.find(
+            (m) => m.entity === "ProductVariant"
+          )
+          expect(variantMetadata.fields).toEqual(
+            expect.arrayContaining(["id", "product_id", "sku"])
+          )
+        })
+
+        describe("POST /admin/index/sync", () => {
+          it("should trigger sync with default strategy (continue)", async () => {
+            const response = await api.post(
+              `/admin/index/sync`,
+              {},
+              adminHeaders
+            )
+
+            expect(response.status).toEqual(200)
+          })
+
+          it("should trigger sync with full strategy", async () => {
+            const response = await api.post(
+              `/admin/index/sync`,
+              { strategy: "full" },
+              adminHeaders
+            )
+
+            expect(response.status).toEqual(200)
+          })
+
+          it("should trigger sync with reset strategy", async () => {
+            const response = await api.post(
+              `/admin/index/sync`,
+              { strategy: "reset" },
+              adminHeaders
+            )
+
+            expect(response.status).toEqual(200)
+          })
+
+          it("should reject invalid strategy", async () => {
+            const response = await api
+              .post(`/admin/index/sync`, { strategy: "invalid" }, adminHeaders)
+              .catch((e) => e)
+
+            expect(response.response.status).toEqual(400)
+          })
+
+          it("should sync and reflect in metadata status", async () => {
+            const syncResponsePromise = api.post(
+              `/admin/index/sync`,
+              { strategy: "full" },
+              adminHeaders
+            )
+            const updatedResponse = await api.get(
+              `/admin/index/details`,
+              adminHeaders
+            )
+
+            const syncResponse = await syncResponsePromise
+            expect(syncResponse.status).toEqual(200)
+            expect(updatedResponse.status).toEqual(200)
+
+            if (updatedResponse.data.metadata.length > 0) {
+              const hashedMetadataWithStatusPending =
+                updatedResponse.data.metadata.some(
+                  (m) => m.status === "pending"
+                )
+              expect(hashedMetadataWithStatusPending).toBe(true)
+            }
+          })
+
+          it("should reset index and clear all data", async () => {
+            const syncResponsePromise = api.post(
+              `/admin/index/sync`,
+              { strategy: "reset" },
+              adminHeaders
+            )
+            const response = await api.get(`/admin/index/details`, adminHeaders)
+
+            const syncResponse = await syncResponsePromise
+            expect(syncResponse.status).toEqual(200)
+            expect(response.status).toEqual(200)
+
+            const metadata = response.data.metadata
+            metadata.forEach((m) => {
+              expect(["pending", "processing"]).toContain(m.status)
+            })
+          })
+        })
+      })
+    })
+  },
+})

integration-tests/http/medusa-config.js

@@ -30,6 +30,9 @@ module.exports = defineConfig({
       jwtSecret: "test",
     },
   },
+  featureFlags: {
+    index_engine: process.env.ENABLE_INDEX_MODULE === "true",
+  },
   modules: {
     [Modules.FULFILLMENT]: {
       /** @type {import('@medusajs/fulfillment').FulfillmentModuleOptions} */
@@ -71,5 +74,9 @@ module.exports = defineConfig({
         ],
       },
     },
+    [Modules.INDEX]: {
+      resolve: "@medusajs/index",
+      disable: process.env.ENABLE_INDEX_MODULE !== "true",
+    },
   },
 })