Merge pull request #58 from CodelyTV/part_three_domain_event_deserializer

Part three domain event deserializer

Author: vilasmaciel

src/Contexts/Mooc/Courses/domain/CourseCreatedDomainEvent.ts

@@ -13,9 +13,9 @@ export class CourseCreatedDomainEvent extends DomainEvent {
 
   constructor({
     id,
-    eventId,
-    duration,
     name,
+    duration,
+    eventId,
     occurredOn
   }: {
     id: string;
@@ -42,7 +42,7 @@ export class CourseCreatedDomainEvent extends DomainEvent {
     body: CreateCourseDomainEventBody,
     eventId: string,
     occurredOn: Date
-  ): CourseCreatedDomainEvent {
+  ): DomainEvent {
     return new CourseCreatedDomainEvent({
       id: aggregateId,
       duration: body.duration,

src/Contexts/Mooc/CoursesCounter/application/Increment/IncrementCoursesCounterOnCourseCreated.ts

@@ -1,13 +1,14 @@
+import { DomainEventClass } from '../../../../Shared/domain/DomainEvent';
 import { DomainEventSubscriber } from '../../../../Shared/domain/DomainEventSubscriber';
 import { CourseCreatedDomainEvent } from '../../../Courses/domain/CourseCreatedDomainEvent';
-import { CoursesCounterIncrementer } from './CoursesCounterIncrementer';
 import { CourseId } from '../../../Shared/domain/Courses/CourseId';
+import { CoursesCounterIncrementer } from './CoursesCounterIncrementer';
 
 export class IncrementCoursesCounterOnCourseCreated implements DomainEventSubscriber<CourseCreatedDomainEvent> {
   constructor(private incrementer: CoursesCounterIncrementer) {}
 
-  subscribedTo(): string[] {
-    return [CourseCreatedDomainEvent.EVENT_NAME];
+  subscribedTo(): DomainEventClass[] {
+    return [CourseCreatedDomainEvent];
   }
 
   async on(domainEvent: CourseCreatedDomainEvent) {

src/Contexts/Shared/domain/DomainEvent.ts

@@ -1,6 +1,8 @@
 import { Uuid } from './value-object/Uuid';
 
 export abstract class DomainEvent {
+  static EVENT_NAME: string;
+  static fromPrimitives: (...args: any[]) => any;
   readonly aggregateId: string;
   readonly eventId: string;
   readonly occurredOn: Date;
@@ -15,3 +17,5 @@ export abstract class DomainEvent {
 
   abstract toPrimitive(): Object;
 }
+
+export type DomainEventClass = { EVENT_NAME: string, fromPrimitives(...args: any[]): DomainEvent; };

src/Contexts/Shared/domain/DomainEventSubscriber.ts

@@ -1,7 +1,7 @@
-import { DomainEvent } from './DomainEvent';
+import { DomainEvent, DomainEventClass } from './DomainEvent';
 
 export interface DomainEventSubscriber<T extends DomainEvent> {
-  subscribedTo(): Array<string>;
+  subscribedTo(): Array<DomainEventClass>;
 
   on(domainEvent: T): Promise<void>;
 }

src/Contexts/Shared/infrastructure/EventBus/DomainEventJsonDeserializer.ts

@@ -0,0 +1,27 @@
+import { DomainEvent } from '../../domain/DomainEvent';
+import { DomainEventMapping } from './DomainEventMapping';
+
+export class DomainEventJsonDeserializer {
+  private mapping: DomainEventMapping;
+
+  constructor(mapping: DomainEventMapping) {
+    this.mapping = mapping;
+  }
+
+  deserialize(event: string): DomainEvent {
+    const eventData = JSON.parse(event).data;
+    const eventName = eventData.type;
+    const eventClass = this.mapping.for(eventName);
+
+    if (!eventClass) {
+      throw new Error(`The event ${eventName} doesn't exist or has no subscribers`);
+    }
+
+    return eventClass.fromPrimitives(
+      eventData.attributes.id,
+      eventData.attributes,
+      eventData.id,
+      eventData.occurred_on
+    );
+  }
+}

src/Contexts/Shared/infrastructure/EventBus/DomainEventMapping.ts

@@ -0,0 +1,36 @@
+import { DomainEventClass, DomainEvent } from '../../domain/DomainEvent';
+import { DomainEventSubscriber } from '../../domain/DomainEventSubscriber';
+
+type Mapping = Map<string, DomainEventClass>;
+
+export class DomainEventMapping {
+  mapping: Mapping;
+
+  constructor(mapping: DomainEventSubscriber<DomainEvent>[]) {
+    this.mapping = mapping.reduce(this.eventsExtractor(), new Map<string, DomainEventClass>());
+  }
+
+  private eventsExtractor() {
+    return (map: Mapping, subscriber: DomainEventSubscriber<DomainEvent>) => {
+      subscriber.subscribedTo().forEach(this.eventNameExtractor(map));
+      return map;
+    };
+  }
+
+  private eventNameExtractor(map: Mapping): (domainEvent: DomainEventClass) => void {
+    return domainEvent => {
+      const eventName = domainEvent.EVENT_NAME;
+      map.set(eventName, domainEvent);
+    };
+  }
+
+  for(name: string): DomainEventClass {
+    const domainEvent = this.mapping.get(name);
+
+    if (!domainEvent) {
+      throw new Error(`The Domain Event Class for ${name} doesn't exists or have no subscribers`);
+    }
+
+    return domainEvent;
+  }
+}

src/Contexts/Shared/infrastructure/EventBus/EventEmitterBus.ts

@@ -1,6 +1,6 @@
+import { EventEmitter } from 'events';
 import { DomainEvent } from '../../domain/DomainEvent';
 import { DomainEventSubscriber } from '../../domain/DomainEventSubscriber';
-import { EventEmitter } from 'events';
 
 export class EventEmitterBus extends EventEmitter {
   constructor(subscribers: Array<DomainEventSubscriber<DomainEvent>>) {
@@ -17,7 +17,7 @@ export class EventEmitterBus extends EventEmitter {
 
   private registerSubscriber(subscriber: DomainEventSubscriber<DomainEvent>) {
     subscriber.subscribedTo().map(event => {
-      this.on(event, subscriber.on);
+      this.on(event.EVENT_NAME, subscriber.on);
     });
   }
 

src/Contexts/Shared/infrastructure/EventBus/InMemorySyncEventBus.ts

@@ -1,6 +1,6 @@
-import { EventBus } from '../../domain/EventBus';
 import { DomainEvent } from '../../domain/DomainEvent';
 import { DomainEventSubscriber } from '../../domain/DomainEventSubscriber';
+import { EventBus } from '../../domain/EventBus';
 
 type Subscription = {
   boundedCallback: Function;
@@ -27,7 +27,9 @@ export class InMemorySyncEventBus implements EventBus {
   }
 
   addSubscribers(subscribers: Array<DomainEventSubscriber<DomainEvent>>) {
-    subscribers.map(subscriber => subscriber.subscribedTo().map(event => this.subscribe(event, subscriber)));
+    subscribers.map(subscriber =>
+      subscriber.subscribedTo().map(event => this.subscribe(event.EVENT_NAME!, subscriber))
+    );
   }
 
   private subscribe(topic: string, subscriber: DomainEventSubscriber<DomainEvent>): void {

src/apps/mooc_backend/config/dependency-injection/Shared/application.yaml

@@ -1,5 +1,4 @@
 services:
-
   Mooc.shared.ConnectionManager:
     factory:
       class: ../../../../../Contexts/Shared/infrastructure/persistence/mongo/MongoClientFactory
@@ -13,3 +12,11 @@ services:
   Mooc.shared.EventBus:
     class: ../../../../../Contexts/Shared/infrastructure/EventBus/InMemoryAsyncEventBus
     arguments: []
+
+  Mooc.shared.EventBus.DomainEventMapping:
+    class: ../../../../../Contexts/Shared/infrastructure/EventBus/DomainEventMapping
+    arguments: ['!tagged domainEventSubscriber']
+
+  Mooc.shared.EventBus.DomainEventJsonDeserializer:
+    class: ../../../../../Contexts/Shared/infrastructure/EventBus/DomainEventJsonDeserializer
+    arguments: ['@Mooc.shared.EventBus.DomainEventMapping']

tests/Contexts/Shared/infrastructure/InMemoryAsyncEventBus.test.ts

@@ -1,7 +1,7 @@
-import { InMemoryAsyncEventBus } from '../../../../src/Contexts/Shared/infrastructure/EventBus/InMemoryAsyncEventBus';
-import { DomainEventSubscriber } from '../../../../src/Contexts/Shared/domain/DomainEventSubscriber';
 import { DomainEvent } from '../../../../src/Contexts/Shared/domain/DomainEvent';
+import { DomainEventSubscriber } from '../../../../src/Contexts/Shared/domain/DomainEventSubscriber';
 import { Uuid } from '../../../../src/Contexts/Shared/domain/value-object/Uuid';
+import { InMemoryAsyncEventBus } from '../../../../src/Contexts/Shared/infrastructure/EventBus/InMemoryAsyncEventBus';
 
 describe('InMemoryAsyncEventBus', () => {
   let subscriber: DomainEventSubscriberDummy;
@@ -35,8 +35,8 @@ class DummyEvent extends DomainEvent {
 }
 
 class DomainEventSubscriberDummy implements DomainEventSubscriber<DummyEvent> {
-  subscribedTo(): string[] {
-    return [DummyEvent.EVENT_NAME];
+  subscribedTo(): any[] {
+    return [DummyEvent];
   }
 
   async on(domainEvent: DummyEvent) {