chore(framework): Move and improve subscriber loader (#8347)
**What** Move `SubscriberLoader` and improve implementation FIXES FRMW-2635
This commit is contained in:
Adrien de Peretti authored and 
GitHub committed
1 parent
169953ad1e
commit
a9fea986b0
17 files changed
+158
-202
No files matched your search
-18
@@ -1,18 +0,0 @@
|
||||
import {
|
||||
SubscriberArgs,
|
||||
SubscriberConfig,
|
||||
} from "../../../../../types/subscribers"
|
||||
|
||||
export default async function orderNotifier({
|
||||
data,
|
||||
eventName,
|
||||
container,
|
||||
pluginOptions,
|
||||
}: SubscriberArgs) {
|
||||
return Promise.resolve()
|
||||
}
|
||||
|
||||
export const config: SubscriberConfig = {
|
||||
event: ["order.placed", "order.canceled", "order.completed"],
|
||||
context: { subscriberId: "order-notifier" },
|
||||
}
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
import {
|
||||
SubscriberArgs,
|
||||
SubscriberConfig,
|
||||
} from "../../../../../types/subscribers"
|
||||
|
||||
export default async function productUpdater({
|
||||
data,
|
||||
eventName,
|
||||
container,
|
||||
pluginOptions,
|
||||
}: SubscriberArgs) {
|
||||
return Promise.resolve()
|
||||
}
|
||||
|
||||
export const config: SubscriberConfig = {
|
||||
event: "product.updated",
|
||||
context: {
|
||||
subscriberId: "product-updater",
|
||||
},
|
||||
}
|
||||
-17
@@ -1,17 +0,0 @@
|
||||
import {
|
||||
SubscriberArgs,
|
||||
SubscriberConfig,
|
||||
} from "../../../../../types/subscribers"
|
||||
|
||||
export default async function ({
|
||||
data,
|
||||
eventName,
|
||||
container,
|
||||
pluginOptions,
|
||||
}: SubscriberArgs) {
|
||||
return Promise.resolve()
|
||||
}
|
||||
|
||||
export const config: SubscriberConfig = {
|
||||
event: "variant.created",
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
import { ModuleRegistrationName } from "@medusajs/utils"
|
||||
|
||||
export const eventBusServiceMock = {
|
||||
subscribe: jest.fn().mockImplementation((...args) => {
|
||||
return Promise.resolve(args)
|
||||
}),
|
||||
}
|
||||
|
||||
export const containerMock = {
|
||||
// mock .resolve method so if its called with "eventBusService" it returns the mock
|
||||
resolve: jest.fn().mockImplementation((name: string) => {
|
||||
if (name === ModuleRegistrationName.EVENT_BUS) {
|
||||
return eventBusServiceMock
|
||||
} else {
|
||||
return {}
|
||||
}
|
||||
}),
|
||||
}
|
||||
@@ -1,114 +0,0 @@
|
||||
import { MedusaContainer } from "@medusajs/types"
|
||||
import { join } from "path"
|
||||
import { containerMock, eventBusServiceMock } from "../__mocks__"
|
||||
import { SubscriberLoader } from "../index"
|
||||
|
||||
describe("SubscriberLoader", () => {
|
||||
const rootDir = join(__dirname, "../__fixtures__", "subscribers")
|
||||
|
||||
const pluginOptions = {
|
||||
important_data: {
|
||||
enabled: true,
|
||||
},
|
||||
}
|
||||
|
||||
let registeredPaths: string[] = []
|
||||
|
||||
beforeAll(async () => {
|
||||
jest.clearAllMocks()
|
||||
|
||||
const paths = await new SubscriberLoader(
|
||||
rootDir,
|
||||
containerMock as unknown as MedusaContainer,
|
||||
pluginOptions
|
||||
).load()
|
||||
|
||||
if (paths) {
|
||||
registeredPaths = [...registeredPaths, ...paths]
|
||||
}
|
||||
})
|
||||
|
||||
it("should register each subscriber in the '/subscribers' folder", async () => {
|
||||
// As '/subscribers' contains 3 subscribers, we expect the number of registered paths to be 3
|
||||
expect(registeredPaths.length).toEqual(3)
|
||||
})
|
||||
|
||||
it("should have registered subscribers for 5 events", async () => {
|
||||
/**
|
||||
* The 'product-updater.ts' subscriber is registered for the following events:
|
||||
* - "product.created"
|
||||
* The 'order-updater.ts' subscriber is registered for the following events:
|
||||
* - "order.placed"
|
||||
* - "order.canceled"
|
||||
* - "order.completed"
|
||||
* The 'variant-created.ts' subscriber is registered for the following events:
|
||||
* - "variant.created"
|
||||
*
|
||||
* This means that we expect the eventBusServiceMock.subscribe method to have
|
||||
* been called times, once for 'product-updater.ts', once for 'variant-created.ts',
|
||||
* and 3 times for 'order-updater.ts'.
|
||||
*/
|
||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledTimes(5)
|
||||
})
|
||||
|
||||
it("should have registered subscribers with the correct props", async () => {
|
||||
/**
|
||||
* The 'product-updater.ts' subscriber is registered
|
||||
* with a explicit subscriberId of "product-updater".
|
||||
*/
|
||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
||||
"product.updated",
|
||||
expect.any(Function),
|
||||
{
|
||||
subscriberId: "product-updater",
|
||||
}
|
||||
)
|
||||
|
||||
/**
|
||||
* The 'order-updater.ts' subscriber is registered
|
||||
* without an explicit subscriberId, which means that
|
||||
* the loader tries to infer one from either the handler
|
||||
* functions name or the file name. In this case, the
|
||||
* handler function is named 'orderUpdater' and is used
|
||||
* to infer the subscriberId.
|
||||
*/
|
||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
||||
"order.placed",
|
||||
expect.any(Function),
|
||||
{
|
||||
subscriberId: "order-notifier",
|
||||
}
|
||||
)
|
||||
|
||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
||||
"order.canceled",
|
||||
expect.any(Function),
|
||||
{
|
||||
subscriberId: "order-notifier",
|
||||
}
|
||||
)
|
||||
|
||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
||||
"order.completed",
|
||||
expect.any(Function),
|
||||
{
|
||||
subscriberId: "order-notifier",
|
||||
}
|
||||
)
|
||||
|
||||
/**
|
||||
* The 'variant-created.ts' subscriber is registered
|
||||
* without an explicit subscriberId, and with an anonymous
|
||||
* handler function. This means that the loader tries to
|
||||
* infer the subscriberId from the file name, which in this
|
||||
* case is 'variant-created.ts'.
|
||||
*/
|
||||
expect(eventBusServiceMock.subscribe).toHaveBeenCalledWith(
|
||||
"variant.created",
|
||||
expect.any(Function),
|
||||
{
|
||||
subscriberId: "variant-created",
|
||||
}
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -1,244 +0,0 @@
|
||||
import {
|
||||
Event,
|
||||
IEventBusModuleService,
|
||||
MedusaContainer,
|
||||
Subscriber,
|
||||
} from "@medusajs/types"
|
||||
import { kebabCase, ModuleRegistrationName } from "@medusajs/utils"
|
||||
import { readdir } from "fs/promises"
|
||||
import { extname, join, sep } from "path"
|
||||
|
||||
import { SubscriberArgs, SubscriberConfig } from "../../../types/subscribers"
|
||||
import { logger } from "@medusajs/framework"
|
||||
|
||||
type SubscriberHandler<T> = (args: SubscriberArgs<T>) => Promise<void>
|
||||
|
||||
type SubscriberModule<T> = {
|
||||
config: SubscriberConfig
|
||||
handler: SubscriberHandler<T>
|
||||
}
|
||||
|
||||
export class SubscriberLoader {
|
||||
protected container_: MedusaContainer
|
||||
protected pluginOptions_: Record<string, unknown>
|
||||
protected rootDir_: string
|
||||
protected excludes: RegExp[] = [
|
||||
/\.DS_Store/,
|
||||
/(\.ts\.map|\.js\.map|\.d\.ts|\.md)/,
|
||||
/^_[^/\\]*(\.[^/\\]+)?$/,
|
||||
]
|
||||
|
||||
protected subscriberDescriptors_: Map<string, SubscriberModule<any>> =
|
||||
new Map()
|
||||
|
||||
constructor(
|
||||
rootDir: string,
|
||||
container: MedusaContainer,
|
||||
options: Record<string, unknown> = {}
|
||||
) {
|
||||
this.rootDir_ = rootDir
|
||||
this.pluginOptions_ = options
|
||||
this.container_ = container
|
||||
}
|
||||
|
||||
private validateSubscriber(
|
||||
subscriber: any,
|
||||
path: string
|
||||
): subscriber is {
|
||||
default: SubscriberHandler<unknown>
|
||||
config: SubscriberConfig
|
||||
} {
|
||||
const handler = subscriber.default
|
||||
|
||||
if (!handler || typeof handler !== "function") {
|
||||
/**
|
||||
* If the handler is not a function, we can't use it
|
||||
*/
|
||||
logger.warn(`The subscriber in ${path} is not a function.`)
|
||||
return false
|
||||
}
|
||||
|
||||
const config = subscriber.config
|
||||
|
||||
if (!config) {
|
||||
/**
|
||||
* If the subscriber is missing a config, we can't use it
|
||||
*/
|
||||
logger.warn(`The subscriber in ${path} is missing a config.`)
|
||||
return false
|
||||
}
|
||||
|
||||
if (!config.event) {
|
||||
/**
|
||||
* If the subscriber is missing an event, we can't use it.
|
||||
* In production we throw an error, else we log a warning
|
||||
*/
|
||||
if (process.env.NODE_ENV === "production") {
|
||||
throw new Error(`The subscriber in ${path} is missing an event.`)
|
||||
} else {
|
||||
logger.warn(`The subscriber in ${path} is missing an event.`)
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
if (
|
||||
typeof config.event !== "string" &&
|
||||
!Array.isArray(config.event) &&
|
||||
!config.event.every((e: unknown) => typeof e === "string")
|
||||
) {
|
||||
/**
|
||||
* If the subscribers event is not a string or an array of strings, we can't use it
|
||||
*/
|
||||
logger.warn(
|
||||
`The subscriber in ${path} has an invalid event. The event must be a string or an array of strings.`
|
||||
)
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
private async createDescriptor(absolutePath: string, entry: string) {
|
||||
return await import(absolutePath).then((module_) => {
|
||||
const isValid = this.validateSubscriber(module_, absolutePath)
|
||||
|
||||
if (!isValid) {
|
||||
return
|
||||
}
|
||||
|
||||
this.subscriberDescriptors_.set(absolutePath, {
|
||||
config: module_.config,
|
||||
handler: module_.default,
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
private async createMap(dirPath: string) {
|
||||
await Promise.all(
|
||||
await readdir(dirPath, { withFileTypes: true }).then(async (entries) => {
|
||||
return entries
|
||||
.filter((entry) => {
|
||||
if (
|
||||
this.excludes.length &&
|
||||
this.excludes.some((exclude) => exclude.test(entry.name))
|
||||
) {
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
})
|
||||
.map(async (entry) => {
|
||||
const fullPath = join(dirPath, entry.name)
|
||||
|
||||
if (entry.isDirectory()) {
|
||||
return await this.createMap(fullPath)
|
||||
}
|
||||
|
||||
return await this.createDescriptor(fullPath, entry.name)
|
||||
})
|
||||
})
|
||||
)
|
||||
}
|
||||
|
||||
private inferIdentifier<T>(
|
||||
fileName: string,
|
||||
config: SubscriberConfig,
|
||||
handler: SubscriberHandler<T>
|
||||
) {
|
||||
const { context } = config
|
||||
|
||||
/**
|
||||
* If subscriberId is provided, use that
|
||||
*/
|
||||
if (context?.subscriberId) {
|
||||
return context.subscriberId
|
||||
}
|
||||
|
||||
const handlerName = handler.name
|
||||
|
||||
/**
|
||||
* If the handler is not anonymous, use the name
|
||||
*/
|
||||
if (handlerName && !handlerName.startsWith("_default")) {
|
||||
return kebabCase(handlerName)
|
||||
}
|
||||
|
||||
/**
|
||||
* If the handler is anonymous, use the file name
|
||||
*/
|
||||
const idFromFile =
|
||||
fileName.split(sep).pop()?.replace(extname(fileName), "") ?? ""
|
||||
|
||||
return kebabCase(idFromFile)
|
||||
}
|
||||
|
||||
private createSubscriber<T = unknown>({
|
||||
fileName,
|
||||
config,
|
||||
handler,
|
||||
}: {
|
||||
fileName: string
|
||||
config: SubscriberConfig
|
||||
handler: SubscriberHandler<T>
|
||||
}) {
|
||||
const eventBusService: IEventBusModuleService = this.container_.resolve(
|
||||
ModuleRegistrationName.EVENT_BUS
|
||||
)
|
||||
|
||||
const { event } = config
|
||||
|
||||
const events = Array.isArray(event) ? event : [event]
|
||||
|
||||
const subscriberId = this.inferIdentifier(fileName, config, handler)
|
||||
|
||||
for (const e of events) {
|
||||
const subscriber = async (data: T) => {
|
||||
return await handler({
|
||||
event: { name: e, ...data } as unknown as Event<T>,
|
||||
container: this.container_,
|
||||
pluginOptions: this.pluginOptions_,
|
||||
})
|
||||
}
|
||||
|
||||
eventBusService.subscribe(e, subscriber as Subscriber, {
|
||||
...(config.context ?? {}),
|
||||
subscriberId,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
async load() {
|
||||
let hasSubscriberDir = false
|
||||
|
||||
try {
|
||||
await readdir(this.rootDir_)
|
||||
hasSubscriberDir = true
|
||||
} catch (err) {
|
||||
logger.debug(`No subscriber directory found in ${this.rootDir_}`)
|
||||
hasSubscriberDir = false
|
||||
}
|
||||
|
||||
if (!hasSubscriberDir) {
|
||||
return
|
||||
}
|
||||
|
||||
await this.createMap(this.rootDir_)
|
||||
|
||||
const map = this.subscriberDescriptors_
|
||||
|
||||
for (const [fileName, { config, handler }] of map.entries()) {
|
||||
this.createSubscriber({
|
||||
fileName,
|
||||
config,
|
||||
handler,
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the file paths of the registered subscribers, to prevent the
|
||||
* backwards compatible loader from trying to register them.
|
||||
*/
|
||||
return [...map.keys()]
|
||||
}
|
||||
}
|
||||
@@ -15,12 +15,12 @@ import {
|
||||
featureFlagsLoader,
|
||||
logger,
|
||||
pgConnectionLoader,
|
||||
SubscriberLoader,
|
||||
} from "@medusajs/framework"
|
||||
import { registerJobs } from "./helpers/register-jobs"
|
||||
import { registerWorkflows } from "./helpers/register-workflows"
|
||||
import { getResolvedPlugins } from "./helpers/resolve-plugins"
|
||||
import { resolvePluginsLinks } from "./helpers/resolve-plugins-links"
|
||||
import { SubscriberLoader } from "./helpers/subscribers"
|
||||
import loadMedusaApp from "./medusa-app"
|
||||
|
||||
type Options = {
|
||||
@@ -39,17 +39,11 @@ const shouldLoadBackgroundProcessors = (configModule) => {
|
||||
)
|
||||
}
|
||||
|
||||
async function subscribersLoader(
|
||||
plugins: PluginDetails[],
|
||||
container: MedusaContainer
|
||||
) {
|
||||
async function subscribersLoader(plugins: PluginDetails[]) {
|
||||
/**
|
||||
* Load subscribers from the medusa/medusa package
|
||||
*/
|
||||
await new SubscriberLoader(
|
||||
path.join(__dirname, "../subscribers"),
|
||||
container
|
||||
).load()
|
||||
await new SubscriberLoader(path.join(__dirname, "../subscribers")).load()
|
||||
|
||||
/**
|
||||
* Load subscribers from all the plugins.
|
||||
@@ -58,7 +52,7 @@ async function subscribersLoader(
|
||||
plugins.map(async (pluginDetails) => {
|
||||
await new SubscriberLoader(
|
||||
path.join(pluginDetails.resolve, "subscribers"),
|
||||
container
|
||||
pluginDetails.options
|
||||
).load()
|
||||
})
|
||||
)
|
||||
@@ -83,7 +77,7 @@ async function loadEntrypoints(
|
||||
)
|
||||
|
||||
if (shouldLoadBackgroundProcessors(configModule)) {
|
||||
await subscribersLoader(plugins, container)
|
||||
await subscribersLoader(plugins)
|
||||
await jobsLoader(plugins)
|
||||
}
|
||||
|
||||
|
||||
Reference in new issue
Block a user