Feat(inventory-next, medusa): Add List inventory items endpoint (#6694)
* code for list inventory items * fix integration tests * move integration test * calculate reserved and stocked quantities in db * update lockfile
This commit is contained in:
Philip Korsholm
@@ -0,0 +1,726 @@
|
||||
import { IInventoryServiceNext, IStockLocationService } from "@medusajs/types"
|
||||
|
||||
import { ContainerRegistrationKeys } from "@medusajs/utils"
|
||||
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
|
||||
import { createAdminUser } from "../../../helpers/create-admin-user"
|
||||
import { remoteQueryObjectFromString } from "@medusajs/utils"
|
||||
|
||||
const { medusaIntegrationTestRunner } = require("medusa-test-utils")
|
||||
|
||||
jest.setTimeout(30000)
|
||||
|
||||
const { simpleProductFactory } = require("../../../factories")
|
||||
const adminHeaders = { headers: { "x-medusa-access-token": "test_token" } }
|
||||
|
||||
medusaIntegrationTestRunner({
|
||||
env: {
|
||||
MEDUSA_FF_MEDUSA_V2: true,
|
||||
},
|
||||
testSuite: ({ dbConnection, getContainer, api }) => {
|
||||
let appContainer
|
||||
let shutdownServer
|
||||
let service: IInventoryServiceNext
|
||||
|
||||
let variantId
|
||||
let inventoryItems
|
||||
let locationId
|
||||
let location2Id
|
||||
let location3Id
|
||||
|
||||
beforeEach(async () => {
|
||||
appContainer = getContainer()
|
||||
|
||||
await createAdminUser(dbConnection, adminHeaders, appContainer)
|
||||
|
||||
service = appContainer.resolve(ModuleRegistrationName.INVENTORY)
|
||||
})
|
||||
|
||||
describe("Inventory Items", () => {
|
||||
it.skip("should create, update and delete the inventory location levels", async () => {
|
||||
const inventoryItemId = inventoryItems[0].id
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: locationId,
|
||||
stocked_quantity: 17,
|
||||
incoming_quantity: 2,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const inventoryService = appContainer.resolve("inventoryService")
|
||||
const stockLevel = await inventoryService.retrieveInventoryLevel(
|
||||
inventoryItemId,
|
||||
locationId
|
||||
)
|
||||
|
||||
expect(stockLevel.location_id).toEqual(locationId)
|
||||
expect(stockLevel.inventory_item_id).toEqual(inventoryItemId)
|
||||
expect(stockLevel.stocked_quantity).toEqual(17)
|
||||
expect(stockLevel.incoming_quantity).toEqual(2)
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels/${locationId}`,
|
||||
{
|
||||
stocked_quantity: 21,
|
||||
incoming_quantity: 0,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const newStockLevel = await inventoryService.retrieveInventoryLevel(
|
||||
inventoryItemId,
|
||||
locationId
|
||||
)
|
||||
expect(newStockLevel.stocked_quantity).toEqual(21)
|
||||
expect(newStockLevel.incoming_quantity).toEqual(0)
|
||||
|
||||
await api.delete(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels/${locationId}`,
|
||||
adminHeaders
|
||||
)
|
||||
const invLevel = await inventoryService
|
||||
.retrieveInventoryLevel(inventoryItemId, locationId)
|
||||
.catch((e) => e)
|
||||
|
||||
expect(invLevel.message).toEqual(
|
||||
`Inventory level for item ${inventoryItemId} and location ${locationId} not found`
|
||||
)
|
||||
})
|
||||
|
||||
it.skip("should update the inventory item", async () => {
|
||||
const inventoryItemId = inventoryItems[0].id
|
||||
|
||||
const response = await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}`,
|
||||
{
|
||||
mid_code: "updated mid_code",
|
||||
weight: 120,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(response.data.inventory_item).toEqual(
|
||||
expect.objectContaining({
|
||||
origin_country: "UK",
|
||||
hs_code: "hs001",
|
||||
mid_code: "updated mid_code",
|
||||
weight: 120,
|
||||
length: 100,
|
||||
height: 200,
|
||||
width: 150,
|
||||
})
|
||||
)
|
||||
})
|
||||
|
||||
it.skip("should fail to update the location level to negative quantity", async () => {
|
||||
const inventoryItemId = inventoryItems[0].id
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: locationId,
|
||||
stocked_quantity: 17,
|
||||
incoming_quantity: 2,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const res = await api
|
||||
.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels/${locationId}`,
|
||||
{
|
||||
incoming_quantity: -1,
|
||||
stocked_quantity: -1,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
.catch((error) => error)
|
||||
|
||||
expect(res.response.status).toEqual(400)
|
||||
expect(res.response.data).toEqual({
|
||||
type: "invalid_data",
|
||||
message:
|
||||
"incoming_quantity must not be less than 0, stocked_quantity must not be less than 0",
|
||||
})
|
||||
})
|
||||
|
||||
it.skip("should retrieve the inventory item", async () => {
|
||||
const inventoryItemId = inventoryItems[0].id
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: locationId,
|
||||
stocked_quantity: 15,
|
||||
incoming_quantity: 5,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: location2Id,
|
||||
stocked_quantity: 7,
|
||||
incoming_quantity: 0,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const response = await api.get(
|
||||
`/admin/inventory-items/${inventoryItemId}`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(response.data).toEqual({
|
||||
inventory_item: expect.objectContaining({
|
||||
height: 200,
|
||||
hs_code: "hs001",
|
||||
id: inventoryItemId,
|
||||
length: 100,
|
||||
location_levels: [
|
||||
expect.objectContaining({
|
||||
available_quantity: 15,
|
||||
deleted_at: null,
|
||||
id: expect.any(String),
|
||||
incoming_quantity: 5,
|
||||
inventory_item_id: inventoryItemId,
|
||||
location_id: locationId,
|
||||
metadata: null,
|
||||
reserved_quantity: 0,
|
||||
stocked_quantity: 15,
|
||||
}),
|
||||
expect.objectContaining({
|
||||
available_quantity: 7,
|
||||
deleted_at: null,
|
||||
id: expect.any(String),
|
||||
incoming_quantity: 0,
|
||||
inventory_item_id: inventoryItemId,
|
||||
location_id: location2Id,
|
||||
metadata: null,
|
||||
reserved_quantity: 0,
|
||||
stocked_quantity: 7,
|
||||
}),
|
||||
],
|
||||
material: "material",
|
||||
metadata: null,
|
||||
mid_code: "mids",
|
||||
origin_country: "UK",
|
||||
requires_shipping: true,
|
||||
sku: "MY_SKU",
|
||||
weight: 300,
|
||||
width: 150,
|
||||
}),
|
||||
})
|
||||
})
|
||||
|
||||
it.skip("should create the inventory item using the api", async () => {
|
||||
const product = await simpleProductFactory(dbConnection, {})
|
||||
|
||||
const productRes = await api.get(
|
||||
`/admin/products/${product.id}`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const variantId = productRes.data.product.variants[0].id
|
||||
|
||||
let variantInventoryRes = await api.get(
|
||||
`/admin/variants/${variantId}/inventory`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(variantInventoryRes.data).toEqual({
|
||||
variant: {
|
||||
id: variantId,
|
||||
inventory: [],
|
||||
sales_channel_availability: [],
|
||||
},
|
||||
})
|
||||
expect(variantInventoryRes.status).toEqual(200)
|
||||
|
||||
const inventoryItemCreateRes = await api.post(
|
||||
`/admin/inventory-items`,
|
||||
{ variant_id: variantId, sku: "attach_this_to_variant" },
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
variantInventoryRes = await api.get(
|
||||
`/admin/variants/${variantId}/inventory`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(variantInventoryRes.data).toEqual({
|
||||
variant: expect.objectContaining({
|
||||
id: variantId,
|
||||
inventory: [
|
||||
expect.objectContaining({
|
||||
...inventoryItemCreateRes.data.inventory_item,
|
||||
}),
|
||||
],
|
||||
}),
|
||||
})
|
||||
expect(variantInventoryRes.status).toEqual(200)
|
||||
})
|
||||
|
||||
it.skip("should list the location levels based on id param constraint", async () => {
|
||||
const inventoryItemId = inventoryItems[0].id
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: location2Id,
|
||||
stocked_quantity: 10,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: location3Id,
|
||||
stocked_quantity: 5,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const result = await api.get(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels?location_id[]=${location2Id}`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(result.status).toEqual(200)
|
||||
expect(result.data.inventory_item.location_levels).toHaveLength(1)
|
||||
expect(result.data.inventory_item.location_levels[0]).toEqual(
|
||||
expect.objectContaining({
|
||||
stocked_quantity: 10,
|
||||
})
|
||||
)
|
||||
})
|
||||
|
||||
describe.skip("Create inventory item level", () => {
|
||||
let location1
|
||||
let location2
|
||||
|
||||
beforeEach(async () => {
|
||||
await service.create([
|
||||
{
|
||||
sku: "MY_SKU",
|
||||
origin_country: "UK",
|
||||
hs_code: "hs001",
|
||||
mid_code: "mids",
|
||||
material: "material",
|
||||
weight: 300,
|
||||
length: 100,
|
||||
height: 200,
|
||||
width: 150,
|
||||
},
|
||||
])
|
||||
|
||||
const stockLocationService: IStockLocationService =
|
||||
appContainer.resolve(ModuleRegistrationName.STOCK_LOCATION)
|
||||
|
||||
location1 = await stockLocationService.create({
|
||||
name: "location-1",
|
||||
})
|
||||
|
||||
location2 = await stockLocationService.create({
|
||||
name: "location-2",
|
||||
})
|
||||
})
|
||||
|
||||
it("should list the inventory items", async () => {
|
||||
const [{ id: inventoryItemId }] = await service.list({})
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: location1.id,
|
||||
stocked_quantity: 10,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items/${inventoryItemId}/location-levels`,
|
||||
{
|
||||
location_id: location2.id,
|
||||
stocked_quantity: 5,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const levels = await service.listInventoryLevels({
|
||||
inventory_item_id: inventoryItemId,
|
||||
})
|
||||
|
||||
expect(levels).toHaveLength(2)
|
||||
expect(levels).toEqual([
|
||||
expect.objectContaining({
|
||||
location_id: location1.id,
|
||||
stocked_quantity: 10,
|
||||
}),
|
||||
expect.objectContaining({
|
||||
location_id: location2.id,
|
||||
stocked_quantity: 5,
|
||||
}),
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
describe.skip("Create inventory items", () => {
|
||||
it("should create inventory items", async () => {
|
||||
const createResult = await api.post(
|
||||
`/admin/products`,
|
||||
{
|
||||
title: "Test Product",
|
||||
variants: [
|
||||
{
|
||||
title: "Test Variant w. inventory 2",
|
||||
sku: "MY_SKU1",
|
||||
material: "material",
|
||||
},
|
||||
],
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const inventoryItems = await service.list({})
|
||||
|
||||
expect(inventoryItems).toHaveLength(0)
|
||||
|
||||
const response = await api.post(
|
||||
`/admin/inventory-items`,
|
||||
{
|
||||
sku: "test-sku",
|
||||
variant_id: createResult.data.product.variants[0].id,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(response.status).toEqual(200)
|
||||
expect(response.data.inventory_item).toEqual(
|
||||
expect.objectContaining({
|
||||
sku: "test-sku",
|
||||
})
|
||||
)
|
||||
})
|
||||
|
||||
it("should attach inventory items on creation", async () => {
|
||||
const createResult = await api.post(
|
||||
`/admin/products`,
|
||||
{
|
||||
title: "Test Product",
|
||||
variants: [
|
||||
{
|
||||
title: "Test Variant w. inventory 2",
|
||||
sku: "MY_SKU1",
|
||||
material: "material",
|
||||
},
|
||||
],
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const inventoryItems = await service.list({})
|
||||
|
||||
expect(inventoryItems).toHaveLength(0)
|
||||
|
||||
await api.post(
|
||||
`/admin/inventory-items`,
|
||||
{
|
||||
sku: "test-sku",
|
||||
variant_id: createResult.data.product.variants[0].id,
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
const remoteQuery = appContainer.resolve(
|
||||
ContainerRegistrationKeys.REMOTE_QUERY
|
||||
)
|
||||
|
||||
const query = remoteQueryObjectFromString({
|
||||
entryPoint: "product_variant_inventory_item",
|
||||
variables: {
|
||||
variant_id: createResult.data.product.variants[0].id,
|
||||
},
|
||||
fields: ["inventory_item_id", "variant_id"],
|
||||
})
|
||||
|
||||
const existingItems = await remoteQuery(query)
|
||||
|
||||
expect(existingItems).toHaveLength(1)
|
||||
expect(existingItems[0].variant_id).toEqual(
|
||||
createResult.data.product.variants[0].id
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe("List inventory items", () => {
|
||||
let location1 = "loc_1"
|
||||
let location2 = "loc_2"
|
||||
beforeEach(async () => {
|
||||
await service.create([
|
||||
{
|
||||
sku: "MY_SKU",
|
||||
origin_country: "UK",
|
||||
hs_code: "hs001",
|
||||
mid_code: "mids",
|
||||
material: "material",
|
||||
weight: 300,
|
||||
length: 100,
|
||||
height: 200,
|
||||
width: 150,
|
||||
},
|
||||
])
|
||||
})
|
||||
|
||||
it("should list the inventory items", async () => {
|
||||
const [{ id: inventoryItemId }] = await service.list({})
|
||||
|
||||
await service.createInventoryLevels([
|
||||
{
|
||||
inventory_item_id: inventoryItemId,
|
||||
location_id: location1,
|
||||
stocked_quantity: 10,
|
||||
},
|
||||
{
|
||||
inventory_item_id: inventoryItemId,
|
||||
location_id: location2,
|
||||
stocked_quantity: 5,
|
||||
},
|
||||
])
|
||||
|
||||
const response = await api.get(`/admin/inventory-items`, adminHeaders)
|
||||
|
||||
expect(response.data.inventory_items).toHaveLength(1)
|
||||
expect(response.data.inventory_items[0]).toEqual(
|
||||
expect.objectContaining({
|
||||
id: inventoryItemId,
|
||||
sku: "MY_SKU",
|
||||
origin_country: "UK",
|
||||
hs_code: "hs001",
|
||||
mid_code: "mids",
|
||||
material: "material",
|
||||
weight: 300,
|
||||
length: 100,
|
||||
height: 200,
|
||||
width: 150,
|
||||
requires_shipping: true,
|
||||
metadata: null,
|
||||
location_levels: expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
id: expect.any(String),
|
||||
inventory_item_id: inventoryItemId,
|
||||
location_id: location1,
|
||||
stocked_quantity: 10,
|
||||
reserved_quantity: 0,
|
||||
incoming_quantity: 0,
|
||||
metadata: null,
|
||||
available_quantity: 10,
|
||||
}),
|
||||
expect.objectContaining({
|
||||
id: expect.any(String),
|
||||
inventory_item_id: inventoryItemId,
|
||||
location_id: location2,
|
||||
stocked_quantity: 5,
|
||||
reserved_quantity: 0,
|
||||
incoming_quantity: 0,
|
||||
metadata: null,
|
||||
available_quantity: 5,
|
||||
}),
|
||||
]),
|
||||
reserved_quantity: 0,
|
||||
stocked_quantity: 15,
|
||||
})
|
||||
)
|
||||
})
|
||||
|
||||
it("should list the inventory items searching by title, description and sku", async () => {
|
||||
const inventoryService = appContainer.resolve("inventoryService")
|
||||
|
||||
await inventoryService.create([
|
||||
{
|
||||
title: "Test Item",
|
||||
},
|
||||
{
|
||||
description: "Test Desc",
|
||||
},
|
||||
{
|
||||
sku: "Test Sku",
|
||||
},
|
||||
])
|
||||
|
||||
const response = await api.get(
|
||||
`/admin/inventory-items?q=test`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(response.data.inventory_items).not.toEqual(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
sku: "MY_SKU",
|
||||
}),
|
||||
])
|
||||
)
|
||||
expect(response.data.inventory_items).toHaveLength(3)
|
||||
expect(response.data.inventory_items).toEqual(
|
||||
expect.arrayContaining([
|
||||
expect.objectContaining({
|
||||
sku: "Test Sku",
|
||||
}),
|
||||
expect.objectContaining({
|
||||
description: "Test Desc",
|
||||
}),
|
||||
expect.objectContaining({
|
||||
title: "Test Item",
|
||||
}),
|
||||
])
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
it.skip("should remove associated levels and reservations when deleting an inventory item", async () => {
|
||||
const inventoryService = appContainer.resolve("inventoryService")
|
||||
|
||||
const invItem2 = await inventoryService.createInventoryItem({
|
||||
sku: "1234567",
|
||||
})
|
||||
|
||||
const stockRes = await api.post(
|
||||
`/admin/stock-locations`,
|
||||
{
|
||||
name: "Fake Warehouse 1",
|
||||
},
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
locationId = stockRes.data.stock_location.id
|
||||
|
||||
const level = await inventoryService.createInventoryLevel({
|
||||
inventory_item_id: invItem2.id,
|
||||
location_id: locationId,
|
||||
stocked_quantity: 10,
|
||||
})
|
||||
|
||||
const reservation = await inventoryService.createReservationItem({
|
||||
inventory_item_id: invItem2.id,
|
||||
location_id: locationId,
|
||||
quantity: 5,
|
||||
})
|
||||
|
||||
const [, reservationCount] =
|
||||
await inventoryService.listReservationItems({
|
||||
location_id: locationId,
|
||||
})
|
||||
|
||||
expect(reservationCount).toEqual(1)
|
||||
|
||||
const [, inventoryLevelCount] =
|
||||
await inventoryService.listInventoryLevels({
|
||||
location_id: locationId,
|
||||
})
|
||||
|
||||
expect(inventoryLevelCount).toEqual(1)
|
||||
|
||||
const res = await api.delete(
|
||||
`/admin/stock-locations/${locationId}`,
|
||||
adminHeaders
|
||||
)
|
||||
|
||||
expect(res.status).toEqual(200)
|
||||
|
||||
const [, reservationCountPostDelete] =
|
||||
await inventoryService.listReservationItems({
|
||||
location_id: locationId,
|
||||
})
|
||||
|
||||
expect(reservationCountPostDelete).toEqual(0)
|
||||
|
||||
const [, inventoryLevelCountPostDelete] =
|
||||
await inventoryService.listInventoryLevels({
|
||||
location_id: locationId,
|
||||
})
|
||||
|
||||
expect(inventoryLevelCountPostDelete).toEqual(0)
|
||||
})
|
||||
|
||||
it.skip("should remove the product variant associations when deleting an inventory item", async () => {
|
||||
await simpleProductFactory(
|
||||
dbConnection,
|
||||
{
|
||||
id: "test-product-new",
|
||||
variants: [],
|
||||
},
|
||||
5
|
||||
)
|
||||
|
||||
const response = await api.post(
|
||||
`/admin/products/test-product-new/variants`,
|
||||
{
|
||||
title: "Test2",
|
||||
sku: "MY_SKU2",
|
||||
manage_inventory: true,
|
||||
options: [
|
||||
{
|
||||
option_id: "test-product-new-option",
|
||||
value: "Blue",
|
||||
},
|
||||
],
|
||||
prices: [{ currency_code: "usd", amount: 100 }],
|
||||
},
|
||||
{ headers: { "x-medusa-access-token": "test_token" } }
|
||||
)
|
||||
|
||||
const secondVariantId = response.data.product.variants.find(
|
||||
(v) => v.sku === "MY_SKU2"
|
||||
).id
|
||||
|
||||
const inventoryService = appContainer.resolve("inventoryService")
|
||||
const variantInventoryService = appContainer.resolve(
|
||||
"productVariantInventoryService"
|
||||
)
|
||||
|
||||
const invItem2 = await inventoryService.createInventoryItem({
|
||||
sku: "123456",
|
||||
})
|
||||
|
||||
await variantInventoryService.attachInventoryItem(
|
||||
variantId,
|
||||
invItem2.id,
|
||||
2
|
||||
)
|
||||
await variantInventoryService.attachInventoryItem(
|
||||
secondVariantId,
|
||||
invItem2.id,
|
||||
2
|
||||
)
|
||||
|
||||
expect(
|
||||
await variantInventoryService.listInventoryItemsByVariant(variantId)
|
||||
).toHaveLength(2)
|
||||
|
||||
expect(
|
||||
await variantInventoryService.listInventoryItemsByVariant(
|
||||
secondVariantId
|
||||
)
|
||||
).toHaveLength(2)
|
||||
|
||||
await api.delete(`/admin/inventory-items/${invItem2.id}`, {
|
||||
headers: { "x-medusa-access-token": "test_token" },
|
||||
})
|
||||
|
||||
expect(
|
||||
await variantInventoryService.listInventoryItemsByVariant(variantId)
|
||||
).toHaveLength(1)
|
||||
|
||||
expect(
|
||||
await variantInventoryService.listInventoryItemsByVariant(
|
||||
secondVariantId
|
||||
)
|
||||
).toHaveLength(1)
|
||||
})
|
||||
})
|
||||
},
|
||||
})
|
||||
Reference in New Issue
Block a user