feat(api): [UserRegistration] Take into account email confirmation in user registration process (#318) (#365)

KrystianKjjk · web-flow · commit 6d4dd65699f6 · 2021-09-20T23:13:24.000+02:00
* add completeUserRegistration command and handler

* Add automation module with test

* Change name and add module to appModule
diff --git a/packages/api/src/app.module.ts b/packages/api/src/app.module.ts
@@ -4,6 +4,7 @@ import { ServeStaticModule } from '@nestjs/serve-static';
 import { join } from 'path';
 
 import { SendEmailWhenLearningMaterialsUrlWasGeneratedAutomationModule } from '@/automation/send-email-when-learning-materials-url-was-generated/send-email-when-learning-materials-url-was-generated-automation.module';
+import { WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModule } from '@/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration-automation.module';
 import { WhenUserRegistrationWasStartedThenRequestEmailConfirmationAutomationModule } from '@/automation/when-user-registration-was-started-then-request-email-confirmation/when-user-registration-was-started-then-request-email-confirmation-automation.module';
 import { UserProfileModule } from '@/crud/user-profile/user-profile.module';
 import { PrismaModule } from '@/prisma/prisma.module';
@@ -33,6 +34,7 @@ const readModules = [LearningMaterialsReadModule, CourseProgressReadModule];
 const automationModules = [
   SendEmailWhenLearningMaterialsUrlWasGeneratedAutomationModule,
   WhenUserRegistrationWasStartedThenRequestEmailConfirmationAutomationModule,
+  WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModule,
 ];
 const eventModelingModules = [...writeModules, ...readModules, ...automationModules];
 const crudModules = [UserProfileModule, CoursesModule, AuthModule];
diff --git a/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/email-confirmation-was-approved-event-handler.service.ts b/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/email-confirmation-was-approved-event-handler.service.ts
@@ -0,0 +1,49 @@
+import { Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import { CommandBus } from '@nestjs/cqrs';
+
+import { ApplicationEvent } from '@/module/application-command-events';
+import {
+  CompleteUserRegistrationApplicationCommand,
+  completeUserRegistrationCommand,
+} from '@/module/commands/complete-user-registration';
+import { EmailConfirmationWasApproved } from '@/module/events/email-confirmation-was-approved.domain.event';
+import { ApplicationCommandFactory } from '@/write/shared/application/application-command.factory';
+import { EventsSubscription } from '@/write/shared/application/events-subscription/events-subscription';
+import { EventsSubscriptionsRegistry } from '@/write/shared/application/events-subscription/events-subscriptions-registry';
+
+@Injectable()
+export class EmailConfirmationWasApprovedEventHandler implements OnModuleInit, OnModuleDestroy {
+  private eventsSubscription: EventsSubscription;
+
+  constructor(
+    private readonly commandBus: CommandBus,
+    private readonly commandFactory: ApplicationCommandFactory,
+    private readonly eventsSubscriptionsFactory: EventsSubscriptionsRegistry,
+  ) {}
+
+  async onModuleInit() {
+    this.eventsSubscription = this.eventsSubscriptionsFactory
+      .subscription('WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModule_Automation_v1')
+      .onEvent<EmailConfirmationWasApproved>('EmailConfirmationWasApproved', (event) =>
+        this.onEmailRegistrationWasApproved(event),
+      )
+      .build();
+    await this.eventsSubscription.start();
+  }
+
+  async onEmailRegistrationWasApproved(event: ApplicationEvent<EmailConfirmationWasApproved>) {
+    const command = this.commandFactory.applicationCommand(() => ({
+      class: CompleteUserRegistrationApplicationCommand,
+      ...completeUserRegistrationCommand({
+        userId: event.data.userId,
+      }),
+      metadata: { correlationId: event.metadata.correlationId, causationId: event.id },
+    }));
+
+    await this.commandBus.execute(command);
+  }
+
+  async onModuleDestroy() {
+    await this.eventsSubscription.stop();
+  }
+}
diff --git a/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration-automation.module.ts b/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration-automation.module.ts
@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+
+import { SharedModule } from '@/write/shared/shared.module';
+
+import { EmailConfirmationWasApprovedEventHandler } from './email-confirmation-was-approved-event-handler.service';
+
+@Module({
+  imports: [SharedModule],
+  providers: [EmailConfirmationWasApprovedEventHandler],
+})
+export class WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModule {}
diff --git a/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration.spec.ts b/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration.spec.ts
@@ -0,0 +1,34 @@
+import { AsyncReturnType } from 'type-fest';
+
+import { completeUserRegistrationCommand } from '@/module/commands/complete-user-registration';
+import { emailConfirmationWasApprovedEvent } from '@/module/events/email-confirmation-was-approved.domain.event';
+import { EventStreamName } from '@/write/shared/application/event-stream-name.value-object';
+
+import { WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModuleAutomationTestModule as WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationTestModule } from './when-email-confirmation-was-approved-then-complete-user-registration.test-module';
+
+describe('CompleteUser registration when emailConfirmationWasApproved', () => {
+  let moduleUnderTest: AsyncReturnType<
+    typeof WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationTestModule
+  >;
+
+  beforeEach(async () => {
+    moduleUnderTest = await WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationTestModule();
+  });
+
+  afterEach(async () => {
+    await moduleUnderTest.close();
+  });
+
+  it('CompleteUser registration when emailConfirmationWasApproved', async () => {
+    const userId = 'ca63d023-4cbd-40ca-9f53-f19dbb19b0ab';
+    const confirmationFor = 'user-registration';
+    const event = emailConfirmationWasApprovedEvent({ userId, confirmationFor });
+
+    await moduleUnderTest.eventOccurred(
+      EventStreamName.from('EmailConfirmation', `${userId}_${confirmationFor}`),
+      event,
+    );
+
+    moduleUnderTest.expectCommandExecutedLastly(completeUserRegistrationCommand({ userId }));
+  });
+});
diff --git a/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration.test-module.ts b/packages/api/src/module/automation/when-email-confirmation-was-approved-then-complete-user-registration/when-email-confirmation-was-approved-then-complete-user-registration.test-module.ts
@@ -0,0 +1,12 @@
+import { CommandBus } from '@nestjs/cqrs';
+
+import { commandBusNoFailWithoutHandler, initWriteTestModule } from '@/shared/test-utils';
+
+import { WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModule } from './when-email-confirmation-was-approved-then-complete-user-registration-automation.module';
+
+export async function WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModuleAutomationTestModule() {
+  return initWriteTestModule({
+    modules: [WhenEmailConfirmationWasApprovedThenCompleteUserRegistrationAutomationModule],
+    configureModule: (app) => app.overrideProvider(CommandBus).useValue(commandBusNoFailWithoutHandler),
+  });
+}
diff --git a/packages/api/src/module/automation/when-user-registration-was-started-then-request-email-confirmation/user-registration-was-started.event-handler.service.ts b/packages/api/src/module/automation/when-user-registration-was-started-then-request-email-confirmation/user-registration-was-started.event-handler.service.ts
diff --git a/packages/api/src/module/automation/when-user-registration-was-started-then-request-email-confirmation/when-user-registration-was-started-then-request-email-confirmation-automation.module.ts b/packages/api/src/module/automation/when-user-registration-was-started-then-request-email-confirmation/when-user-registration-was-started-then-request-email-confirmation-automation.module.ts
@@ -2,7 +2,7 @@ import { Module } from '@nestjs/common';
 
 import { SharedModule } from '@/write/shared/shared.module';
 
-import { UserRegistrationWasStartedEventHandler } from './user-registration-was-started.event-handler';
+import { UserRegistrationWasStartedEventHandler } from './user-registration-was-started.event-handler.service';
 
 @Module({
   imports: [SharedModule],
diff --git a/packages/api/src/module/shared/commands/complete-user-registration.ts b/packages/api/src/module/shared/commands/complete-user-registration.ts
@@ -0,0 +1,17 @@
+import { UserId } from '@/shared/domain.types';
+
+import { AbstractApplicationCommand } from '../application-command-events';
+
+export type CompleteUserRegistration = {
+  type: 'CompleteUserRegistration';
+  data: {
+    userId: UserId;
+  };
+};
+
+export const completeUserRegistrationCommand = (data: CompleteUserRegistration['data']): CompleteUserRegistration => ({
+  type: 'CompleteUserRegistration',
+  data,
+});
+
+export class CompleteUserRegistrationApplicationCommand extends AbstractApplicationCommand<CompleteUserRegistration> {}
diff --git a/packages/api/src/module/shared/events/user-registration-was-completed.domain-event.ts b/packages/api/src/module/shared/events/user-registration-was-completed.domain-event.ts
@@ -7,3 +7,10 @@ export type UserRegistrationWasCompleted = {
     hashedPassword: string;
   };
 };
+
+export const userRegistrationWasCompletedEvent = (
+  data: UserRegistrationWasCompleted['data'],
+): UserRegistrationWasCompleted => ({
+  type: 'UserRegistrationWasCompleted',
+  data,
+});
diff --git a/packages/api/src/module/shared/events/user-registration-was-started.domain-event.ts b/packages/api/src/module/shared/events/user-registration-was-started.domain-event.ts
@@ -7,3 +7,10 @@ export type UserRegistrationWasStarted = {
     hashedPassword: string;
   };
 };
+
+export const userRegistrationWasStartedEvent = (
+  data: UserRegistrationWasStarted['data'],
+): UserRegistrationWasStarted => ({
+  type: 'UserRegistrationWasStarted',
+  data,
+});
diff --git a/packages/api/src/module/write/user-registration/application/complete-user-registration.command-handler.ts b/packages/api/src/module/write/user-registration/application/complete-user-registration.command-handler.ts
@@ -0,0 +1,31 @@
+import { Inject } from '@nestjs/common';
+import { CommandHandler, ICommandHandler } from '@nestjs/cqrs';
+
+import { CompleteUserRegistrationApplicationCommand } from '@/module/commands/complete-user-registration';
+import { APPLICATION_SERVICE, ApplicationService } from '@/write/shared/application/application-service';
+import { EventStreamName } from '@/write/shared/application/event-stream-name.value-object';
+
+import { completeUserRegistration } from '../domain/CompleteUserRegistration';
+import { UserRegistrationDomainEvent } from '../domain/events';
+
+@CommandHandler(CompleteUserRegistrationApplicationCommand)
+export class CompleteUserRegistrationCommandHandler
+  implements ICommandHandler<CompleteUserRegistrationApplicationCommand>
+{
+  constructor(
+    @Inject(APPLICATION_SERVICE)
+    private readonly applicationService: ApplicationService,
+  ) {}
+
+  async execute(command: CompleteUserRegistrationApplicationCommand) {
+    const {
+      data: { userId },
+    } = command;
+
+    await this.applicationService.execute<UserRegistrationDomainEvent>(
+      EventStreamName.from('UserRegistration', userId),
+      { correlationId: command.metadata.correlationId, causationId: command.metadata.causationId },
+      completeUserRegistration(command),
+    );
+  }
+}
diff --git a/packages/api/src/module/write/user-registration/domain/CompleteUserRegistration.spec.ts b/packages/api/src/module/write/user-registration/domain/CompleteUserRegistration.spec.ts
@@ -0,0 +1,55 @@
+import { completeUserRegistrationCommand } from '@/module/commands/complete-user-registration';
+import { userRegistrationWasCompletedEvent } from '@/module/events/user-registration-was-completed.domain-event';
+import { userRegistrationWasStartedEvent } from '@/module/events/user-registration-was-started.domain-event';
+
+import { completeUserRegistration } from './CompleteUserRegistration';
+
+describe('Complete user registration', () => {
+  it('create event userRegistrationWasCompleted when completeUserRegistration is invoked and user registration was started', () => {
+    // given
+    const userId = 'iu3dg23b1;';
+    const fullName = 'test name';
+    const emailAddress = 'teest@test.pl';
+    const hashedPassword = 'testedPassword';
+    const command = completeUserRegistrationCommand({ userId });
+    const pastEvents = [userRegistrationWasStartedEvent({ userId, fullName, emailAddress, hashedPassword })];
+
+    // when
+    const result = completeUserRegistration(command)(pastEvents);
+    // then
+    const event = userRegistrationWasCompletedEvent({ userId, fullName, emailAddress, hashedPassword });
+
+    expect(result).toEqual([event]);
+  });
+
+  it('Throws exception while userRegistrationWasCompleted is invoked, but user registration was not started', () => {
+    // given
+    const userId = 'iu3dg23b1;';
+    const command = completeUserRegistrationCommand({ userId });
+
+    // when - then
+
+    expect(() => completeUserRegistration(command)([])).toThrow(
+      'Impossible to complete registration while it is not started',
+    );
+  });
+
+  it('Throws exception while userRegistrationWasCompleted is invoked, but user registration was already completed', () => {
+    // given
+    const userId = 'iu3dg23b1;';
+    const fullName = 'test name';
+    const emailAddress = 'teest@test.pl';
+    const hashedPassword = 'testedPassword';
+    const command = completeUserRegistrationCommand({ userId });
+
+    const pastEvents = [
+      userRegistrationWasStartedEvent({ userId, fullName, emailAddress, hashedPassword }),
+      userRegistrationWasCompletedEvent({ userId, fullName, emailAddress, hashedPassword }),
+    ];
+    // when - then
+
+    expect(() => completeUserRegistration(command)(pastEvents)).toThrow(
+      `Registration for user ${fullName} was already completed`,
+    );
+  });
+});
diff --git a/packages/api/src/module/write/user-registration/domain/CompleteUserRegistration.ts b/packages/api/src/module/write/user-registration/domain/CompleteUserRegistration.ts
@@ -0,0 +1,25 @@
+import { CompleteUserRegistration } from '@/commands/complete-user-registration';
+import { userRegistrationWasCompletedEvent } from '@/events/user-registration-was-completed.domain-event';
+import { UserRegistrationDomainEvent } from '@/write/user-registration/domain/events';
+
+export const completeUserRegistration =
+  (command: CompleteUserRegistration) =>
+  (pastEvents: UserRegistrationDomainEvent[]): UserRegistrationDomainEvent[] => {
+    const { data } = command;
+    const lastUserRegistrationEvent = pastEvents[pastEvents.length - 1];
+
+    if (!lastUserRegistrationEvent) throw new Error('Impossible to complete registration while it is not started');
+
+    if (lastUserRegistrationEvent.type === 'UserRegistrationWasCompleted')
+      throw new Error(`Registration for user ${lastUserRegistrationEvent.data.fullName} was already completed`);
+
+    const { fullName, emailAddress, hashedPassword } = lastUserRegistrationEvent.data;
+    const userRegistrationWasCompleted = userRegistrationWasCompletedEvent({
+      userId: data.userId,
+      fullName,
+      emailAddress,
+      hashedPassword,
+    });
+
+    return [userRegistrationWasCompleted];
+  };
diff --git a/packages/api/src/module/write/user-registration/domain/registerUser.ts b/packages/api/src/module/write/user-registration/domain/registerUser.ts
@@ -1,5 +1,4 @@
 import { RegisterUser } from '@/commands/register-user';
-import { UserRegistrationWasCompleted } from '@/events/user-registration-was-completed.domain-event';
 import { UserRegistrationWasStarted } from '@/events/user-registration-was-started.domain-event';
 import { UserRegistrationDomainEvent } from '@/write/user-registration/domain/events';
 
@@ -18,15 +17,6 @@ export function registerUser(
       hashedPassword,
     },
   };
-  const userRegistrationWasCompleted: UserRegistrationWasCompleted = {
-    type: 'UserRegistrationWasCompleted',
-    data: {
-      userId: data.userId,
-      fullName: data.fullName,
-      emailAddress: data.emailAddress,
-      hashedPassword,
-    },
-  };
 
-  return [userRegistrationWasStarted, userRegistrationWasCompleted];
+  return [userRegistrationWasStarted];
 }
