feat(modules-sdk, types, user, utils):init user module events (#6431)

* init user module events

* refactor utils

* undo test script update

* fix feedback

* add eventbus service to module test-runner

* add injected dependencies

* move events to utils

* use const eventname in tests

* rm withTransaction

packages/utils/src/bundles.ts

@@ -11,4 +11,5 @@ export * as ProductUtils from "./product"
 export * as PromotionUtils from "./promotion"
 export * as SearchUtils from "./search"
 export * as ShippingProfileUtils from "./shipping"
+export * as UserUtils from "./user"
 export * as ApiKeyUtils from "./api-key"

packages/utils/src/event-bus/message-aggregator.ts

@@ -1,9 +1,12 @@
 import {
+  EventBusTypes,
   IMessageAggregator,
   Message,
   MessageAggregatorFormat,
 } from "@medusajs/types"
 
+import { buildEventMessages } from "./build-event-messages"
+
 export class MessageAggregator implements IMessageAggregator {
   private messages: Message[]
 
@@ -23,6 +26,15 @@ export class MessageAggregator implements IMessageAggregator {
     }
   }
 
+  saveRawMessageData<T>(
+    messageData:
+      | EventBusTypes.MessageFormat<T>
+      | EventBusTypes.MessageFormat<T>[],
+    options?: Record<string, unknown>
+  ): void {
+    this.save(buildEventMessages(messageData, options))
+  }
+
   getMessages(format?: MessageAggregatorFormat): {
     [group: string]: Message[]
   } {

packages/utils/src/index.ts

@@ -19,6 +19,7 @@ export * from "./search"
 export * from "./shipping"
 export * from "./totals"
 export * from "./totals/big-number"
+export * from "./user"
 export * from "./api-key"
 
 export const MedusaModuleType = Symbol.for("MedusaModule")

packages/utils/src/modules-sdk/abstract-module-service-factory.ts

@@ -474,6 +474,19 @@ export function abstractModuleServiceFactory<
         /* ignore */
       }
     }
+
+    protected async emitEvents_(groupedEvents) {
+      if (!this.eventBusModuleService_ || !groupedEvents) {
+        return
+      }
+
+      const promises: Promise<void>[] = []
+      for (const group of Object.keys(groupedEvents)) {
+        promises.push(this.eventBusModuleService_?.emit(groupedEvents[group]))
+      }
+
+      await Promise.all(promises)
+    }
   }
 
   const mainModelMethods = buildMethodNamesFromModel(mainModel, false)

packages/utils/src/modules-sdk/decorators/emit-events.ts

@@ -0,0 +1,26 @@
+import { MessageAggregator } from "../../event-bus"
+import { InjectIntoContext } from "./inject-into-context"
+
+export function EmitEvents() {
+  return function (
+    target: any,
+    propertyKey: string | symbol,
+    descriptor: any
+  ): void {
+    const aggregator = new MessageAggregator()
+    InjectIntoContext({
+      messageAggregator: () => aggregator,
+    })(target, propertyKey, descriptor)
+
+    const original = descriptor.value
+
+    descriptor.value = async function (...args: any[]) {
+      const result = await original.apply(this, args)
+
+      await target.emitEvents_.apply(this, [aggregator.getMessages()])
+
+      aggregator.clearMessages()
+      return result
+    }
+  }
+}

packages/utils/src/modules-sdk/decorators/index.ts

@@ -2,3 +2,5 @@ export * from "./context-parameter"
 export * from "./inject-manager"
 export * from "./inject-shared-context"
 export * from "./inject-transaction-manager"
+export * from "./inject-into-context"
+export * from "./emit-events"

packages/utils/src/modules-sdk/decorators/inject-into-context.ts

@@ -1,3 +1,5 @@
+import { MessageAggregator } from "../../event-bus"
+
 export function InjectIntoContext(
   properties: Record<string, unknown | Function>
 ): MethodDecorator {

packages/utils/src/user/events.ts

@@ -0,0 +1,8 @@
+import { CommonEvents } from "../event-bus"
+
+export const UserEvents = {
+  created: "user." + CommonEvents.CREATED,
+  updated: "user." + CommonEvents.UPDATED,
+  invite_created: "invite." + CommonEvents.CREATED,
+  invite_updated: "invite." + CommonEvents.UPDATED,
+}

packages/utils/src/user/index.ts

@@ -0,0 +1 @@
+export * from "./events"