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

Feat(modules-sdk,inventory,stock-location): modules isolated connection (#3329)

Browse Source 
* feat: scoped container for modules
This commit is contained in:
Carlos R. L. Rodrigues
2023-03-15 12:09:45 -03:00
committed by GitHub
parent 8e78c533c4
commit 77d46220c2
65 changed files with 1116 additions and 1011 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/modules-sdk/src/loaders/__tests__/module-loader.ts
+16 -84
View File
@@ -1,14 +1,7 @@
import { EOL } from "os"
import { AwilixContainer, ClassOrFunctionReturning, Resolver } from "awilix"
import { createMedusaContainer } from "medusa-core-utils"
import {
asFunction,
asValue,
AwilixContainer,
ClassOrFunctionReturning,
createContainer,
Resolver,
} from "awilix"
import {
ConfigModule,
MedusaContainer,
ModuleResolution,
MODULE_RESOURCE_TYPE,
MODULE_SCOPE,
@@ -28,46 +21,9 @@ function asArray(
const logger = {
warn: jest.fn(),
error: jest.fn(),
} as any
const buildConfigModule = (
configParts: Partial<ConfigModule>
): ConfigModule => {
return {
modules: {},
moduleResolutions: {},
...configParts,
}
}
const buildContainer = () => {
const container = createContainer() as MedusaContainer
container.registerAdd = function (
this: MedusaContainer,
name: string,
registration: typeof asFunction | typeof asValue
): MedusaContainer {
const storeKey = name + "_STORE"
if (this.registrations[storeKey] === undefined) {
this.register(storeKey, asValue([] as Resolver<unknown>[]))
}
const store = this.resolve(storeKey) as (
| ClassOrFunctionReturning<unknown>
| Resolver<unknown>
)[]
if (this.registrations[name] === undefined) {
this.register(name, asArray(store))
}
store.unshift(registration)
return this
}.bind(container)
return container
}
describe("modules loader", () => {
let container
@@ -76,7 +32,7 @@ describe("modules loader", () => {
})
beforeEach(() => {
container = buildContainer()
container = createMedusaContainer()
})
it("registers service as undefined in container when no resolution path is given", async () => {
@@ -100,10 +56,7 @@ describe("modules loader", () => {
},
}
const configModule = buildConfigModule({
moduleResolutions,
})
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
const testService = container.resolve(
moduleResolutions.testService.definition.key
@@ -132,11 +85,7 @@ describe("modules loader", () => {
},
}
const configModule = buildConfigModule({
moduleResolutions,
})
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
const testService = container.resolve(
moduleResolutions.testService.definition.key,
@@ -175,14 +124,10 @@ describe("modules loader", () => {
},
}
const configModule = buildConfigModule({
moduleResolutions,
})
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
expect(logger.warn).toHaveBeenCalledWith(
"Could not resolve module: TestService. Error: Loaders for module TestService failed: loader"
`Could not resolve module: TestService. Error: Loaders for module TestService failed: loader${EOL}`
)
})
@@ -207,14 +152,10 @@ describe("modules loader", () => {
},
}
const configModule = buildConfigModule({
moduleResolutions,
})
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
expect(logger.warn).toHaveBeenCalledWith(
"Could not resolve module: TestService. Error: No service found in module. Make sure that your module exports a service."
`Could not resolve module: TestService. Error: No service found in module. Make sure your module exports at least one service.${EOL}`
)
})
@@ -241,14 +182,11 @@ describe("modules loader", () => {
},
}
const configModule = buildConfigModule({
moduleResolutions,
})
try {
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
} catch (err) {
expect(err.message).toEqual(
"No service found in module. Make sure that your module exports a service."
"No service found in module. Make sure your module exports at least one service."
)
}
})
@@ -276,11 +214,8 @@ describe("modules loader", () => {
},
}
const configModule = buildConfigModule({
moduleResolutions,
})
try {
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
} catch (err) {
expect(err.message).toEqual(
"The module TestService has to define its scope (internal | external)"
@@ -308,14 +243,11 @@ describe("modules loader", () => {
moduleDeclaration: {
scope: MODULE_SCOPE.INTERNAL,
},
},
} as any,
}
const configModule = buildConfigModule({
moduleResolutions,
})
try {
await moduleLoader({ container, configModule, logger })
await moduleLoader({ container, moduleResolutions, logger })
} catch (err) {
expect(err.message).toEqual(
"The module TestService is missing its resources config"
packages/modules-sdk/src/loaders/__tests__/module-definitions.ts → packages/modules-sdk/src/loaders/__tests__/register-modules.ts
+87 -72
View File
@@ -1,10 +1,10 @@
import {
ConfigModule,
InternalModuleDeclaration,
ModuleDefinition,
MODULE_RESOURCE_TYPE,
MODULE_SCOPE,
} from "../../types"
import { registerModules } from "../module-definition"
import { registerModules } from "../register-modules"
import MODULE_DEFINITIONS from "../../definitions"
const RESOLVED_PACKAGE = "@medusajs/test-service-resolved"
@@ -35,17 +35,19 @@ describe("module definitions loader", () => {
it("Resolves module with default definition given empty config", () => {
MODULE_DEFINITIONS.push({ ...defaultDefinition })
const res = registerModules({ modules: {} } as ConfigModule)
const res = registerModules({ modules: {} })
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: defaultDefinition.defaultPackage,
definition: defaultDefinition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "shared",
},
})
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: defaultDefinition.defaultPackage,
definition: defaultDefinition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "shared",
},
})
)
})
describe("boolean config", () => {
@@ -54,13 +56,15 @@ describe("module definitions loader", () => {
const res = registerModules({
modules: { [defaultDefinition.key]: false },
} as ConfigModule)
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: false,
definition: defaultDefinition,
options: {},
})
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: false,
definition: defaultDefinition,
options: {},
})
)
})
it("Fails to resolve module with no resolution path when given false for a required module", () => {
@@ -70,7 +74,7 @@ describe("module definitions loader", () => {
try {
registerModules({
modules: { [defaultDefinition.key]: false },
} as ConfigModule)
})
} catch (err) {
expect(err.message).toEqual(
`Module: ${defaultDefinition.label} is required`
@@ -88,17 +92,19 @@ describe("module definitions loader", () => {
const res = registerModules({
modules: {},
} as ConfigModule)
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: false,
definition: definition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "shared",
},
})
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: false,
definition: definition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "shared",
},
})
)
})
})
@@ -110,17 +116,19 @@ describe("module definitions loader", () => {
modules: {
[defaultDefinition.key]: defaultDefinition.defaultPackage,
},
} as ConfigModule)
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: RESOLVED_PACKAGE,
definition: defaultDefinition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "shared",
},
})
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: RESOLVED_PACKAGE,
definition: defaultDefinition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "shared",
},
})
)
})
})
@@ -131,22 +139,25 @@ describe("module definitions loader", () => {
const res = registerModules({
modules: {
[defaultDefinition.key]: {
scope: MODULE_SCOPE.INTERNAL,
resolve: defaultDefinition.defaultPackage,
resources: MODULE_RESOURCE_TYPE.ISOLATED,
},
},
} as ConfigModule)
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: RESOLVED_PACKAGE,
definition: defaultDefinition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "isolated",
resolve: defaultDefinition.defaultPackage,
} as InternalModuleDeclaration,
},
})
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: RESOLVED_PACKAGE,
definition: defaultDefinition,
options: {},
moduleDeclaration: {
scope: "internal",
resources: "isolated",
resolve: defaultDefinition.defaultPackage,
},
})
)
})
it("Resolves default resolution path and provides options when only options are provided", () => {
@@ -158,18 +169,20 @@ describe("module definitions loader", () => {
options: { test: 123 },
},
},
} as unknown as ConfigModule)
} as any)
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: defaultDefinition.defaultPackage,
definition: defaultDefinition,
options: { test: 123 },
moduleDeclaration: {
scope: "internal",
resources: "shared",
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: defaultDefinition.defaultPackage,
definition: defaultDefinition,
options: { test: 123 },
},
})
moduleDeclaration: {
scope: "internal",
resources: "shared",
options: { test: 123 },
},
})
)
})
it("Resolves resolution path and provides options when only options are provided", () => {
@@ -184,19 +197,21 @@ describe("module definitions loader", () => {
resources: "isolated",
},
},
} as unknown as ConfigModule)
} as any)
expect(res[defaultDefinition.key]).toEqual({
resolutionPath: RESOLVED_PACKAGE,
definition: defaultDefinition,
options: { test: 123 },
moduleDeclaration: {
scope: "internal",
resources: "isolated",
resolve: defaultDefinition.defaultPackage,
expect(res[defaultDefinition.key]).toEqual(
expect.objectContaining({
resolutionPath: RESOLVED_PACKAGE,
definition: defaultDefinition,
options: { test: 123 },
},
})
moduleDeclaration: {
scope: "internal",
resources: "isolated",
resolve: defaultDefinition.defaultPackage,
options: { test: 123 },
},
})
)
})
})
})