Merge pull request #526 from bitloops/feature-orchestrator

changes for orchestrator support

Author: ellik95

boilerplate/ts/core/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitloops/bl-boilerplate-core",
-  "version": "1.0.0",
+  "version": "1.1.4",
   "description": "TypeScript boilerplate code for Bitloops Language generated projects",
   "engines": {
     "node": ">= 13"

boilerplate/ts/core/package.json

@@ -1,4 +1,7 @@
+import { Message } from '../domain/messages/IMessage.js';
+import { UUIDv4 } from '../domain/UUIDv4.js';
 import { Either } from '../Either';
+import { asyncLocalStorage } from '../helpers/asyncLocalStorage.js';
 import { ICoreError } from '../ICoreError';
 
 /**
@@ -34,3 +37,42 @@ export interface QueryHandler<IRequest, IOkResponse> {
   get boundedContext(): string;
   execute(request?: IRequest): Promise<Either<IOkResponse, ICoreError>>;
 }
+
+const CONTEXT = 'context';
+export abstract class OrchestratorHandler<IRequest, IOkResponse> {
+  abstract get triggerMessage(): any;
+  abstract get boundedContext(): string; // TODO check if we can add many
+  abstract get domainEvents(): any[];
+  abstract get systemEventNames(): string[];
+  abstract get integrationEvents(): any[];
+  abstract listen(message: Message): Promise<Either<IOkResponse, ICoreError>>;
+
+  get orchestratorNameId(): string {
+    return this.constructor.name;
+  }
+
+  protected isTriggerMessage(message: Message): boolean {
+    return message.metadata.name === this.triggerMessage.name;
+  }
+
+  async trigger(message: Message): Promise<void> {
+    const orchestratorInstanceId = new UUIDv4().toString();
+    const store = asyncLocalStorage.getStore();
+    if (!store) {
+      throw new Error('No store found, did you forget to attach correlation middleware?');
+    }
+    const ctx = store.get(CONTEXT);
+    const ctxWithStorybookPort = {
+      ...ctx,
+      orchestratorInstanceId,
+    };
+    store.set(CONTEXT, ctxWithStorybookPort);
+    message.metadata.context.orchestratorInstanceId = orchestratorInstanceId;
+  }
+
+  public getOrchestratorNameId() {
+    return {
+      orchestratorNameId: this.orchestratorNameId,
+    };
+  }
+}

boilerplate/ts/core/src/application/UseCase.ts

@@ -30,7 +30,7 @@ export interface ICommand {
 export abstract class Command extends Message implements ICommand {
   [x: string]: any;
   public declare readonly metadata: CommandMetadata;
-  constructor(boundedContextId: string, metadata?: Partial<CommandMetadata>) {
+  constructor(boundedContextId: string, metadata: Partial<CommandMetadata> = {}) {
     super(metadata);
     this.metadata.boundedContextId = boundedContextId;
   }

boilerplate/ts/core/src/domain/commands/Command.ts

@@ -1,4 +1,5 @@
 export type TContext = {
   jwt: string;
   userId?: string;
+  orchestratorInstanceId?: string;
 };

boilerplate/ts/core/src/domain/context.ts

@@ -28,6 +28,8 @@ export type TMessageMetadata = {
   createdTimestamp: number;
   messageId: string;
   correlationId?: string;
+  orchestratorInstanceId?: string;
+  name: string;
   context: TContext | Record<string, never>; // type of empty object
 };
 
@@ -39,12 +41,19 @@ export abstract class Message implements IMessage {
       messageId: new UUIDv4().toString(),
       correlationId: metadata?.correlationId,
       context: metadata?.context || {},
+      name: this.constructor.name,
+      orchestratorInstanceId: metadata?.orchestratorInstanceId,
     };
   }
 
   set correlationId(correlationId: string) {
     this.metadata.correlationId = correlationId;
   }
+
+  set orchestratorInstanceId(orchestratorInstanceId: string) {
+    this.metadata.orchestratorInstanceId = orchestratorInstanceId;
+  }
+
   set context(context: TContext) {
     this.metadata.context = context;
   }

boilerplate/ts/core/src/domain/messages/IMessage.ts

@@ -0,0 +1,21 @@
+import { TEventMetadata } from '../events/IEvent';
+import { Message } from './IMessage';
+
+export type SystemEventProps<T> = {
+  boundedContextId: string;
+  name: string; // TODO or commandHandlerName
+  result: T;
+  metadata?: Partial<TEventMetadata>;
+};
+
+export class SystemEvent<T> extends Message {
+  readonly name: string;
+  readonly result: T;
+  declare metadata: TEventMetadata;
+  constructor({ boundedContextId, name, result, metadata }: SystemEventProps<T>) {
+    super(metadata);
+    this.metadata.boundedContextId = boundedContextId;
+    this.name = name;
+    this.result = result;
+  }
+}

boilerplate/ts/core/src/domain/messages/SystemEvent.ts

@@ -2,7 +2,12 @@
 import 'reflect-metadata';
 import { AppError } from './application/AppError';
 import { CRUDReadRepoPort, CRUDWriteRepoPort, UpdateOptions } from './application/ICRUDRepoPort';
-import { CommandHandler, UseCase, QueryHandler } from './application/UseCase';
+import {
+  CommandHandler,
+  UseCase,
+  QueryHandler,
+  OrchestratorHandler as OrchestratorHandlerImport,
+} from './application/UseCase';
 import { AggregateRoot } from './domain/AggregateRoot';
 import { applyRules as applyRulesImport } from './domain/applyRule';
 import {
@@ -57,6 +62,8 @@ import { ReturnUnexpectedError as ReturnUnexpectedErrorImport } from './errors/r
 import { TEventMetadata } from './domain/events/IEvent';
 import { asyncLocalStorage, AsyncLocalStorageStore } from './helpers/asyncLocalStorage';
 import { ConcurrencyOrNotFoundError } from './errors/repository/ConcurrencyOrNotFoundError';
+import { Message as MessageImport } from './domain/messages/IMessage';
+import { SystemEvent as SystemEventImport } from './domain/messages/SystemEvent';
 
 namespace Domain {
   export class Error extends DomainError {}
@@ -86,6 +93,10 @@ namespace Application {
   export type ICommandHandler<IRequest, IResponse> = CommandHandler<IRequest, IResponse>;
   export type IQueryHandler<IRequest, IResponse> = QueryHandler<IRequest, IResponse>;
   export type IHandleDomainEvent = IHandleImport;
+  export abstract class OrchestratorHandler<IRequest, IResponse> extends OrchestratorHandlerImport<
+    IRequest,
+    IResponse
+  > {}
   export interface IHandleIntegrationEvent extends IHandleImport {
     version: string;
   }
@@ -122,6 +133,9 @@ namespace Infra {
     export abstract class IntegrationEvent<T> extends IntegrationEventImport<T> {}
     export type IEventBus = IEventBusImport;
     export type IEvent<T> = IEventImport<T>;
+    export type Message = MessageImport;
+    export class SystemEvent<T> extends SystemEventImport<T> {}
+    export type IHandle = IHandleImport;
   }
   export namespace CommandBus {
     export type IPubSubCommandBus = IPubSubCommandBusImport;

boilerplate/ts/core/src/index.ts

@@ -69,7 +69,7 @@
     "@nodelib/fs.stat" "2.0.5"
     run-parallel "^1.1.9"
 
-"@nodelib/[email protected].5", "@nodelib/fs.stat@^2.0.2":
+"@nodelib/fs.stat@^2.0.2", "@nodelib/[email protected].5":
   version "2.0.5"
   resolved "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz"
   integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==
@@ -107,7 +107,7 @@
   resolved "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz"
   integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==
 
-"@types/node@^18.15.11":
+"@types/node@*", "@types/node@^18.15.11":
   version "18.15.11"
   resolved "https://registry.npmjs.org/@types/node/-/node-18.15.11.tgz"
   integrity sha512-E5Kwq2n4SbMzQOn6wnmBjuK9ouqlURrcZDVfbo9ftDDTFt3nk7ZKK4GMOzoYgnpQJKcxwQw+lGaBvvlMo0qN/Q==
@@ -133,7 +133,7 @@
     semver "^7.3.7"
     tsutils "^3.21.0"
 
-"@typescript-eslint/parser@^5.40.0":
+"@typescript-eslint/parser@^5.0.0", "@typescript-eslint/parser@^5.40.0":
   version "5.51.0"
   resolved "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.51.0.tgz"
   integrity sha512-fEV0R9gGmfpDeRzJXn+fGQKcl0inIeYobmmUWijZh9zA7bxJ8clPhV9up2ZQzATxAiFAECqPQyMDB4o4B81AaA==
@@ -211,16 +211,16 @@ acorn-walk@^8.1.1:
   resolved "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz"
   integrity sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==
 
+"acorn@^6.0.0 || ^7.0.0 || ^8.0.0", acorn@^8.8.0:
+  version "8.8.0"
+  resolved "https://registry.npmjs.org/acorn/-/acorn-8.8.0.tgz"
+  integrity sha512-QOxyigPVrpZ2GXT+PFyZTl6TtOFc5egxHIP9IlQ+RbupQuX4RkT/Bee4/kQuC02Xkzg84JcT7oLYtDIQxp+v7w==
+
 acorn@^8.4.1:
   version "8.8.1"
   resolved "https://registry.npmjs.org/acorn/-/acorn-8.8.1.tgz"
   integrity sha512-7zFpHzhnqYKrkYdUjF1HI1bzd0VygEGX8lFk4k5zVMqHEoES+P+7TKI+EvLO9WVMJ8eekdO0aDEK044xTXwPPA==
 
-acorn@^8.8.0:
-  version "8.8.0"
-  resolved "https://registry.npmjs.org/acorn/-/acorn-8.8.0.tgz"
-  integrity sha512-QOxyigPVrpZ2GXT+PFyZTl6TtOFc5egxHIP9IlQ+RbupQuX4RkT/Bee4/kQuC02Xkzg84JcT7oLYtDIQxp+v7w==
-
 ajv@^6.10.0, ajv@^6.12.4:
   version "6.12.6"
   resolved "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz"
@@ -408,7 +408,7 @@ eslint-visitor-keys@^3.3.0:
   resolved "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.3.0.tgz"
   integrity sha512-mQ+suqKJVyeuwGYHAdjMFqjCyfl8+Ldnxuyp3ldiMBFKkvytrXUZWaiPCEav8qDHKty44bD+qV1IP4T+w+xXRA==
 
-eslint@^8.25.0:
+eslint@*, "eslint@^6.0.0 || ^7.0.0 || ^8.0.0", eslint@^8.25.0, eslint@>=5, eslint@>=7.0.0, eslint@>=7.28.0:
   version "8.33.0"
   resolved "https://registry.npmjs.org/eslint/-/eslint-8.33.0.tgz"
   integrity sha512-WjOpFQgKK8VrCnAtl8We0SUOy/oVZ5NHykyMiagV1M9r8IFpIJX7DduK6n1mpfhlG7T1NLWm2SuD8QB7KFySaA==
@@ -863,7 +863,7 @@ prettier-linter-helpers@^1.0.0:
   dependencies:
     fast-diff "^1.1.2"
 
-prettier@^2.7.1:
+prettier@^2.7.1, prettier@>=2.0.0:
   version "2.8.3"
   resolved "https://registry.npmjs.org/prettier/-/prettier-2.8.3.tgz"
   integrity sha512-tJ/oJ4amDihPoufT5sM0Z1SKEuKay8LfVAMlbbhnnkvt6BUserZylqo2PN+p9KeljLr0OHa2rXHU1T8reeoTrw==
@@ -1015,7 +1015,7 @@ type-fest@^0.20.2:
   resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz"
   integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==
 
-typescript@^4.8.4:
+typescript@^4.8.4, typescript@>=2.7, "typescript@>=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta":
   version "4.9.5"
   resolved "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz"
   integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==