💥 refactor profile error messages

Author: kalashshah

src/constants/decode.ts

@@ -1,7 +1,7 @@
 import { PrismaService } from 'prisma/prisma.service';
-import { BadRequestException } from '@nestjs/common';
 import * as jwt from 'jsonwebtoken';
 import { SECRET_KEY } from './env';
+import { HttpException, HttpStatus } from '@nestjs/common';
 
 /**
  * It takes a token and a prisma service as arguments, decodes the token, finds the user in the
@@ -14,10 +14,29 @@ export const decode = async (token: string, prisma: PrismaService) => {
   const decoded = jwt.verify(token, SECRET_KEY) as jwt.JwtPayload;
   const userId = decoded?.user;
   if (!userId) throw new Error('Invalid authorization token');
-  const user = await prisma.user.findUnique({
-    where: { id: userId },
-  });
-  if (!user) throw new BadRequestException('Invalid authorization token');
-  if (!user.isVerified) throw new BadRequestException('User not verified');
+  const user = await prisma.user.findUnique({ where: { id: userId } });
+  if (!user)
+    throw new HttpException(
+      'Invalid authorization token',
+      HttpStatus.BAD_REQUEST,
+    );
+  if (!user.isVerified)
+    throw new HttpException('User not verified', HttpStatus.BAD_REQUEST);
   return user;
 };
+
+/**
+ * It gets the token from the request header, and if it's not found, it throws an error.
+ * @param {any} context - any - this is the context object that is passed to the resolver function.
+ * @returns The token is being returned.
+ */
+export const getToken = (context: any) => {
+  const authorization = context?.req?.headers?.authorization;
+  const token = authorization?.split(' ')[1];
+  if (token === undefined)
+    throw new HttpException(
+      'Invalid request, token not found',
+      HttpStatus.BAD_REQUEST,
+    );
+  return token;
+};

src/profile/profile.resolver.ts

@@ -10,17 +10,15 @@ import {
   UserIdInput,
 } from 'src/graphql.types';
 import { ProfileService } from './profile.service';
+import { getToken } from 'src/constants/decode';
 
 @Resolver()
 export class ProfileResolver {
   constructor(private readonly profileService: ProfileService) {}
 
   @Mutation('authorizeGithub')
   async authorizeGithub(@Context() context) {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return this.profileService.authorizeGithub(token);
   }
 
@@ -29,19 +27,13 @@ export class ProfileResolver {
     @Args('input') input: AddUsernameInput,
     @Context() context,
   ) {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return this.profileService.addUsername(input, token);
   }
 
   @Query('getUser')
   async getUser(@Context() context): Promise<RestrictedUserSelf> {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.getUser(token);
   }
 
@@ -50,9 +42,7 @@ export class ProfileResolver {
     @Args('input') input: UserIdInput,
     @Context() context,
   ): Promise<RestrictedUserOther> {
-    const token = context?.req?.headers?.authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.getUserById(input.userId, token);
   }
 
@@ -61,10 +51,7 @@ export class ProfileResolver {
     @Args('input') input: SearchInput,
     @Context() context,
   ): Promise<RestrictedUserOther[]> {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.search(
       input.query,
       input?.page || 1,
@@ -77,10 +64,7 @@ export class ProfileResolver {
     @Args('input') input: ToggleFollowInput,
     @Context() context,
   ): Promise<string> {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.toggleFollow(input, token);
   }
 
@@ -89,10 +73,7 @@ export class ProfileResolver {
     @Args('input') input: PaginatedUserInput,
     @Context() context,
   ): Promise<RestrictedUserOther[]> {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.getFollowers(
       input?.page || 1,
       input.userId,
@@ -105,10 +86,7 @@ export class ProfileResolver {
     @Args('input') input: PaginatedUserInput,
     @Context() context,
   ): Promise<RestrictedUserOther[]> {
-    const authorization = context.req.headers.authorization;
-    const token = authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.getFollowing(
       input?.page || 1,
       input.userId,
@@ -121,9 +99,7 @@ export class ProfileResolver {
     @Args('input') input: DescriptionInput,
     @Context() context,
   ): Promise<string> {
-    const token = context?.req?.headers?.authorization?.split(' ')[1];
-    if (token === undefined)
-      throw new Error('Invalid request, token not found');
+    const token = getToken(context);
     return await this.profileService.addDescription(input.description, token);
   }
 }

src/profile/profile.service.ts

@@ -16,6 +16,7 @@ import {
 } from 'src/graphql.types';
 import { NotificationService } from 'src/notification/notification.service';
 import { followingNotification } from 'src/constants/notifications';
+import { HttpException, HttpStatus } from '@nestjs/common';
 
 @Injectable()
 export class ProfileService {
@@ -34,7 +35,7 @@ export class ProfileService {
     const user = await decode(token, this.prisma);
     const userId = user.id;
     if (!user) {
-      throw new BadRequestException('User not found');
+      throw new HttpException('User not found', HttpStatus.BAD_REQUEST);
     }
     const state = this.createState(userId);
     await this.clearGithubAuthTokens(userId);
@@ -62,7 +63,10 @@ export class ProfileService {
     const userId = user.id;
     const { username, platform } = data;
     if (!username || !platform) {
-      throw new BadRequestException('Username and platform are required');
+      throw new HttpException(
+        'Username and platform are required',
+        HttpStatus.BAD_REQUEST,
+      );
     }
     if (platform === Website.CODEFORCES) {
       await this.prisma.user.update({
@@ -75,7 +79,7 @@ export class ProfileService {
         data: { leetcodeUsername: username },
       });
     } else {
-      throw new BadRequestException('Invalid platform');
+      throw new HttpException('Invalid platform', HttpStatus.BAD_REQUEST);
     }
     return 'Username added successfully';
   }
@@ -142,7 +146,10 @@ export class ProfileService {
     const userId = user.id;
     const friendId = data.userId;
     if (friendId === userId) {
-      throw new BadRequestException('You cannot follow or unfollow yourself');
+      throw new HttpException(
+        'You cannot follow or unfollow yourself',
+        HttpStatus.BAD_REQUEST,
+      );
     }
     if (data.action === 'ADD') {
       await this.addFollowing(userId, friendId);
@@ -156,7 +163,7 @@ export class ProfileService {
       await this.removeFollowing(userId, friendId);
       await this.removeFollowedBy(userId, friendId);
     } else {
-      throw new BadRequestException('Invalid action');
+      throw new HttpException('Invalid action', HttpStatus.BAD_REQUEST);
     }
     return 'Follow toggled successfully';
   }