Merge pull request #123 from dolittle/projection-alias

woksin · web-flow · commit 1601c5a999a4 · 2022-02-14T10:49:53.000+01:00
Projection alias
diff --git a/Source/artifacts/package.json b/Source/artifacts/package.json
@@ -47,9 +47,9 @@
         "@dolittle/concepts": "6.0.0",
         "@dolittle/rudiments": "6.0.0",
         "@dolittle/types": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0"
+        "@dolittle/runtime.contracts": "6.8.0"
     },
     "devDependencies": {
         "@types/is-natural-number": "^4.0.0"
     }
-}
+}
diff --git a/Source/embeddings/package.json b/Source/embeddings/package.json
@@ -45,9 +45,9 @@
     },
     "dependencies": {
         "@dolittle/concepts": "6.0.0",
-        "@dolittle/contracts": "6.7.0",
+        "@dolittle/contracts": "6.8.0",
         "@dolittle/rudiments": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0",
+        "@dolittle/runtime.contracts": "6.8.0",
         "@dolittle/sdk.artifacts": "23.1.0",
         "@dolittle/sdk.common": "23.1.0",
         "@dolittle/sdk.dependencyinversion": "23.1.0",
@@ -63,4 +63,4 @@
         "@types/luxon": "1.24.1"
     },
     "devDependencies": {}
-}
+}
diff --git a/Source/eventHorizon/package.json b/Source/eventHorizon/package.json
@@ -46,7 +46,7 @@
     "dependencies": {
         "@dolittle/concepts": "6.0.0",
         "@dolittle/rudiments": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0",
+        "@dolittle/runtime.contracts": "6.8.0",
         "@dolittle/sdk.events": "23.1.0",
         "@dolittle/sdk.execution": "23.1.0",
         "@dolittle/sdk.protobuf": "23.1.0",
@@ -58,4 +58,4 @@
         "@types/luxon": "1.24.1"
     },
     "devDependencies": {}
-}
+}
diff --git a/Source/events.filtering/package.json b/Source/events.filtering/package.json
@@ -45,9 +45,9 @@
     },
     "dependencies": {
         "@dolittle/concepts": "6.0.0",
-        "@dolittle/contracts": "6.7.0",
+        "@dolittle/contracts": "6.8.0",
         "@dolittle/rudiments": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0",
+        "@dolittle/runtime.contracts": "6.8.0",
         "@dolittle/sdk.common": "23.1.0",
         "@dolittle/sdk.dependencyinversion": "23.1.0",
         "@dolittle/sdk.events": "23.1.0",
@@ -61,4 +61,4 @@
         "winston": "3.3.2",
         "@types/luxon": "1.24.1"
     }
-}
+}
diff --git a/Source/events.handling/Builders/EventHandlerOptions.ts b/Source/events.handling/Builders/EventHandlerOptions.ts
@@ -10,4 +10,8 @@ import { EventHandlerAliasLike } from '../EventHandlerAlias';
 /**
  * Defines the options that can be defined in a {@link eventHandler} decorator.
  */