diff --git a/packages/api/src/module/write/user-registration/user-registration.spec.ts b/packages/api/src/module/write/user-registration/user-registration.spec.ts
@@ -3,6 +3,9 @@ import { AsyncReturnType } from 'type-fest';
 import { registerError } from '@coderscamp/shared/models/auth/register';
 
 import { RegisterUserApplicationCommand } from '@/commands/register-user';
+import { CompleteUserRegistrationApplicationCommand } from '@/module/commands/complete-user-registration';
+import { userRegistrationWasCompletedEvent } from '@/module/events/user-registration-was-completed.domain-event';
+import { userRegistrationWasStartedEvent } from '@/module/events/user-registration-was-started.domain-event';
 import { initWriteTestModule } from '@/shared/test-utils';
 import { EventStreamName } from '@/write/shared/application/event-stream-name.value-object';
 import { PASSWORD_ENCODER, PasswordEncoder } from '@/write/shared/application/password-encoder';
@@ -34,7 +37,7 @@ describe('User Registration', () => {
     await moduleUnderTest.close();
   });
 
-  it('when register user, then registration should started and completed', async () => {
+  it('when register user, then registration should started', async () => {
     // Given
     const userId = moduleUnderTest.randomUserId();
     const fullName = 'Jan Nowak';
@@ -54,7 +57,7 @@ describe('User Registration', () => {
     }));
 
     // Then
-    await moduleUnderTest.expectEventsPublishedLastly<UserRegistrationDomainEvent>([
+    moduleUnderTest.expectEventsPublishedLastly<UserRegistrationDomainEvent>([
       {
         type: 'UserRegistrationWasStarted',
         data: {
@@ -65,16 +68,6 @@ describe('User Registration', () => {
         },
         streamName: EventStreamName.from('UserRegistration', userId),
       },
-      {
-        type: 'UserRegistrationWasCompleted',
-        data: {
-          userId,
-          fullName,
-          emailAddress,
-          hashedPassword: sampleHashedPassword,
-        },
-        streamName: EventStreamName.from('UserRegistration', userId),
-      },
     ]);
   });
 
@@ -112,4 +105,39 @@ describe('User Registration', () => {
 
     await expect(command).rejects.toEqual(new Error(registerError.USER_WAS_ALREADY_REGISTERED));
   });
+
+  it('should create userRegistrationWasCompleted event when completeUserRegistration command will be invoked after user registration was started', async () => {
+    // given
+    const userId = moduleUnderTest.randomUserId();
+    const fullName = 'test name';
+    const emailAddress = 'test@test.pl';
+    const hashedPassword = 'testedPassword';
+
+    await moduleUnderTest.eventOccurred(
+      EventStreamName.from('UserRegistration', userId),
+      userRegistrationWasStartedEvent({ userId, fullName, emailAddress, hashedPassword }),
+    );
+
+    // when
+    await moduleUnderTest.executeCommand(() => ({
+      class: CompleteUserRegistrationApplicationCommand,
+      type: 'CompleteUserRegistration',
+      data: {
+        userId,
+      },
+    }));
+
+    // Then
+    moduleUnderTest.expectEventsPublishedLastly<UserRegistrationDomainEvent>([
+      {
+        ...userRegistrationWasCompletedEvent({
+          userId,
+          fullName,
+          emailAddress,
+          hashedPassword,
+        }),
+        streamName: EventStreamName.from('UserRegistration', userId),
+      },
+    ]);
+  });
 });
diff --git a/packages/api/src/module/write/user-registration/user-registration.write-module.ts b/packages/api/src/module/write/user-registration/user-registration.write-module.ts
