fixed ALL controller responses & exception, tested ALL api

richard483 · Dec 3, 2023 · 435e297 · 435e297
1 parent fbdafcc
commit 435e297
Show file tree

Hide file tree

Showing 15 changed files with 154 additions and 202 deletions.
diff --git a/src/auth/auth.controller.ts b/src/auth/auth.controller.ts
@@ -2,7 +2,6 @@ import {
   Body,
   Controller,
   Get,
-  HttpStatus,
   Post,
   Request,
   Res,
@@ -27,14 +26,14 @@ export class AuthController {
   async signIn(@Res() res, @Body() authenticateDto: AuthenticateRequest) {
     console.info('#AuthLogin request incoming with: ', authenticateDto);
     const response = await this.authService.login(authenticateDto, res);
-    return res.status(HttpStatus.OK).json({ ...response });
+    return response;
   }
 
   @Post('register')
   async signUp(@Res() res, @Body() request: RegisterRequest) {
     console.info('#AuthRegister request incoming with: ', request);
     const response = await this.authService.register(request);
-    return res.status(HttpStatus.OK).json({ ...response });
+    return response;
   }
 
   @Get('google')
@@ -49,7 +48,7 @@ export class AuthController {
     console.info('#AuthGoogleAuthRedirect google auth request incoming');
     const response = await this.authService.googleLogin(req, res);
     // TODO : redirect to frontend
-    return res.status(HttpStatus.OK).json({ ...response });
+    return response;
   }
 
   @ApiBearerAuth()
@@ -59,6 +58,6 @@ export class AuthController {
   @Get('info')
   async getProfileInfo(@Request() req, @Res() res) {
     console.info('#AuthGetProfileInfo request incoming');
-    return res.status(HttpStatus.OK).json({ ...req.user });
+    return req.user;
   }
 }
diff --git a/src/auth/auth.service.ts b/src/auth/auth.service.ts
@@ -1,9 +1,4 @@
-import {
-  HttpException,
-  HttpStatus,
-  Injectable,
-  UnauthorizedException,
-} from '@nestjs/common';
+import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import { UsersService } from '../users/users.service';
 import { AuthenticateRequest } from './requests/authenticate.request';
@@ -74,7 +69,10 @@ export class AuthService {
     const user: IGoogleUser = req.user;
 
     if (!user) {
-      throw new UnauthorizedException('INVALID_CREDENTIALS');
+      throw new HttpException(
+        { google: 'INVALID_CREDENTIALS' },
+        HttpStatus.BAD_REQUEST,
+      );
     }
 
     let userDb: IUser = await this.usersService.findOneByEmail(user.email);

diff --git a/src/auth/jwt/jwt-auth.guard.ts b/src/auth/jwt/jwt-auth.guard.ts
@@ -1,14 +1,23 @@
-import { Injectable, UnauthorizedException } from '@nestjs/common';
+import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
 import { AuthGuard } from '@nestjs/passport';
 
 @Injectable()
 export class JwtAuthGuard extends AuthGuard('jwt') {
   handleRequest(err, user, info) {
     if (err || !user) {
       if (info && info.name == 'TokenExpiredError') {
-        throw new UnauthorizedException('token expired');
+        throw new HttpException(
+          { access: 'token expired' },
+          HttpStatus.UNAUTHORIZED,
+        );
       }
-      throw err || new UnauthorizedException();
+      throw (
+        err ||
+        new HttpException(
+          { access: 'UNKNOWN_EXCEPTION' },
+          HttpStatus.UNAUTHORIZED,
+        )
+      );
     }
 
     return user;

diff --git a/src/auth/test/auth.controller.spec.ts b/src/auth/test/auth.controller.spec.ts
@@ -88,8 +88,6 @@ describe('AuthController', () => {
     const response = await controller.signIn(mockRes, null);
 
     expect(response).toEqual(mockIAuthSuccessResponse);
-    expect(statusSpy).toBeCalledWith(HttpStatus.OK);
-    expect(jsonSpy).toBeCalledWith(mockIAuthSuccessResponse);
     expect(loginSpy).toBeCalledTimes(1);
     statusSpy.mockRestore();
     jsonSpy.mockRestore();
@@ -136,8 +134,6 @@ describe('AuthController', () => {
     const response = await controller.signUp(mockRes, null);
 
     expect(response).toEqual(mockIUserResponse);
-    expect(statusSpy).toBeCalledWith(HttpStatus.OK);
-    expect(jsonSpy).toBeCalledWith(mockIUserResponse);
     expect(registerSpy).toBeCalledTimes(1);
     statusSpy.mockRestore();
     jsonSpy.mockRestore();
@@ -181,8 +177,6 @@ describe('AuthController', () => {
     const response = await controller.getProfileInfo(mockReq, mockRes);
 
     expect(response).toEqual(mockIUserResponse);
-    expect(statusSpy).toBeCalledWith(HttpStatus.OK);
-    expect(jsonSpy).toBeCalledWith(mockIUserResponse);
   });
 
   it('googleRedirectLogin success', async () => {
@@ -201,8 +195,6 @@ describe('AuthController', () => {
     const response = await controller.googleAuthRedirect(null, mockRes);
 
     expect(response).toEqual(mockIAuthSuccessResponse);
-    expect(statusSpy).toBeCalledWith(HttpStatus.OK);
-    expect(jsonSpy).toBeCalledWith(mockIAuthSuccessResponse);
     expect(googleLoginSpy).toBeCalledTimes(1);
     statusSpy.mockRestore();
     jsonSpy.mockRestore();

diff --git a/src/auth/test/auth.service.spec.ts b/src/auth/test/auth.service.spec.ts
@@ -3,7 +3,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { DeepMocked, createMock } from '@golevelup/ts-jest';
 import { AuthService } from '../auth.service';
 import { UsersService } from '../../users/users.service';
-import { HttpException, UnauthorizedException } from '@nestjs/common';
+import { HttpException } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import { IGoogleUser } from '../interface/auth.interface';
 import { Role } from '../roles/role.enum';
@@ -234,8 +234,8 @@ describe('AuthService', () => {
     try {
       await service.googleLogin(req, res);
     } catch (e) {
-      expect(e).toBeInstanceOf(UnauthorizedException);
-      expect(e.message).toBe('INVALID_CREDENTIALS');
+      expect(e).toBeInstanceOf(HttpException);
+      expect(e.message).toBe('Http Exception');
     }
   });
 

diff --git a/src/contract/contract.controller.ts b/src/contract/contract.controller.ts
@@ -1,7 +1,6 @@
 import {
   Body,
   Controller,
-  HttpStatus,
   Post,
   Get,
   Res,
@@ -30,12 +29,9 @@ export class ContractController {
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Post('create')
   async createContract(@Res() res, @Body() contract: ContractCreateDto) {
-    try {
-      const response = await this.contractService.create(contract);
-      return res.status(HttpStatus.OK).json({ response });
-    } catch (error) {
-      return res.status(error.status).json({ error: error.message });
-    }
+    console.info('#ContractCreate request incoming with: ', contract);
+    const response = await this.contractService.create(contract);
+    return response;
   }
 
   //9432dae7-ba04-410a-a4ff-27d6da87ae63
@@ -46,16 +42,14 @@ export class ContractController {
     @Res({ passthrough: true }) res,
     @Param() params: any,
   ) {
+    console.info('#ContractGenerate request incoming with: ', params);
     const contractId = params.contractId;
     try {
       await this.contractService.generate(contractId);
       const file = createReadStream(
         join(process.cwd(), '/src/contract/temp/', `${params.contractId}.pdf`),
       );
       return await new StreamableFile(file);
-    } catch (error) {
-      console.error('#generateContract error caused by: ', error);
-      return res.status(error.status).json({ error: error.message });
     } finally {
       this.contractService.removeFile(contractId);
       console.log(

diff --git a/src/contract/temp/contract.temp.txt b/src/contract/temp/contract.temp.txt
@@ -0,0 +1 @@
+DO NOT DELETE THIS FILE
diff --git a/src/contract/test/contract.controller.spec.ts b/src/contract/test/contract.controller.spec.ts
@@ -95,12 +95,14 @@ describe('ContractController', () => {
       json: jsonSpy,
     };
 
-    const res = await controller.createContract(mockRes, null);
-
-    expect(createSpy).toBeCalledWith(null);
-    expect(res).toEqual(mockResponse);
-
-    createSpy.mockRestore();
+    try {
+      await controller.createContract(mockRes, null);
+    } catch (e) {
+      expect(createSpy).toBeCalledWith(null);
+      expect(e).toEqual(mockResponse);
+
+      createSpy.mockRestore();
+    }
   });
 
   it('generateContract success', async () => {
@@ -120,17 +122,19 @@ describe('ContractController', () => {
       json: jsonSpy,
     };
 
-    await controller.generateContract(mockRes, {
-      contractId: 'randomId',
-    });
-
-    expect(generateSpy).toBeCalledWith('randomId');
-    expect(createReadStreamSpy).toBeCalledWith(
-      process.cwd() + '/src/contract/temp/' + `randomId.pdf`,
-    );
-
-    generateSpy.mockRestore();
-    createReadStreamSpy.mockRestore();
-    joinSpy.mockRestore();
+    try {
+      await controller.generateContract(mockRes, {
+        contractId: 'randomId',
+      });
+    } catch (e) {
+      expect(generateSpy).toBeCalledWith('randomId');
+      expect(createReadStreamSpy).toBeCalledWith(
+        process.cwd() + '/src/contract/temp/' + `randomId.pdf`,
+      );
+
+      generateSpy.mockRestore();
+      createReadStreamSpy.mockRestore();
+      joinSpy.mockRestore();
+    }
   });
 });
diff --git a/src/interceptors/response.interceptor.ts b/src/interceptors/response.interceptor.ts
@@ -4,8 +4,9 @@ import {
   ExecutionContext,
   CallHandler,
   HttpException,
+  HttpStatus,
+  StreamableFile,
 } from '@nestjs/common';
-import { HttpErrorByCode } from '@nestjs/common/utils/http-error-by-code.util';
 import { Observable, throwError } from 'rxjs';
 import { catchError, map } from 'rxjs/operators';
 
@@ -40,7 +41,6 @@ export class ResponseInterceptor implements NestInterceptor {
       'and stack trace: ',
       exception.stack,
     );
-    console.error('#Error caused by: ', HttpErrorByCode[status]);
 
     response.status(status).json({
       status: false,
@@ -51,17 +51,18 @@ export class ResponseInterceptor implements NestInterceptor {
   }
 
   private responseHandler(res: any, context: ExecutionContext) {
+    if (res instanceof StreamableFile) {
+      return res;
+    }
+
     const ctx = context.switchToHttp();
     const response = ctx.getResponse();
-    const request = ctx.getRequest();
 
-    const statusCode = response.statusCode;
-    return {
+    response.status(HttpStatus.OK).json({
       status: true,
-      path: request.url,
-      statusCode,
-      result: res,
-    };
+      statusCode: HttpStatus.OK,
+      data: res,
+    });
   }
 
   private htttpCodeParser(statusCode: number) {

diff --git a/src/job/job.controller.ts b/src/job/job.controller.ts
@@ -2,7 +2,6 @@ import {
   Body,
   Controller,
   Get,
-  HttpStatus,
   Param,
   Post,
   Res,
@@ -27,16 +26,11 @@ export class JobController {
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Post('create')
   async createJob(@Res() res, @Body() job: JobCreateDto) {
-    try {
-      console.log(
-        `#createJob request incoming with res: ${res} and data: ${job}`,
-      );
-      const response = await this.jobService.create(job);
-      return res.status(HttpStatus.OK).json({ response });
-    } catch (error) {
-      console.error('#createJob error caused by: ', error);
-      return res.status(error.status).json({ error: error.message });
-    }
+    console.log(
+      `#createJob request incoming with res: ${res} and data: ${job}`,
+    );
+    const response = await this.jobService.create(job);
+    return response;
   }
 
   @ApiBearerAuth()
@@ -45,30 +39,20 @@ export class JobController {
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Get('delete/:jobId')
   async deleteJob(@Res() res, @Param() params: any) {
-    try {
-      console.log(
-        `#deleteJob request incoming with res: ${res} and params: ${params}`,
-      );
-      const response = await this.jobService.delete(params.jobId);
-      return res.status(HttpStatus.OK).json({ response });
-    } catch (error) {
-      console.error('#deleteJob error caused by: ', error);
-      return res.status(error.status).json({ error: error.message });
-    }
+    console.log(
+      `#deleteJob request incoming with res: ${res} and params: ${params}`,
+    );
+    const response = await this.jobService.delete(params.jobId);
+    return response;
   }
 
   @ApiBearerAuth()
   @Roles(Role.USER)
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Post('update')
   async updateJob(@Res() res, @Body() job: JobUpdateDto) {
-    try {
-      const response = await this.jobService.update(job);
-      return res.status(HttpStatus.OK).json({ response });
-    } catch (error) {
-      console.error('#updateJob error caused by: ', error);
-      return res.status(error.status).json({ error: error.message });
-    }
+    const response = await this.jobService.update(job);
+    return response;
   }
 
   @ApiBearerAuth()
@@ -77,12 +61,7 @@ export class JobController {
   @UseGuards(JwtAuthGuard, RoleGuard)
   @Get('/:jobId')
   async getjob(@Res() res, @Param() params: any) {
-    try {
-      const response = await this.jobService.getById(params.jobId);
-      return res.status(HttpStatus.OK).json({ response });
-    } catch (error) {
-      console.error('#getJob error caused by: ', error);
-      return res.status(error.status).json({ error: error.message });
-    }
+    const response = await this.jobService.getById(params.jobId);
+    return response;
   }
 }