chore: Migrate modules to use the Module util (#7964)

**What**
Apply the `Module` util to each module to handle the export and provide the linkable configuration object.

- Most joiner config that does not have any special config are removed/cleaned up in favor of the autogenerated one or simpler one
- linkable are now available in all modules
- cleaned up the dependencies of the modules

FIXES CORE-2410
This commit is contained in:
Adrien de Peretti
2024-07-05 13:00:40 +00:00
committed by GitHub
parent eafa3560ae
commit b368251ca3
99 changed files with 1267 additions and 488 deletions
@@ -1,9 +1,10 @@
import { IUserModuleService } from "@medusajs/types"
import { Modules, UserEvents } from "@medusajs/utils"
import { Module, Modules, UserEvents } from "@medusajs/utils"
import {
MockEventBusService,
moduleIntegrationTestRunner,
} from "medusa-test-utils"
import { UserModuleService } from "@services"
jest.setTimeout(30000)
@@ -27,6 +28,37 @@ moduleIntegrationTestRunner<IUserModuleService>({
eventBusModuleService: new MockEventBusService(),
},
testSuite: ({ service }) => {
it(`should export the appropriate linkable configuration`, () => {
const linkable = Module(Modules.USER, {
service: UserModuleService,
}).linkable
expect(Object.keys(linkable)).toEqual(["invite", "user"])
Object.keys(linkable).forEach((key) => {
delete linkable[key].toJSON
})
expect(linkable).toEqual({
invite: {
id: {
linkable: "invite_id",
primaryKey: "id",
serviceName: "user",
field: "invite",
},
},
user: {
id: {
linkable: "user_id",
primaryKey: "id",
serviceName: "user",
field: "user",
},
},
})
})
describe("UserModuleService - User", () => {
afterEach(async () => {
jest.clearAllMocks()
+1 -4
View File
@@ -47,14 +47,11 @@
"typescript": "^5.1.6"
},
"dependencies": {
"@medusajs/modules-sdk": "^1.12.10",
"@medusajs/utils": "^1.11.8",
"@mikro-orm/core": "5.9.7",
"@mikro-orm/migrations": "5.9.7",
"@mikro-orm/postgresql": "5.9.7",
"awilix": "^8.0.0",
"dotenv": "^16.4.5",
"jsonwebtoken": "^9.0.2",
"knex": "2.4.2"
"jsonwebtoken": "^9.0.2"
}
}
+3 -4
View File
@@ -1,7 +1,6 @@
import { UserModuleService } from "@services"
import { ModuleExports } from "@medusajs/types"
import { Module, Modules } from "@medusajs/utils"
const moduleDefinition: ModuleExports = {
export default Module(Modules.USER, {
service: UserModuleService,
}
export default moduleDefinition
})
@@ -1,3 +0,0 @@
import { defineJoinerConfig, Modules } from "@medusajs/utils"
export const joinerConfig = defineJoinerConfig(Modules.USER)
@@ -3,7 +3,6 @@ import {
DAL,
IEventBusModuleService,
InternalModuleDeclaration,
ModuleJoinerConfig,
ModulesSdkTypes,
UserTypes,
} from "@medusajs/types"
@@ -19,7 +18,6 @@ import {
UserEvents,
} from "@medusajs/utils"
import jwt, { JwtPayload } from "jsonwebtoken"
import { joinerConfig } from "../joiner-config"
import crypto from "node:crypto"
import { Invite, User } from "@models"
@@ -44,10 +42,6 @@ export default class UserModuleService
}>({ User, Invite })
implements UserTypes.IUserModuleService
{
__joinerConfig(): ModuleJoinerConfig {
return joinerConfig
}
protected baseRepository_: DAL.RepositoryService
protected readonly userService_: ModulesSdkTypes.IMedusaInternalService<User>