chore(): Move event bus local logging (#14244)

**what**
Log only when actually processing events
This commit is contained in:
Adrien de Peretti
2025-12-09 19:27:38 +01:00
committed by GitHub
parent c26f5643b6
commit bff0142e7a
4 changed files with 35 additions and 18 deletions

View File

@@ -0,0 +1,5 @@
---
"@medusajs/event-bus-local": patch
---
chore(): Move event bus local logging

View File

@@ -28,7 +28,7 @@
"scripts": { "scripts": {
"watch": "yarn run -T tsc --build --watch", "watch": "yarn run -T tsc --build --watch",
"build": "yarn run -T rimraf dist && yarn run -T tsc --build", "build": "yarn run -T rimraf dist && yarn run -T tsc --build",
"test": "../../../node_modules/.bin/jest --passWithNoTests", "test": "../../../node_modules/.bin/jest --passWithNoTests --testPathPattern=src",
"test:integration": "../../../node_modules/.bin/jest --passWithNoTests --no-cache --bail --detectOpenHandles --forceExit --logHeapUsage --testPathPattern=\"integration-tests/__tests__/.*\\.spec\\.ts\"" "test:integration": "../../../node_modules/.bin/jest --passWithNoTests --no-cache --bail --detectOpenHandles --forceExit --logHeapUsage --testPathPattern=\"integration-tests/__tests__/.*\\.spec\\.ts\""
}, },
"peerDependencies": { "peerDependencies": {

View File

@@ -78,8 +78,6 @@ describe("LocalEventBusService", () => {
name: "eventName", name: "eventName",
}) })
expect(loggerMock.info).toHaveBeenCalledTimes(0)
await eventBus.emit( await eventBus.emit(
{ {
name: "eventName", name: "eventName",
@@ -99,7 +97,7 @@ describe("LocalEventBusService", () => {
name: "eventName", name: "eventName",
}) })
expect(loggerMock.info).toHaveBeenCalledTimes(0) expect(loggerMock.info).toHaveBeenCalledTimes(1)
}) })
it("should emit multiple events", async () => { it("should emit multiple events", async () => {

View File

@@ -22,7 +22,7 @@ eventEmitter.setMaxListeners(Infinity)
// eslint-disable-next-line max-len // eslint-disable-next-line max-len
export default class LocalEventBusService extends AbstractEventBusModuleService { export default class LocalEventBusService extends AbstractEventBusModuleService {
protected readonly logger_?: Logger protected readonly logger_: Logger
protected readonly eventEmitter_: EventEmitter protected readonly eventEmitter_: EventEmitter
protected groupedEventsMap_: StagingQueueType protected groupedEventsMap_: StagingQueueType
@@ -35,11 +35,27 @@ export default class LocalEventBusService extends AbstractEventBusModuleService
// eslint-disable-next-line prefer-rest-params // eslint-disable-next-line prefer-rest-params
super(...arguments) super(...arguments)
this.logger_ = logger this.logger_ = logger ?? console
this.eventEmitter_ = eventEmitter this.eventEmitter_ = eventEmitter
this.groupedEventsMap_ = new Map() this.groupedEventsMap_ = new Map()
} }
private logProcessingEvent(
eventData: Message,
options: Record<string, unknown> = {},
totalSubscribers: number
) {
if (
totalSubscribers &&
!options?.internal &&
!eventData.options?.internal
) {
this.logger_.info(
`Processing ${eventData.name} which has ${totalSubscribers} subscribers`
)
}
}
/** /**
* Accept an event name and some options * Accept an event name and some options
* *
@@ -55,16 +71,6 @@ export default class LocalEventBusService extends AbstractEventBusModuleService
: [eventsData] : [eventsData]
for (const eventData of normalizedEventsData) { for (const eventData of normalizedEventsData) {
const eventListenersCount = this.eventEmitter_.listenerCount(
eventData.name
)
if (!options.internal && !eventData.options?.internal) {
this.logger_?.info(
`Processing ${eventData.name} which has ${eventListenersCount} subscribers`
)
}
await this.groupOrEmitEvent({ await this.groupOrEmitEvent({
...eventData, ...eventData,
options, options,
@@ -103,6 +109,10 @@ export default class LocalEventBusService extends AbstractEventBusModuleService
if (hasStarSubscriber) { if (hasStarSubscriber) {
this.eventEmitter_.emit("*", eventBody) this.eventEmitter_.emit("*", eventBody)
} }
const totalSubscribers =
eventListenersCount + (hasStarSubscriber ? 1 : 0)
this.logProcessingEvent(eventData, options, totalSubscribers)
}) })
} }
} }
@@ -144,6 +154,10 @@ export default class LocalEventBusService extends AbstractEventBusModuleService
if (hasStarSubscriber) { if (hasStarSubscriber) {
this.eventEmitter_.emit("*", eventBody) this.eventEmitter_.emit("*", eventBody)
} }
const totalSubscribers =
eventListenersCount + (hasStarSubscriber ? 1 : 0)
this.logProcessingEvent(event, options, totalSubscribers)
}) })
} }
@@ -179,10 +193,10 @@ export default class LocalEventBusService extends AbstractEventBusModuleService
try { try {
await subscriber(data) await subscriber(data)
} catch (err) { } catch (err) {
this.logger_?.error( this.logger_.error(
`An error occurred while processing ${event.toString()}:` `An error occurred while processing ${event.toString()}:`
) )
this.logger_?.error(err) this.logger_.error(err)
} }
} }