feat: add validate option to EventPusher

Author: Pierre Milliotte

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

packages/core/src/event/eventType.ts

@@ -1,6 +1,24 @@
 import type { EventDetail } from './eventDetail';
 import { reservedEventTypes } from './reservedEventTypes';
 
+export type ParsedEventDetail<TYPE extends string, PAYLOAD, METADATA> =
+  | {
+      isValid: true;
+      parsedEventDetail: EventDetail<TYPE, PAYLOAD, METADATA>;
+      parsingErrors?: never;
+    }
+  | {
+      isValid: false;
+      parsedEventDetail?: never;
+      parsingErrors: [Error, ...Error[]];
+    };
+
+export type EventDetailParser<
+  TYPE extends string = string,
+  PAYLOAD = unknown,
+  METADATA = unknown,
+> = (candidate: EventDetail) => ParsedEventDetail<TYPE, PAYLOAD, METADATA>;
+
 export class EventType<
   TYPE extends string = string,
   PAYLOAD = string extends TYPE ? unknown : never,
@@ -10,26 +28,22 @@ export class EventType<
     detail: EventDetail<TYPE, PAYLOAD, METADATA>;
   };
   type: TYPE;
-  parseEventDetail?: (candidate: unknown) =>
-    | {
-        isValid: true;
-        parsedEventDetail: EventDetail<TYPE, PAYLOAD, METADATA>;
-        parsingErrors?: never;
-      }
-    | {
-        isValid: false;
-        parsedEventDetail?: never;
-        parsingErrors?: [Error, ...Error[]];
-      };
+  parseEventDetail?: EventDetailParser<TYPE, PAYLOAD>;
 
-  constructor({ type }: { type: TYPE }) {
+  constructor({
+    type,
+    parseEventDetail,
+  }: {
+    type: TYPE;
+    parseEventDetail?: EventDetailParser<TYPE, PAYLOAD>;
+  }) {
     if (reservedEventTypes.has(type)) {
       throw new Error(
         `${type} is a reserved event type. Please chose another one.`,
       );
     }
-
     this.type = type;
+    this.parseEventDetail = parseEventDetail;
   }
 }
 

packages/core/src/eventStore/errors/eventDetailParserNotDefined.ts

@@ -0,0 +1,7 @@
+export class EventDetailParserNotDefinedError extends Error {
+  constructor(type: string) {
+    super(
+      `Can not validate input because EventType "${type}" has no parseEventDetail method defined.`,
+    );
+  }
+}

packages/core/src/eventStore/errors/eventDetailTypeDoesNotExist.ts

@@ -0,0 +1,15 @@
+export class EventDetailTypeDoesNotExistError extends Error {
+  constructor({
+    type,
+    allowedTypes,
+  }: {
+    type: string;
+    allowedTypes: string[];
+  }) {
+    super(
+      `${type} is not a valid event detail type. Allowed types are ${allowedTypes.join(
+        ', ',
+      )}.`,
+    );
+  }
+}

packages/core/src/eventStore/errors/index.ts

@@ -1,3 +1,5 @@
 export * from './aggregateNotFound';
 export * from './eventAlreadyExists';
+export * from './eventDetailTypeDoesNotExist';
+export * from './eventDetailParserNotDefined';
 export * from './undefinedEventStorageAdapter';

packages/core/src/eventStore/eventStore.ts

@@ -1,11 +1,19 @@
 /* eslint-disable max-lines */
 import type { Aggregate } from '~/aggregate';
 import type { EventDetail } from '~/event/eventDetail';
-import type { EventType, EventTypeDetails } from '~/event/eventType';
+import type {
+  EventDetailParser,
+  EventType,
+  EventTypeDetails,
+} from '~/event/eventType';
 import { GroupedEvent } from '~/event/groupedEvent';
 import type { EventStorageAdapter } from '~/eventStorageAdapter';
 import type { $Contravariant } from '~/utils';
 
+import {
+  EventDetailParserNotDefinedError,
+  EventDetailTypeDoesNotExistError,
+} from './errors';
 import { AggregateNotFoundError } from './errors/aggregateNotFound';
 import { UndefinedEventStorageAdapterError } from './errors/undefinedEventStorageAdapter';
 import type {
@@ -20,6 +28,7 @@ import type {
   AggregateGetter,
   AggregateSimulator,
   Reducer,
+  ValidateEventDetail,
 } from './types';
 
 export class EventStore<
@@ -178,10 +187,58 @@ export class EventStore<
          */
       ) as Promise<{ events: EVENT_DETAILS[] }>;
 
