add user onboard status

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["onboarded"]
+}

src/auth/guard/auth/auth.guard.ts

@@ -3,13 +3,15 @@ import {
   ExecutionContext,
   ForbiddenException,
   Injectable,
+  UnauthorizedException,
 } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import { Request } from 'express';
 import { Reflector } from '@nestjs/core';
 import { IS_PUBLIC_KEY } from '../../../decorators/public.decorator';
 import { PrismaService } from '../../../prisma/prisma.service';
 import { User } from '@prisma/client';
+import { ONBOARDING_BYPASSED } from '../../../decorators/bypass-onboarding.decorator';
 
 const X_E2E_USER_EMAIL = 'x-e2e-user-email';
 
@@ -74,6 +76,17 @@ export class AuthGuard implements CanActivate {
       }
     }
 
+    const onboardingBypassed =
+      this.reflector.getAllAndOverride<boolean>(ONBOARDING_BYPASSED, [
+        context.getHandler(),
+        context.getClass(),
+      ]) ?? false;
+
+    // If the onboarding is not finished, we throw an UnauthorizedException.
+    if (!onboardingBypassed && !user.onboarded) {
+      throw new UnauthorizedException('Onboarding not finished');
+    }
+
     // We attach the user to the request object.
     request['user'] = user;
     return true;

src/decorators/bypass-onboarding.decorator.ts

@@ -0,0 +1,11 @@
+import { SetMetadata } from '@nestjs/common';
+
+/**
+ * There are some routes that we want the users to be able to access
+ * even before they are done with the onboarding process. This decorator
+ * is used to mark those routes.
+ */
+
+export const ONBOARDING_BYPASSED = 'onboarding_bypassed';
+export const BypassOnboardingCheck = () =>
+  SetMetadata(ONBOARDING_BYPASSED, true);

src/prisma/migrations/20240618125311_add_user_onboard_status/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "User" ADD COLUMN     "onboarded" BOOLEAN NOT NULL DEFAULT false;

src/prisma/schema.prisma

@@ -30,6 +30,7 @@ model User {
   email             String?          @unique
   name              String?
   location          String?
+  onboarded         Boolean          @default(false)
   profilePictureUrl String?
   socialAccounts    SocialAccount[]
   authType          AuthType

src/user/controller/user.controller.ts

@@ -4,6 +4,7 @@ import {
   Controller,
   Delete,
   Get,
+  Patch,
   Put,
   Req,
   Res,
@@ -29,6 +30,7 @@ import { LinkedInOAuthStrategyFactory } from '../../oauth/factory/linkedin/linke
 import { AuthGuard } from '@nestjs/passport';
 import { UpdateUserSettingsDto } from '../dto/update-user-settings.dto';
 import { UserSettingsDto } from '../dto/user-settings.dto';
+import { BypassOnboardingCheck } from '../../decorators/bypass-onboarding.decorator';
 
 @Controller('user')
 @ApiBearerAuth()
@@ -40,6 +42,7 @@ export class UserController {
   ) {}
 
   @Get()
+  @BypassOnboardingCheck()
   @ApiOperation({
     summary: 'Get current user',
     description: 'Get the currently logged in user',
@@ -143,6 +146,12 @@ export class UserController {
     return this.userService.updateSettings(user.id, data);
   }
 
+  @Patch('onboard')
+  @BypassOnboardingCheck()
+  async onboardUser(@CurrentUser() user: User) {
+    return this.userService.onboardUser(user);
+  }
+
   /**
    * Delete the entire user account
    */

src/user/service/user.service.ts

@@ -1,5 +1,6 @@
 import {
   BadRequestException,
+  ConflictException,
   Inject,
   Injectable,
   InternalServerErrorException,
@@ -138,6 +139,17 @@ export class UserService {
     }
   }
 
+  async onboardUser(user: User) {
+    if (user.onboarded) {
+      throw new ConflictException('User has already been onboarded');
+    }
+
+    await this.prisma.user.update({
+      where: { id: user.id },
+      data: { onboarded: true },
+    });
+  }
+
   updateSettings(id: string, data: UpdateUserSettingsDto) {
     return this.prisma.userSettings.update({
       where: {

src/user/user.e2e.spec.ts

@@ -44,6 +44,7 @@ describe('User Controller Tests', () => {
         name: 'John Doe',
         isEmailVerified: true,
         authType: AuthType.EMAIL,
+        onboarded: true,
       },
     });
   });