Feat/user onboard survey form (#729)

Added User Onboard Survey Form.

Author: chavda-bhavik

apps/api/src/app/auth/auth.controller.ts

@@ -13,17 +13,19 @@ import {
 } from '@nestjs/common';
 
 import { IJwtPayload } from '@impler/shared';
+import { AuthService } from './services/auth.service';
 import { IStrategyResponse } from '@shared/types/auth.types';
 import { CONSTANTS, COOKIE_CONFIG } from '@shared/constants';
 import { UserSession } from '@shared/framework/user.decorator';
 import { ApiException } from '@shared/exceptions/api.exception';
 import { StrategyUser } from './decorators/strategy-user.decorator';
-import { RegisterUserDto, LoginUserDto, RequestForgotPasswordDto, ResetPasswordDto } from './dtos';
+import { RegisterUserDto, LoginUserDto, RequestForgotPasswordDto, ResetPasswordDto, OnboardUserDto } from './dtos';
 import {
   RegisterUser,
   RegisterUserCommand,
   LoginUser,
   ResetPassword,
+  OnboardUser,
   LoginUserCommand,
   ResetPasswordCommand,
   RequestForgotPassword,
@@ -36,8 +38,10 @@ import {
 @UseInterceptors(ClassSerializerInterceptor)
 export class AuthController {
   constructor(
-    private registerUser: RegisterUser,
     private loginUser: LoginUser,
+    private onboardUser: OnboardUser,
+    private authService: AuthService,
+    private registerUser: RegisterUser,
     private resetPassword: ResetPassword,
     private requestForgotPassword: RequestForgotPassword
   ) {}
@@ -112,6 +116,38 @@ export class AuthController {
     response.send(registeredUser);
   }
 
+  @Post('/onboard')
+  async onboardUserRoute(
+    @Body() body: OnboardUserDto,
+    @UserSession() user: IJwtPayload,
+    @Res({ passthrough: true }) res: Response
+  ) {
+    const projectWithEnvironment = await this.onboardUser.execute({
+      _userId: user._id,
+      projectName: body.projectName,
+      role: body.role,
+      companySize: body.companySize,
+      source: body.source,
+    });
+    const token = this.authService.getSignedToken(
+      {
+        _id: user._id,
+        firstName: user.firstName,
+        lastName: user.lastName,
+        email: user.email,
+        profilePicture: user.profilePicture,
+        accessToken: projectWithEnvironment.environment.apiKeys[0].key,
+      },
+      projectWithEnvironment.project._id
+    );
+    res.cookie(CONSTANTS.AUTH_COOKIE_NAME, token, {
+      ...COOKIE_CONFIG,
+      domain: process.env.COOKIE_DOMAIN,
+    });
+
+    return projectWithEnvironment;
+  }
+
   @Post('/login')
   async login(@Body() body: LoginUserDto, @Res() response: Response) {
     const loginUser = await this.loginUser.execute(

apps/api/src/app/auth/auth.module.ts

@@ -1,16 +1,17 @@
-import { Global, MiddlewareConsumer, Module, NestModule, Provider, RequestMethod } from '@nestjs/common';
-import { JwtModule } from '@nestjs/jwt';
 import * as passport from 'passport';
+import { JwtModule } from '@nestjs/jwt';
+import { PassportModule } from '@nestjs/passport';
+import { Global, MiddlewareConsumer, Module, NestModule, Provider, RequestMethod } from '@nestjs/common';
+
 import { USE_CASES } from './usecases';
 import { CONSTANTS } from '@shared/constants';
-import { PassportModule } from '@nestjs/passport';
 import { AuthController } from './auth.controller';
+import { PaymentAPIService } from '@impler/services';
 import { AuthService } from './services/auth.service';
 import { SharedModule } from '../shared/shared.module';
-import { GitHubStrategy } from './services/passport/github.strategy';
-import { JwtStrategy } from './services/passport/jwt.strategy';
 import { LeadService } from '@shared/services/lead.service';
-import { PaymentAPIService } from '@impler/services';
+import { JwtStrategy } from './services/passport/jwt.strategy';
+import { GitHubStrategy } from './services/passport/github.strategy';
 
 const AUTH_STRATEGIES: Provider[] = [JwtStrategy];
 
@@ -33,7 +34,7 @@ if (process.env.GITHUB_OAUTH_CLIENT_ID) {
     }),
   ],
   controllers: [AuthController],
-  providers: [AuthService, ...AUTH_STRATEGIES, ...USE_CASES, LeadService, PaymentAPIService],
+  providers: [AuthService, LeadService, ...AUTH_STRATEGIES, ...USE_CASES, PaymentAPIService],
   exports: [AuthService],
 })
 export class AuthModule implements NestModule {

apps/api/src/app/auth/dtos/index.ts

@@ -2,3 +2,4 @@ export * from './register-user.dto';
 export * from './login-user.dto';
 export * from './request-forgot-password.dto';
 export * from './reset-password.dto';
+export * from './onboard-user.dto';

apps/api/src/app/auth/dtos/onboard-user.dto.ts

@@ -0,0 +1,32 @@
+import { IsDefined, IsString } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class OnboardUserDto {
+  @ApiProperty({
+    description: 'Size of the company',
+  })
+  @IsString()
+  @IsDefined()
+  companySize: string;
+
+  @ApiProperty({
+    description: 'Role of the user',
+  })
+  @IsString()
+  @IsDefined()
+  role: string;
+
+  @ApiProperty({
+    description: 'Source from where the user heard about us',
+  })
+  @IsString()
+  @IsDefined()
+  source: string;
+
+  @ApiProperty({
+    description: 'Name of the Project',
+  })
+  @IsString()
+  @IsDefined()
+  projectName: string;
+}

apps/api/src/app/auth/services/auth.service.ts

@@ -3,9 +3,8 @@ import { JwtService } from '@nestjs/jwt';
 import { Injectable, UnauthorizedException } from '@nestjs/common';
 
 import { IJwtPayload } from '@impler/shared';
-import { CONSTANTS } from '@shared/constants';
+import { CONSTANTS, LEAD_SIGNUP_USING } from '@shared/constants';
 import { PaymentAPIService } from '@impler/services';
-import { LeadService } from '@shared/services/lead.service';
 import { UserEntity, UserRepository, EnvironmentRepository } from '@impler/dal';
 import { UserNotFoundException } from '@shared/exceptions/user-not-found.exception';
 import { IAuthenticationData, IStrategyResponse } from '@shared/types/auth.types';
@@ -15,7 +14,6 @@ import { IncorrectLoginCredentials } from '@shared/exceptions/incorrect-login-cr
 export class AuthService {
   constructor(
     private jwtService: JwtService,
-    private leadService: LeadService,
     private userRepository: UserRepository,
     private environmentRepository: EnvironmentRepository,
     private paymentAPIService: PaymentAPIService
@@ -32,16 +30,11 @@ export class AuthService {
         email: profile.email,
         firstName: profile.firstName,
         lastName: profile.lastName,
+        signupMethod: LEAD_SIGNUP_USING.GITHUB,
         profilePicture: profile.avatar_url,
         ...(provider ? { tokens: [provider] } : {}),
       };
       user = await this.userRepository.create(userObj);
-      await this.leadService.createLead({
-        'First Name': user.firstName,
-        'Last Name': user.lastName,
-        'Lead Email': user.email,
-        'Lead Source': 'Github Signup',
-      });
       userCreated = true;
 
       const userData = {

apps/api/src/app/auth/usecases/index.ts

@@ -1,20 +1,41 @@
 import { LoginUser } from './login-user/login-user.usecase';
+import { OnboardUser } from './onboard-user/onboard-user.usecase';
 import { RegisterUser } from './register-user/register-user.usecase';
 import { ResetPassword } from './reset-password/reset-password.usecase';
 import { RequestForgotPassword } from './request-forgot-password/request-forgot-pasword.usecase';
 
 import { LoginUserCommand } from './login-user/login-user.command';
+import { OnboardUserCommand } from './onboard-user/onboard-user.command';
 import { RegisterUserCommand } from './register-user/register-user.command';
 import { ResetPasswordCommand } from './reset-password/reset-password.command';
 import { RequestForgotPasswordCommand } from './request-forgot-password/request-forgot-pasword.command';
+import { CreateProject } from 'app/project/usecases';
+import { SaveSampleFile, UpdateImageColumns } from '@shared/usecases';
+import { CreateEnvironment, GenerateUniqueApiKey } from 'app/environment/usecases';
+import { CreateTemplate, UpdateCustomization, UpdateTemplateColumns } from 'app/template/usecases';
 
 export const USE_CASES = [
   RegisterUser,
   LoginUser,
+  OnboardUser,
   ResetPassword,
+  CreateProject,
+  SaveSampleFile,
+  CreateTemplate,
+  CreateEnvironment,
+  UpdateImageColumns,
+  UpdateCustomization,
+  GenerateUniqueApiKey,
+  UpdateTemplateColumns,
   RequestForgotPassword,
   //
 ];
 
-export { RegisterUser, LoginUser, RequestForgotPassword, ResetPassword };
-export { RegisterUserCommand, LoginUserCommand, RequestForgotPasswordCommand, ResetPasswordCommand };
+export { RegisterUser, LoginUser, RequestForgotPassword, ResetPassword, OnboardUser };
+export {
+  LoginUserCommand,
+  OnboardUserCommand,
+  RegisterUserCommand,
+  ResetPasswordCommand,
+  RequestForgotPasswordCommand,
+};

apps/api/src/app/auth/usecases/onboard-user/onboard-user.command.ts

@@ -0,0 +1,7 @@
+export class OnboardUserCommand {
+  _userId: string;
+  projectName: string;
+  companySize: string;
+  role: string;
+  source: string;
+}

apps/api/src/app/auth/usecases/onboard-user/onboard-user.usecase.ts

@@ -0,0 +1,49 @@
+import { Injectable } from '@nestjs/common';
+import { UserRepository } from '@impler/dal';
+import { LEAD_SIGNUP_USING } from '@shared/constants';
+import { OnboardUserCommand } from './onboard-user.command';
+import { LeadService } from '@shared/services/lead.service';
+import { CreateProject, CreateProjectCommand } from 'app/project/usecases';
+
+@Injectable()
+export class OnboardUser {
+  constructor(
+    private leadService: LeadService,
+    private createProject: CreateProject,
+    private userRepository: UserRepository
+  ) {}
+
+  async execute(command: OnboardUserCommand) {
+    const createdProject = await this.createProject.execute(
+      CreateProjectCommand.create({
+        _userId: command._userId,
+        name: command.projectName,
+        onboarding: true,
+      })
+    );
+
+    await this.userRepository.update(
+      { _id: command._userId },
+      {
+        role: command.role,
+        companySize: command.companySize,
+        source: command.source,
+      }
+    );
+
+    const updatedUser = await this.userRepository.findOne({ _id: command._userId });
+    if (updatedUser) {
+      await this.leadService.createLead({
+        'First Name': updatedUser.firstName,
+        'Last Name': updatedUser.lastName,
+        'Lead Email': updatedUser.email,
+        'Lead Source': updatedUser.source,
+        'Mentioned Role': updatedUser.role,
+        'Signup Method': updatedUser.signupMethod as LEAD_SIGNUP_USING,
+        'Company Size': updatedUser.companySize,
+      });
+    }
+
+    return createdProject;
+  }
+}

apps/api/src/app/auth/usecases/register-user/register-user.usecase.ts

@@ -6,14 +6,13 @@ import { PaymentAPIService } from '@impler/services';
 import { AuthService } from '../../services/auth.service';
 import { RegisterUserCommand } from './register-user.command';
 import { UniqueEmailException } from '@shared/exceptions/unique-email.exception';
-import { LeadService } from '@shared/services/lead.service';
+import { LEAD_SIGNUP_USING } from '@shared/constants';
 
 @Injectable()
 export class RegisterUser {
   constructor(
     private userRepository: UserRepository,
     private authService: AuthService,
-    private leadService: LeadService,
     private paymentAPIService: PaymentAPIService
   ) {}
 
@@ -31,13 +30,7 @@ export class RegisterUser {
       firstName: command.firstName.toLowerCase(),
       lastName: command.lastName?.toLowerCase(),
       password: passwordHash,
-    });
-
-    await this.leadService.createLead({
-      'First Name': user.firstName,
-      'Last Name': user.lastName,
-      'Lead Email': user.email,
-      'Lead Source': 'Website Signup',
+      signupMethod: LEAD_SIGNUP_USING.EMAIL,
     });
 
     const userData = {

apps/api/src/app/shared/constants.ts

@@ -82,3 +82,9 @@ export const VARIABLES = {
 export const DATE_FORMATS = {
   COMMON: 'DD MMM YYYY',
 };
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export enum LEAD_SIGNUP_USING {
+  GITHUB = 'Github',
+  EMAIL = 'Email',
+}