+    const shouldValidateEventDetail = (
+      validate: ValidateEventDetail,
+      eventDetailType: string,
+      eventType?: EventType,
+    ): eventType is EventType => {
+      if (validate === false) {
+        return false;
+      }
+
+      if (eventType === undefined) {
+        throw new EventDetailTypeDoesNotExistError({
+          type: eventDetailType,
+          allowedTypes: this.eventTypes.map(({ type }) => type),
+        });
+      }
+
+      if (validate === 'auto' && eventType.parseEventDetail === undefined) {
+        return false;
+      }
+
+      return true;
+    };
+
+    const validateEventDetail = (
+      eventDetail: EventDetail,
+      eventDetailParser?: EventDetailParser,
+    ) => {
+      if (eventDetailParser === undefined) {
+        throw new EventDetailParserNotDefinedError(eventDetail.type);
+      }
+
+      const { parsingErrors, isValid } = eventDetailParser(eventDetail);
+
+      if (isValid) {
+        return;
+      }
+
+      throw new Error(parsingErrors[0].message);
+    };
+
     this.pushEvent = async (
       eventDetail,
-      { prevAggregate, force = false } = {},
+      { prevAggregate, force = false, validate = 'auto' } = {},
     ) => {
+      const eventType = this.eventTypes.find(
+        ({ type }) => type === eventDetail.type,
+      );
+
+      if (shouldValidateEventDetail(validate, eventDetail.type, eventType)) {
+        validateEventDetail(eventDetail, eventType.parseEventDetail);
+      }
+
       const eventStorageAdapter = this.getEventStorageAdapter();
 
       const { event } = (await eventStorageAdapter.pushEvent(eventDetail, {

packages/core/src/eventStore/eventStore.type.test.ts

@@ -11,6 +11,7 @@ import {
   EventStoreAggregate,
   EventStoreEventDetails,
   GetAggregateOptions,
+  ValidateEventDetail,
 } from '~/eventStore';
 
 import {
@@ -109,7 +110,12 @@ assertPushEventInput1;
 
 const assertPushEventInput2: A.Equals<
   Parameters<typeof pokemonsEventStore.pushEvent>[1],
-  { prevAggregate?: PokemonAggregate | undefined; force?: boolean } | undefined
+  | {
+      prevAggregate?: PokemonAggregate | undefined;
+      force?: boolean;
+      validate?: ValidateEventDetail;
+    }
+  | undefined
 > = 1;
 assertPushEventInput2;
 

packages/core/src/eventStore/types.ts

@@ -28,6 +28,8 @@ export type EventsGetter<EVENT_DETAIL extends EventDetail> = (
   options?: EventsQueryOptions,
 ) => Promise<{ events: EVENT_DETAIL[] }>;
 
+export type ValidateEventDetail = boolean | 'auto';
+
 export type EventPusher<
   EVENT_DETAILS extends EventDetail,
   $EVENT_DETAILS extends EventDetail,
@@ -37,7 +39,11 @@ export type EventPusher<
   event: $EVENT_DETAILS extends EventDetail
     ? OptionalTimestamp<$EVENT_DETAILS>
     : $EVENT_DETAILS,
-  options?: { prevAggregate?: $AGGREGATE; force?: boolean },
+  options?: {
+    prevAggregate?: $AGGREGATE;
+    force?: boolean;
+    validate?: ValidateEventDetail;
+  },
 ) => Promise<{ event: EVENT_DETAILS; nextAggregate?: AGGREGATE }>;
 
 export type AggregateIdsLister = (

packages/core/src/index.ts

@@ -1,5 +1,9 @@
 export type { Aggregate } from './aggregate';
-export { EventType } from './event/eventType';
+export {
+  EventType,
+  EventDetailParser,
+  ParsedEventDetail,
+} from './event/eventType';
 export type { EventTypeDetail, EventTypeDetails } from './event/eventType';
 export { GroupedEvent } from './event/groupedEvent';
 export { __REPLAYED__, __AGGREGATE_EXISTS__ } from './event/reservedEventTypes';