-export type EventHandlerOptions = { inScope?: ScopeId | Guid | string, partitioned?: boolean, alias?: EventHandlerAliasLike };
+export type EventHandlerOptions = {
+    inScope?: ScopeId | Guid | string,
+    partitioned?: boolean,
+    alias?: EventHandlerAliasLike,
+};
diff --git a/Source/events.handling/Builders/IEventHandlerBuilder.ts b/Source/events.handling/Builders/IEventHandlerBuilder.ts
@@ -32,7 +32,7 @@ export abstract class IEventHandlerBuilder {
     abstract inScope(scopeId: ScopeId | Guid | string): IEventHandlerBuilder;
 
     /**
-     * Defines and alias for the event handler.
+     * Defines an alias for the event handler.
      * @param {EventHandlerAliasLike} alias - The event handler alias.
      * @returns {IEventHandlerBuilder} The builder for continuation.
      */
diff --git a/Source/events.handling/EventHandler.ts b/Source/events.handling/EventHandler.ts
@@ -16,6 +16,7 @@ import { MissingEventHandlerForType } from './MissingEventHandlerForType';
  * Represents an implementation of {@link IEventHandler}.
  */
 export class EventHandler extends IEventHandler {
+    /** @inheritdoc */
     readonly hasAlias: boolean;
 
     /**
diff --git a/Source/events.handling/package.json b/Source/events.handling/package.json
@@ -45,9 +45,9 @@
     },
     "dependencies": {
         "@dolittle/concepts": "6.0.0",
-        "@dolittle/contracts": "6.7.0",
+        "@dolittle/contracts": "6.8.0",
         "@dolittle/rudiments": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0",
+        "@dolittle/runtime.contracts": "6.8.0",
         "@dolittle/sdk.artifacts": "23.1.0",
         "@dolittle/sdk.common": "23.1.0",
         "@dolittle/sdk.dependencyinversion": "23.1.0",
@@ -65,4 +65,4 @@
     "devDependencies": {
         "@types/luxon": "1.24.1"
     }
-}
+}
diff --git a/Source/events.processing/package.json b/Source/events.processing/package.json
@@ -45,9 +45,9 @@
     },
     "dependencies": {
         "@dolittle/concepts": "6.0.0",
-        "@dolittle/contracts": "6.7.0",
+        "@dolittle/contracts": "6.8.0",
         "@dolittle/rudiments": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0",
+        "@dolittle/runtime.contracts": "6.8.0",
         "@dolittle/sdk.common": "23.1.0",
         "@dolittle/sdk.dependencyinversion": "23.1.0",
         "@dolittle/sdk.execution": "23.1.0",
@@ -57,4 +57,4 @@
         "rxjs": "6.6.0",
         "winston": "3.3.2"
     }
-}
+}
diff --git a/Source/events/package.json b/Source/events/package.json
@@ -45,9 +45,9 @@
     },
     "dependencies": {
         "@dolittle/concepts": "6.0.0",
-        "@dolittle/contracts": "6.7.0",
+        "@dolittle/contracts": "6.8.0",
         "@dolittle/rudiments": "6.0.0",
-        "@dolittle/runtime.contracts": "6.7.0",
+        "@dolittle/runtime.contracts": "6.8.0",
         "@dolittle/sdk.artifacts": "23.1.0",
         "@dolittle/sdk.execution": "23.1.0",
         "@dolittle/sdk.protobuf": "23.1.0",
@@ -61,4 +61,4 @@
     "devDependencies": {
         "@types/luxon": "1.24.1"
     }
-}
+}
diff --git a/Source/projections/Builders/IProjectionBuilderForReadModel.ts b/Source/projections/Builders/IProjectionBuilderForReadModel.ts
@@ -10,6 +10,7 @@ import { EventType, EventTypeIdLike, ScopeId } from '@dolittle/sdk.events';
 import { ProjectionCallback } from '../ProjectionCallback';
 import { CopyToMongoDBCallback } from './Copies/CopyToMongoDBCallback';
 import { KeySelectorBuilderCallback } from './KeySelectorBuilderCallback';
+import { ProjectionAliasLike } from '../ProjectionAlias';
 
 /**
  * Defines a builder for building a projection for a read model from method callbacks.
@@ -33,7 +34,7 @@ export abstract class IProjectionBuilderForReadModel<T> {
      * @param {ProjectionCallback<T>} callback - Callback to call for each event.
      * @returns {IProjectionBuilderForReadModel<T>} The builder for continuation.
      */
-     abstract on(eventType: EventType, keySelectorCallback: KeySelectorBuilderCallback, callback: ProjectionCallback<T>): IProjectionBuilderForReadModel<T>;
+    abstract on(eventType: EventType, keySelectorCallback: KeySelectorBuilderCallback, callback: ProjectionCallback<T>): IProjectionBuilderForReadModel<T>;
 
     /**
      * Add an on method for handling the event.
@@ -42,7 +43,7 @@ export abstract class IProjectionBuilderForReadModel<T> {
      * @param {ProjectionCallback<T>} callback - Callback to call for each event.
      * @returns {IProjectionBuilderForReadModel<T>} The builder for continuation.
      */
-     abstract on(eventTypeId: EventTypeIdLike, keySelectorCallback: KeySelectorBuilderCallback, callback: ProjectionCallback<T>): IProjectionBuilderForReadModel<T>;
+    abstract on(eventTypeId: EventTypeIdLike, keySelectorCallback: KeySelectorBuilderCallback, callback: ProjectionCallback<T>): IProjectionBuilderForReadModel<T>;
 
     /**
      * Add an on method for handling the event.
@@ -52,7 +53,7 @@ export abstract class IProjectionBuilderForReadModel<T> {
      * @param {ProjectionCallback<T>} method - Callback to call for each event.
      * @returns {IProjectionBuilderForReadModel<T>} The builder for continuation.
      */
-     abstract on(eventTypeId: EventTypeIdLike, generation: Generation | number, keySelectorCallback: KeySelectorBuilderCallback, callback: ProjectionCallback<T>): IProjectionBuilderForReadModel<T>;
+    abstract on(eventTypeId: EventTypeIdLike, generation: Generation | number, keySelectorCallback: KeySelectorBuilderCallback, callback: ProjectionCallback<T>): IProjectionBuilderForReadModel<T>;
 
     /**
      * Defines the projection to operate in a specific {@link ScopeId}.
@@ -61,6 +62,13 @@ export abstract class IProjectionBuilderForReadModel<T> {
      */
     abstract inScope(scopeId: ScopeId | Guid | string): IProjectionBuilderForReadModel<T>;
 
+    /**
+     * Defines an alias for the projection.
+     * @param {ProjectionAliasLike} alias - The projection alias.
+     * @returns {IProjectionBuilderForReadModel<T>} The builder for continuation.
+     */
+    abstract withAlias(alias: ProjectionAliasLike): IProjectionBuilderForReadModel<T>;
+
     /**
      * Configures the projection to write copies of read models to a MongoDB collection.
      * @param {CopyToMongoDBCallback} [callback] - An optional callback to use to configure the read model copies.
diff --git a/Source/projections/Builders/ProjectionBuilderForReadModel.ts b/Source/projections/Builders/ProjectionBuilderForReadModel.ts
@@ -24,13 +24,15 @@ import { KeySelectorBuilderCallback } from './KeySelectorBuilderCallback';
 import { OnMethodSpecification } from './OnMethodSpecification';
 import { TypeOrEventType } from './TypeOrEventType';
 import { ProjectionBuilder } from './ProjectionBuilder';
+import { ProjectionAlias, ProjectionAliasLike } from '../ProjectionAlias';
 
 /**
  * Represents an implementation of {@link IProjectionBuilderForReadModel}.
  * @template T The type of the projection read model.
  */
 export class ProjectionBuilderForReadModel<T> extends IProjectionBuilderForReadModel<T> {
     private _onMethods: OnMethodSpecification<T>[] = [];
+    private _alias?: ProjectionAlias;
     private _copyToMongoDBCallback?: CopyToMongoDBCallback<T>;
 
     /**
@@ -52,6 +54,7 @@ export class ProjectionBuilderForReadModel<T> extends IProjectionBuilderForReadM
         this._modelBuilder.bindIdentifierToProcessorBuilder(this._modelId, this._parentBuilder);
         if (_readModelTypeOrInstance instanceof Function) {
             this._modelBuilder.bindIdentifierToType(this._modelId, _readModelTypeOrInstance);
+            this._alias = ProjectionAlias.from(_readModelTypeOrInstance.name);
         }
     }
 
@@ -86,6 +89,12 @@ export class ProjectionBuilderForReadModel<T> extends IProjectionBuilderForReadM
         return this;
     }
 
+    /** @inheritdoc */
+    withAlias(alias: ProjectionAliasLike): IProjectionBuilderForReadModel<T> {
+        this._alias = ProjectionAlias.from(alias);
+        return this;
+    }
+
     /** @inheritdoc */
     copyToMongoDB(callback?: CopyToMongoDBCallback<T>): IProjectionBuilderForReadModel<T> {
         this._copyToMongoDBCallback = callback ?? (() => {});
@@ -117,7 +126,7 @@ export class ProjectionBuilderForReadModel<T> extends IProjectionBuilderForReadM
             return undefined;
         }
 
-        return new Projection<T>(this._projectionId, this._readModelTypeOrInstance, this._scopeId, events, copies);
+        return new Projection<T>(this._projectionId, this._readModelTypeOrInstance, this._scopeId, events, copies, this._alias);
     }
 
     private tryAddOnMethods(
diff --git a/Source/projections/Builders/ProjectionClassBuilder.ts b/Source/projections/Builders/ProjectionClassBuilder.ts
@@ -66,7 +66,7 @@ export class ProjectionClassBuilder<T> implements IEquatable {
             return undefined;
         }
 
-        return new Projection<T>(this.type.projectionId, this.type.type, this.type.scopeId, events, copies);
+        return new Projection<T>(this.type.projectionId, this.type.type, this.type.scopeId, events, copies, this.type.alias);
     }
 
     private tryAddAllOnMethods(events: EventTypeMap<[ProjectionCallback<T>, KeySelector]>, type: Constructor<any>, eventTypes: IEventTypes): boolean {
diff --git a/Source/projections/Builders/ProjectionDecoratedType.ts b/Source/projections/Builders/ProjectionDecoratedType.ts
@@ -6,6 +6,7 @@ import { Constructor } from '@dolittle/types';
 import { ScopeId } from '@dolittle/sdk.events';
 
 import { ProjectionId } from '../ProjectionId';
+import { ProjectionAlias } from '../ProjectionAlias';
 
 /**
  * Represents a projection created from the decorator.
@@ -15,11 +16,13 @@ export class ProjectionDecoratedType {
      * Initialises a new instance of the {@link ProjectionDecoratedType} class.
      * @param {ProjectionId} projectionId - The identifier of the projection.
      * @param {ScopeId} scopeId - The scope of the projection.
+     * @param {ProjectionAlias} alias - The alias of the projection.
      * @param {Constructor<any>} type - The decorated type.
      */
     constructor(
         readonly projectionId: ProjectionId,
         readonly scopeId: ScopeId,
+        readonly alias: ProjectionAlias,
         readonly type: Constructor<any>) {
     }
 }
diff --git a/Source/projections/Builders/ProjectionOptions.ts b/Source/projections/Builders/ProjectionOptions.ts
@@ -4,8 +4,12 @@
 import { Guid } from '@dolittle/rudiments';
 import { ScopeId } from '@dolittle/sdk.events';
 import { projection } from './projectionDecorator';
+import { ProjectionAliasLike } from '../ProjectionAlias';
 
 /**
  * Defines the options that can be defined in a {@link projection} decorator.
  */
-export type ProjectionOptions = { inScope?: ScopeId | Guid | string };
+export type ProjectionOptions = {
+    inScope?: ScopeId | Guid | string,
+    alias?: ProjectionAliasLike,
+};
diff --git a/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/with_conversions.ts b/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/with_conversions.ts
@@ -16,6 +16,7 @@ import { PropertyConversion } from '../../../../Copies/MongoDB/PropertyConversio
 import { on } from '../../../onDecorator';
 import { ProjectionDecoratedType } from '../../../ProjectionDecoratedType';
 import { ProjectionClassBuilder } from '../../../ProjectionClassBuilder';
+import { ProjectionAlias } from '../../../../ProjectionAlias';
 
 @copyProjectionToMongoDB()
 class Projection {
@@ -37,6 +38,7 @@ describeThis(__filename, () => {
     const decoratedType = new ProjectionDecoratedType(
         ProjectionId.from('53cad890-5b8a-4146-acce-29dc2dc8c43e'),
         ScopeId.from('28f6c232-cc11-493b-b032-398a5e651617'),
+        ProjectionAlias.from('alias'),
         Projection);
 
     const builder = new ProjectionClassBuilder(decoratedType);
diff --git a/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/with_copy_to_mongodb.ts b/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/with_copy_to_mongodb.ts
@@ -12,6 +12,7 @@ import { copyProjectionToMongoDB } from '../../../Copies/copyProjectionToMongoDB
 import { on } from '../../../onDecorator';
 import { ProjectionDecoratedType } from '../../../ProjectionDecoratedType';
 import { ProjectionClassBuilder } from '../../../ProjectionClassBuilder';
+import { ProjectionAlias } from '../../../../ProjectionAlias';
 
 @copyProjectionToMongoDB()
 class Projection {
@@ -23,6 +24,7 @@ describeThis(__filename, () => {
     const decoratedType = new ProjectionDecoratedType(
         ProjectionId.from('53cad890-5b8a-4146-acce-29dc2dc8c43e'),
         ScopeId.from('28f6c232-cc11-493b-b032-398a5e651617'),
+        ProjectionAlias.from('alias'),
         Projection);
 
     const builder = new ProjectionClassBuilder(decoratedType);
diff --git a/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/with_explicit_collection_name.ts b/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/with_explicit_collection_name.ts
@@ -12,6 +12,7 @@ import { copyProjectionToMongoDB } from '../../../Copies/copyProjectionToMongoDB
 import { on } from '../../../onDecorator';
 import { ProjectionDecoratedType } from '../../../ProjectionDecoratedType';
 import { ProjectionClassBuilder } from '../../../ProjectionClassBuilder';
+import { ProjectionAlias } from '../../../../ProjectionAlias';
 
 @copyProjectionToMongoDB('collection-name')
 class Projection {
@@ -23,6 +24,7 @@ describeThis(__filename, () => {
     const decoratedType = new ProjectionDecoratedType(
         ProjectionId.from('53cad890-5b8a-4146-acce-29dc2dc8c43e'),
         ScopeId.from('28f6c232-cc11-493b-b032-398a5e651617'),
+        ProjectionAlias.from('alias'),
         Projection);
 
     const builder = new ProjectionClassBuilder(decoratedType);
diff --git a/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/without_copy_to_mongodb.ts b/Source/projections/Builders/for_ProjectionClassBuilder/when_building/with_copies_to_mongodb/without_copy_to_mongodb.ts
@@ -11,6 +11,7 @@ import { ProjectionId } from '../../../../ProjectionId';
 import { on } from '../../../onDecorator';
 import { ProjectionDecoratedType } from '../../../ProjectionDecoratedType';
 import { ProjectionClassBuilder } from '../../../ProjectionClassBuilder';
+import { ProjectionAlias } from '../../../../ProjectionAlias';
 
 class Projection {
     @on('32e2aaca-2374-42f0-bcb5-7fb19501e3da', _ => _.keyFromEventSource())
@@ -21,6 +22,7 @@ describeThis(__filename, () => {
     const decoratedType = new ProjectionDecoratedType(
         ProjectionId.from('53cad890-5b8a-4146-acce-29dc2dc8c43e'),
         ScopeId.from('28f6c232-cc11-493b-b032-398a5e651617'),
+        ProjectionAlias.from('alias'),
         Projection);
 
     const builder = new ProjectionClassBuilder(decoratedType);
diff --git a/Source/projections/Builders/projectionDecorator.ts b/Source/projections/Builders/projectionDecorator.ts
@@ -10,6 +10,7 @@ import { ScopeId } from '@dolittle/sdk.events';
 import { ProjectionId } from '../ProjectionId';
 import { ProjectionDecoratedType } from './ProjectionDecoratedType';
 import { ProjectionOptions } from './ProjectionOptions';
+import { ProjectionAlias } from '../ProjectionAlias';
 
 const [decorator, getMetadata] = Decorators.createMetadataDecorator<ProjectionDecoratedType>('projection', 'projection', Decorators.DecoratorTarget.Class);
 
@@ -24,6 +25,7 @@ export function projection(projectionId: ProjectionId | Guid | string, options:
         return new ProjectionDecoratedType(
             ProjectionId.from(projectionId),
             options.inScope ? ScopeId.from(options.inScope) : ScopeId.default,
+            ProjectionAlias.from(options.alias ?? type.name),
             type);
     });
 }
diff --git a/Source/projections/IProjection.ts b/Source/projections/IProjection.ts
@@ -9,6 +9,7 @@ import { ProjectionCopies } from './Copies/ProjectionCopies';
 import { DeleteReadModelInstance } from './DeleteReadModelInstance';
 import { EventSelector } from './EventSelector';
 import { ProjectionContext } from './ProjectionContext';
+import { ProjectionAlias } from './ProjectionAlias';
 import { ProjectionId } from './ProjectionId';
 
 /**
@@ -46,6 +47,16 @@ export abstract class IProjection<T> {
      */
     abstract readonly copies: ProjectionCopies;
 
+    /**
+     * Gets the alias for the projection.
+     */
+    abstract readonly alias: ProjectionAlias | undefined;
+
+    /**
+     * Gets a value indicating whether this projection has an alias or not.
+     */
+    abstract readonly hasAlias: boolean;
+
     /**
      * Handle an event and update a readmodel.
      * @param {T} readModel - ReadModel to update.
diff --git a/Source/projections/Internal/ProjectionProcessor.ts b/Source/projections/Internal/ProjectionProcessor.ts
diff --git a/Source/projections/Projection.ts b/Source/projections/Projection.ts
diff --git a/Source/projections/ProjectionAlias.ts b/Source/projections/ProjectionAlias.ts
diff --git a/Source/projections/_exports.ts b/Source/projections/_exports.ts
diff --git a/Source/projections/package.json b/Source/projections/package.json
diff --git a/Source/protobuf/package.json b/Source/protobuf/package.json
diff --git a/Source/resources/package.json b/Source/resources/package.json
diff --git a/Source/sdk/package.json b/Source/sdk/package.json
diff --git a/Source/services/package.json b/Source/services/package.json
diff --git a/Source/tenancy/package.json b/Source/tenancy/package.json
