asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat: Refactor the product module definitions and implementation (#6866)

Browse Source 
There are several things done in this PR, namely:

Unify the service endpoints API to always work with a model rather than allowing to pass both ID and model (eg. both type_id and type being available in the request to create).
Start using upsertWithReplace to simplify the code and fix some deassociation bugs
Apply some changes to tests to deal with the pricing breaking changes
Correctly define the model relationships (with both ID and entity fields available)
All tests for the product are passing, which should bring us back to a great baseline.
This commit is contained in:
Stevche Radevski
2024-03-29 09:03:41 +00:00
committed by GitHub
parent e603726985
commit cbb5e6bd99
35 changed files with 1318 additions and 1374 deletions
Download Patch File Download Diff File Expand all files Collapse all files
integration-tests/api/__tests__/admin/product.js
+81 -62
View File
@@ -32,6 +32,50 @@ let {
jest.setTimeout(50000)
const getProductFixture = () => ({
title: "Test fixture",
description: "test-product-description",
images: breaking(
() => ["test-image.png", "test-image-2.png"],
() => [{ url: "test-image.png" }, { url: "test-image-2.png" }]
),
tags: [{ value: "123" }, { value: "456" }],
options: breaking(
() => [{ title: "size" }, { title: "color" }],
() => [
{ title: "size", values: ["large"] },
{ title: "color", values: ["green"] },
]
),
variants: [
{
title: "Test variant",
inventory_quantity: 10,
prices: [
{
currency_code: "usd",
amount: 100,
},
{
currency_code: "eur",
amount: 45,
},
{
currency_code: "dkk",
amount: 30,
},
],
options: breaking(
() => [{ value: "large" }, { value: "green" }],
() => ({
size: "large",
color: "green",
})
),
},
],
})
medusaIntegrationTestRunner({
env: { MEDUSA_FF_PRODUCT_CATEGORIES: true },
testSuite: ({ dbConnection, getContainer, api }) => {
@@ -41,7 +85,6 @@ medusaIntegrationTestRunner({
let scService
let remoteLink
let container
let productFixture
beforeAll(() => {
// Note: We have to lazily load everything because there are weird ordering issues when doing `require` of `@medusajs/medusa`
@@ -69,54 +112,12 @@ medusaIntegrationTestRunner({
container = getContainer()
await createAdminUser(dbConnection, adminHeaders, container)
productFixture = {
title: "Test fixture",
description: "test-product-description",
type: { value: "test-type" },
images: ["test-image.png", "test-image-2.png"],
tags: [{ value: "123" }, { value: "456" }],
options: breaking(
() => [{ title: "size" }, { title: "color" }],
() => [
{ title: "size", values: ["large"] },
{ title: "color", values: ["green"] },
]
),
variants: [
{
title: "Test variant",
inventory_quantity: 10,
prices: [
{
currency_code: "usd",
amount: 100,
},
{
currency_code: "eur",
amount: 45,
},
{
currency_code: "dkk",
amount: 30,
},
],
options: breaking(
() => [{ value: "large" }, { value: "green" }],
() => ({
size: "large",
color: "green",
})
),
},
],
}
// We want to seed another product for v2 that has pricing correctly wired up for all pricing-related tests.
v2Product = (
await breaking(
async () => ({}),
async () =>
await api.post("/admin/products", productFixture, adminHeaders)
await api.post("/admin/products", getProductFixture(), adminHeaders)
)
)?.data?.product
@@ -475,13 +476,13 @@ medusaIntegrationTestRunner({
expect.objectContaining({
id: breaking(
() => "test-price_4",
() => expect.stringMatching(/^ma_*/)
() => expect.stringMatching(/^price_*/)
),
}),
expect.objectContaining({
id: breaking(
() => "test-price_3",
() => expect.stringMatching(/^ma_*/)
() => expect.stringMatching(/^price_*/)
),
}),
])
@@ -1398,7 +1399,11 @@ medusaIntegrationTestRunner({
.post(
"/admin/products",
{
...productFixture,
...getProductFixture(),
...breaking(
() => ({ type: { value: "test-type" } }),
() => ({ type_id: "test-type" })
),
title: "Test create",
collection_id: "test-collection",
},
@@ -1408,6 +1413,11 @@ medusaIntegrationTestRunner({
console.log(err)
})
const priceIdSelector = breaking(
() => /^ma_*/,
() => /^price_*/
)
// TODO: It seems we end up with this recursive nested population (product -> variant -> product) that we need to get rid of
expect(response.status).toEqual(200)
expect(response.data.product).toEqual(
@@ -1502,7 +1512,7 @@ medusaIntegrationTestRunner({
title: "Test variant",
prices: expect.arrayContaining([
expect.objectContaining({
id: expect.stringMatching(/^ma_*/),
id: expect.stringMatching(priceIdSelector),
currency_code: "usd",
amount: 100,
created_at: expect.any(String),
@@ -1510,7 +1520,7 @@ medusaIntegrationTestRunner({
variant_id: expect.stringMatching(/^variant_*/),
}),
expect.objectContaining({
id: expect.stringMatching(/^ma_*/),
id: expect.stringMatching(priceIdSelector),
currency_code: "eur",
amount: 45,
created_at: expect.any(String),
@@ -1518,7 +1528,7 @@ medusaIntegrationTestRunner({
variant_id: expect.stringMatching(/^variant_*/),
}),
expect.objectContaining({
id: expect.stringMatching(/^ma_*/),
id: expect.stringMatching(priceIdSelector),
currency_code: "dkk",
amount: 30,
created_at: expect.any(String),
@@ -1579,8 +1589,10 @@ medusaIntegrationTestRunner({
title: "Test",
discountable: false,
description: "test-product-description",
type: { value: "test-type" },
images: ["test-image.png", "test-image-2.png"],
images: breaking(
() => ["test-image.png", "test-image-2.png"],
() => [{ url: "test-image.png" }, { url: "test-image-2.png" }]
),
collection_id: "test-collection",
tags: [{ value: "123" }, { value: "456" }],
variants: [
@@ -1610,8 +1622,10 @@ medusaIntegrationTestRunner({
const payload = {
title: "Test product - 1",
description: "test-product-description 1",
type: { value: "test-type 1" },
images: ["test-image.png", "test-image-2.png"],
images: breaking(
() => ["test-image.png", "test-image-2.png"],
() => [{ url: "test-image.png" }, { url: "test-image-2.png" }]
),
collection_id: "test-collection",
tags: [{ value: "123" }, { value: "456" }],
variants: [
@@ -1706,8 +1720,10 @@ medusaIntegrationTestRunner({
},
],
tags: [{ value: "123" }],
images: ["test-image-2.png"],
type: { value: "test-type-2" },
images: breaking(
() => ["test-image-2.png"],
() => [{ url: "test-image-2.png" }]
),
status: "published",
}
@@ -1771,8 +1787,7 @@ medusaIntegrationTestRunner({
updated_at: expect.any(String),
value: "test-type-2",
}),
// TODO: For some reason this is `test-type`, but the ID is correct in the `type` property.
// type_id: expect.stringMatching(/^ptyp_*/),
type_id: expect.stringMatching(/^ptyp_*/),
updated_at: expect.any(String),
variants: expect.arrayContaining([
expect.objectContaining({
@@ -2929,8 +2944,10 @@ medusaIntegrationTestRunner({
title: "Test product",
handle: "test-product",
description: "test-product-description",
type: { value: "test-type" },
images: ["test-image.png", "test-image-2.png"],
images: breaking(
() => ["test-image.png", "test-image-2.png"],
() => [{ url: "test-image.png" }, { url: "test-image-2.png" }]
),
collection_id: "test-collection",
tags: [{ value: "123" }, { value: "456" }],
variants: [
@@ -2964,8 +2981,10 @@ medusaIntegrationTestRunner({
title: "Test product",
handle: "test-product",
description: "test-product-description",
type: { value: "test-type" },
images: ["test-image.png", "test-image-2.png"],
images: breaking(
() => ["test-image.png", "test-image-2.png"],
() => [{ url: "test-image.png" }, { url: "test-image-2.png" }]
),
collection_id: "test-collection",
tags: [{ value: "123" }, { value: "456" }],
variants: [
integration-tests/factories/simple-product-variant-factory.ts
+18 -15
View File
@@ -7,6 +7,7 @@ import {
import { DataSource } from "typeorm"
import faker from "faker"
import { breaking } from "../helpers/breaking"
export type ProductVariantFactoryData = {
product_id: string
@@ -62,22 +63,24 @@ export const simpleProductVariantFactory = async (
})
}
const prices = data.prices || [{ currency: "usd", amount: 100 }]
for (const p of prices) {
const ma_id = `${p.currency}-${p.amount}-${Math.random()}`
await manager.insert(MoneyAmount, {
id: ma_id,
currency_code: p.currency,
amount: p.amount,
region_id: p.region_id,
})
await breaking(async () => {
const prices = data.prices || [{ currency: "usd", amount: 100 }]
for (const p of prices) {
const ma_id = `${p.currency}-${p.amount}-${Math.random()}`
await manager.insert(MoneyAmount, {
id: ma_id,
currency_code: p.currency,
amount: p.amount,
region_id: p.region_id,
})
await manager.insert(ProductVariantMoneyAmount, {
id: `${ma_id}-${id}-${Math.random()}`,
money_amount_id: ma_id,
variant_id: id,
})
}
await manager.insert(ProductVariantMoneyAmount, {
id: `${ma_id}-${id}-${Math.random()}`,
money_amount_id: ma_id,
variant_id: id,
})
}
})
return variant
}
integration-tests/helpers/product-seeder.js
+92 -61
View File
@@ -12,6 +12,7 @@ const {
MoneyAmount,
ProductVariantMoneyAmount,
} = require("@medusajs/medusa")
const { breaking } = require("./breaking")
module.exports = async (dataSource, data = {}) => {
const manager = dataSource.manager
@@ -141,17 +142,22 @@ module.exports = async (dataSource, data = {}) => {
await manager.save(variant1)
const ma = await manager.insert(MoneyAmount, {
id: "test-price",
currency_code: "usd",
amount: 100,
})
await breaking(
async () => {
const ma = await manager.insert(MoneyAmount, {
id: "test-price",
currency_code: "usd",
amount: 100,
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma0",
money_amount_id: "test-price",
variant_id: "test-variant",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma0",
money_amount_id: "test-price",
variant_id: "test-variant",
})
},
() => {}
)
const sale = manager.create(ProductVariant, {
id: "test-variant-sale",
@@ -174,17 +180,22 @@ module.exports = async (dataSource, data = {}) => {
await manager.save(sale)
const ma_sale = await manager.insert(MoneyAmount, {
id: "test-price-sale",
currency_code: "usd",
amount: 1000,
})
await breaking(
async () => {
const ma_sale = await manager.insert(MoneyAmount, {
id: "test-price-sale",
currency_code: "usd",
amount: 1000,
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma1",
money_amount_id: "test-price-sale",
variant_id: "test-variant-sale",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma1",
money_amount_id: "test-price-sale",
variant_id: "test-variant-sale",
})
},
() => {}
)
const variant2 = manager.create(ProductVariant, {
id: "test-variant_1",
@@ -207,17 +218,22 @@ module.exports = async (dataSource, data = {}) => {
await manager.save(variant2)
const ma_1 = await manager.insert(MoneyAmount, {
id: "test-price_1",
currency_code: "usd",
amount: 1000,
})
await breaking(
async () => {
const ma_1 = await manager.insert(MoneyAmount, {
id: "test-price_1",
currency_code: "usd",
amount: 1000,
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma2",
money_amount_id: "test-price_1",
variant_id: "test-variant_1",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma2",
money_amount_id: "test-price_1",
variant_id: "test-variant_1",
})
},
() => {}
)
const variant3 = manager.create(ProductVariant, {
id: "test-variant_2",
@@ -239,17 +255,22 @@ module.exports = async (dataSource, data = {}) => {
await manager.save(variant3)
const ma_2 = await manager.insert(MoneyAmount, {
id: "test-price_2",
currency_code: "usd",
amount: 100,
})
await breaking(
async () => {
const ma_2 = await manager.insert(MoneyAmount, {
id: "test-price_2",
currency_code: "usd",
amount: 100,
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma3",
money_amount_id: "test-price_2",
variant_id: "test-variant_2",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma3",
money_amount_id: "test-price_2",
variant_id: "test-variant_2",
})
},
() => {}
)
const p1 = manager.create(Product, {
id: "test-product1",
@@ -288,18 +309,23 @@ module.exports = async (dataSource, data = {}) => {
await manager.save(variant4)
const ma_3 = await manager.insert(MoneyAmount, {
id: "test-price_3",
currency_code: "usd",
amount: 100,
region_id: "test-region",
})
await breaking(
async () => {
const ma_3 = await manager.insert(MoneyAmount, {
id: "test-price_3",
currency_code: "usd",
amount: 100,
region_id: "test-region",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma4",
money_amount_id: "test-price_3",
variant_id: "test-variant_3",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma4",
money_amount_id: "test-price_3",
variant_id: "test-variant_3",
})
},
() => {}
)
const variant5 = manager.create(ProductVariant, {
id: "test-variant_4",
@@ -321,17 +347,22 @@ module.exports = async (dataSource, data = {}) => {
await manager.save(variant5)
const ma_4 = await manager.insert(MoneyAmount, {
id: "test-price_4",
currency_code: "usd",
amount: 100,
})
await breaking(
async () => {
const ma_4 = await manager.insert(MoneyAmount, {
id: "test-price_4",
currency_code: "usd",
amount: 100,
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma5",
money_amount_id: "test-price_4",
variant_id: "test-variant_4",
})
await manager.insert(ProductVariantMoneyAmount, {
id: "pvma5",
money_amount_id: "test-price_4",
variant_id: "test-variant_4",
})
},
() => {}
)
const product1 = manager.create(Product, {
id: "test-product_filtering_1",