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

Chore/rm main entity concept (#7709)

Browse Source 
**What**
Update the `MedusaService` class, factory and types to remove the concept of main modules. The idea being that all method will be explicitly named and suffixes to represent the object you are trying to manipulate.
This pr also includes various fixes in different modules

Co-authored-by: Stevche Radevski <4820812+sradevski@users.noreply.github.com>
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
Adrien de Peretti
2024-06-19 13:02:16 +00:00
committed by GitHub
co-authored by Stevche Radevski Oli Juhl
parent 2895ccfba8
commit 48963f55ef
533 changed files with 6469 additions and 9769 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/modules/sales-channel/integration-tests/__fixtures__/index.ts
-40
View File
@@ -1,40 +0,0 @@
import { SqlEntityManager } from "@mikro-orm/postgresql"
import { SalesChannel } from "@models"
const salesChannelData = [
{
id: "channel-1",
name: "Channel 1",
description: "Channel description 1",
is_disabled: false,
},
{
id: "channel-2",
name: "Channel 2",
description: "Channel description 2",
is_disabled: false,
},
{
id: "channel-3",
name: "Channel 3",
description: "Channel description 3",
is_disabled: true,
},
]
export async function createSalesChannels(
manager: SqlEntityManager,
channelData: any[] = salesChannelData
): Promise<SalesChannel[]> {
const channels: SalesChannel[] = []
for (let data of channelData) {
const sc = manager.create(SalesChannel, data)
channels.push(sc)
}
await manager.persistAndFlush(channels)
return channels
}
packages/modules/sales-channel/integration-tests/__tests__/services/sales-channel-module.spec.ts
+40 -38
View File
@@ -1,46 +1,48 @@
import { SqlEntityManager } from "@mikro-orm/postgresql"
import { ISalesChannelModuleService } from "@medusajs/types"
import { createSalesChannels } from "../../__fixtures__"
import { moduleIntegrationTestRunner, SuiteOptions } from "medusa-test-utils"
import { Modules } from "@medusajs/modules-sdk"
jest.setTimeout(30000)
moduleIntegrationTestRunner({
const salesChannelData = [
{
id: "channel-1",
name: "Channel 1",
description: "Channel description 1",
is_disabled: false,
},
{
id: "channel-2",
name: "Channel 2",
description: "Channel description 2",
is_disabled: false,
},
{
id: "channel-3",
name: "Channel 3",
description: "Channel description 3",
is_disabled: true,
},
]
moduleIntegrationTestRunner<ISalesChannelModuleService>({
moduleName: Modules.SALES_CHANNEL,
testSuite: ({
MikroOrmWrapper,
medusaApp,
}: SuiteOptions<ISalesChannelModuleService>) => {
let service: ISalesChannelModuleService
beforeEach(() => {
service = medusaApp.modules[Modules.SALES_CHANNEL]
})
testSuite: ({ service }) => {
describe("Sales Channel Service", () => {
let testManager: SqlEntityManager
let repositoryManager: SqlEntityManager
beforeEach(async () => {
repositoryManager = await MikroOrmWrapper.forkManager()
testManager = await MikroOrmWrapper.forkManager()
await createSalesChannels(testManager)
await service.createSalesChannels(salesChannelData)
})
describe("create", () => {
it("should create a SalesChannel successfully", async () => {
const [created] = await service.create([
const [created] = await service.createSalesChannels([
{
name: "test",
description: "test",
},
])
const [channel] = await service.list({
const [channel] = await service.listSalesChannels({
name: [created.name],
})
@@ -53,7 +55,7 @@ moduleIntegrationTestRunner({
const id = "channel-1"
it("should return SalesChannel for the given id", async () => {
const result = await service.retrieve(id)
const result = await service.retrieveSalesChannel(id)
expect(result).toEqual(
expect.objectContaining({
@@ -66,7 +68,7 @@ moduleIntegrationTestRunner({
let error
try {
await service.retrieve("does-not-exist")
await service.retrieveSalesChannel("does-not-exist")
} catch (e) {
error = e
}
@@ -81,12 +83,12 @@ moduleIntegrationTestRunner({
const id = "channel-2"
it("should update the name of the SalesChannel successfully", async () => {
await service.update(id, {
await service.updateSalesChannels(id, {
name: "Update name 2",
is_disabled: true,
})
const channel = await service.retrieve(id)
const channel = await service.retrieveSalesChannel(id)
expect(channel.name).toEqual("Update name 2")
expect(channel.is_disabled).toEqual(true)
@@ -96,7 +98,7 @@ moduleIntegrationTestRunner({
let error
try {
await service.update("does-not-exist", {
await service.updateSalesChannels("does-not-exist", {
name: "does-not-exist",
})
} catch (e) {
@@ -111,7 +113,7 @@ moduleIntegrationTestRunner({
describe("list", () => {
it("should return a list of SalesChannels", async () => {
const result = await service.list()
const result = await service.listSalesChannels()
expect(result).toEqual([
expect.objectContaining({
@@ -127,7 +129,7 @@ moduleIntegrationTestRunner({
})
it("should list SalesChannels by name", async () => {
const result = await service.list({
const result = await service.listSalesChannels({
name: ["Channel 2", "Channel 3"],
})
@@ -144,7 +146,7 @@ moduleIntegrationTestRunner({
describe("listAndCount", () => {
it("should return sales channels and count", async () => {
const [result, count] = await service.listAndCount()
const [result, count] = await service.listAndCountSalesChannels()
expect(count).toEqual(3)
expect(result).toEqual([
@@ -161,7 +163,7 @@ moduleIntegrationTestRunner({
})
it("should return sales channels and count when filtered", async () => {
const [result, count] = await service.listAndCount({
const [result, count] = await service.listAndCountSalesChannels({
id: ["channel-2"],
})
@@ -174,7 +176,7 @@ moduleIntegrationTestRunner({
})
it("should return sales channels and count when using skip and take", async () => {
const [results, count] = await service.listAndCount(
const [results, count] = await service.listAndCountSalesChannels(
{},
{ skip: 1, take: 1 }
)
@@ -188,7 +190,7 @@ moduleIntegrationTestRunner({
})
it("should return requested fields", async () => {
const [result, count] = await service.listAndCount(
const [result, count] = await service.listAndCountSalesChannels(
{},
{
take: 1,
@@ -208,7 +210,7 @@ moduleIntegrationTestRunner({
})
it("should filter disabled channels", async () => {
const [result, count] = await service.listAndCount(
const [result, count] = await service.listAndCountSalesChannels(
{ is_disabled: true },
{ select: ["id"] }
)
@@ -228,9 +230,9 @@ moduleIntegrationTestRunner({
const id = "channel-2"
it("should delete the SalesChannel given an id successfully", async () => {
await service.delete([id])
await service.deleteSalesChannels([id])
const result = await service.list({
const result = await service.listSalesChannels({
id: [id],
})
packages/modules/sales-channel/integration-tests/setup-env.js
-6
View File
@@ -1,6 +0,0 @@
if (typeof process.env.DB_TEMP_NAME === "undefined") {
const tempName = parseInt(process.env.JEST_WORKER_ID || "1")
process.env.DB_TEMP_NAME = `medusa-sales-channel-integration-${tempName}`
}
process.env.MEDUSA_SALES_CHANNEL_DB_SCHEMA = "public"
packages/modules/sales-channel/integration-tests/setup.js
-3
View File
@@ -1,3 +0,0 @@
import { JestUtils } from "medusa-test-utils"
JestUtils.afterAllHookDropDatabase()
packages/modules/sales-channel/integration-tests/utils/config.ts
-6
View File
@@ -1,6 +0,0 @@
import { ModuleServiceInitializeOptions } from "@medusajs/types"
export const databaseOptions: ModuleServiceInitializeOptions["database"] = {
schema: "public",
clientUrl: "medusa-sales-channel-test",
}
packages/modules/sales-channel/integration-tests/utils/database.ts
-18
View File
@@ -1,18 +0,0 @@
import {TestDatabaseUtils} from "medusa-test-utils"
import * as SalesChannelModels from "@models"
const pathToMigrations = "../../src/migrations"
const mikroOrmEntities = SalesChannelModels as unknown as any[]
export const MikroOrmWrapper = TestDatabaseUtils.getMikroOrmWrapper({
mikroOrmEntities,
pathToMigrations,
})
export const MikroOrmConfig = TestDatabaseUtils.getMikroOrmConfig({
mikroOrmEntities,
pathToMigrations,
})
export const DB_URL = TestDatabaseUtils.getDatabaseURL()
packages/modules/sales-channel/integration-tests/utils/index.ts
-1
View File
@@ -1 +0,0 @@
export * from "./database"