Merge pull request #91 from monstar-lab-oss/sivan/user-from-ctx

user from ctx

Author: yashmurty

src/auth/controllers/auth.controller.spec.ts

@@ -5,10 +5,7 @@ import { AuthService } from '../services/auth.service';
 import { RegisterInput } from '../dtos/auth-register-input.dto';
 import { LoginInput } from '../dtos/auth-login-input.dto';
 import { RefreshTokenInput } from '../dtos/auth-refresh-token-input.dto';
-import {
-  AuthTokenOutput,
-  UserRefreshTokenClaims,
-} from '../dtos/auth-token-output.dto';
+import { AuthTokenOutput } from '../dtos/auth-token-output.dto';
 import { RequestContext } from '../../shared/request-context/request-context.dto';
 import { AppLogger } from '../../shared/logger/logger.service';
 
@@ -68,37 +65,27 @@ describe('AuthController', () => {
       loginInputDto.username = '[email protected]';
       loginInputDto.password = '123123';
 
-      const reqObject: any = {};
-
       jest.spyOn(mockedAuthService, 'login').mockImplementation(() => null);
 
-      expect(await authController.login(ctx, reqObject, loginInputDto)).toEqual(
-        {
-          data: null,
-          meta: {},
-        },
-      );
+      expect(await authController.login(ctx, loginInputDto)).toEqual({
+        data: null,
+        meta: {},
+      });
     });
   });
 
   describe('refreshToken', () => {
-    let tokenUser: UserRefreshTokenClaims;
     let refreshTokenInputDto: RefreshTokenInput;
     let authToken: AuthTokenOutput;
-    let request: any;
 
     beforeEach(() => {
-      tokenUser = { id: 1 };
       refreshTokenInputDto = {
         refreshToken: 'refresh_token',
       };
       authToken = {
         accessToken: 'new_access_token',
         refreshToken: 'new_refresh_token',
       };
-      request = {
-        user: tokenUser,
-      };
 
       jest
         .spyOn(mockedAuthService, 'refreshToken')
@@ -108,11 +95,10 @@ describe('AuthController', () => {
     it('should generate refresh token', async () => {
       const response = await authController.refreshToken(
         ctx,
-        request,
         refreshTokenInputDto,
       );
 
-      expect(mockedAuthService.refreshToken).toBeCalledWith(ctx, tokenUser);
+      expect(mockedAuthService.refreshToken).toBeCalledWith(ctx);
       expect(response.data).toEqual(authToken);
     });
 

src/auth/controllers/auth.controller.ts

@@ -1,5 +1,4 @@
 import {
-  Req,
   Post,
   Body,
   UseGuards,
@@ -9,19 +8,14 @@ import {
   ClassSerializerInterceptor,
   HttpCode,
 } from '@nestjs/common';
-import { Request } from 'express';
 import { ApiTags, ApiResponse, ApiOperation } from '@nestjs/swagger';
 
 import { AuthService } from '../services/auth.service';
 import { LoginInput } from '../dtos/auth-login-input.dto';
 import { RegisterInput } from '../dtos/auth-register-input.dto';
 import { RegisterOutput } from '../dtos/auth-register-output.dto';
 import { LocalAuthGuard } from '../guards/local-auth.guard';
-import {
-  AuthTokenOutput,
-  UserAccessTokenClaims,
-  UserRefreshTokenClaims,
-} from '../dtos/auth-token-output.dto';
+import { AuthTokenOutput } from '../dtos/auth-token-output.dto';
 import { RefreshTokenInput } from '../dtos/auth-refresh-token-input.dto';
 import { JwtRefreshGuard } from '../guards/jwt-refresh.guard';
 import {
@@ -59,16 +53,12 @@ export class AuthController {
   @UseInterceptors(ClassSerializerInterceptor)
   login(
     @ReqContext() ctx: RequestContext,
-    @Req() req: Request,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     @Body() credential: LoginInput,
   ): BaseApiResponse<AuthTokenOutput> {
     this.logger.logWithContext(ctx, `${this.login.name} was called`);
 
-    const authToken = this.authService.login(
-      ctx,
-      req.user as UserAccessTokenClaims,
-    );
+    const authToken = this.authService.login(ctx);
     return { data: authToken, meta: {} };
   }
 
@@ -105,16 +95,12 @@ export class AuthController {
   @UseInterceptors(ClassSerializerInterceptor)
   async refreshToken(
     @ReqContext() ctx: RequestContext,
-    @Req() req: Request,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     @Body() credential: RefreshTokenInput,
   ): Promise<BaseApiResponse<AuthTokenOutput>> {
     this.logger.logWithContext(ctx, `${this.refreshToken.name} was called`);
 
-    const authToken = await this.authService.refreshToken(
-      ctx,
-      req.user as UserRefreshTokenClaims,
-    );
+    const authToken = await this.authService.refreshToken(ctx);
     return { data: authToken, meta: {} };
   }
 }

src/auth/dtos/auth-token-output.dto.ts

@@ -14,8 +14,11 @@ export class AuthTokenOutput {
 }
 
 export class UserAccessTokenClaims {
+  @Expose()
   id: number;
+  @Expose()
   username: string;
+  @Expose()
   roles: ROLE[];
 }
 

src/auth/services/auth.service.spec.ts

@@ -10,7 +10,6 @@ import { UserOutput } from '../../user/dtos/user-output.dto';
 import {
   AuthTokenOutput,
   UserAccessTokenClaims,
-  UserRefreshTokenClaims,
 } from '../dtos/auth-token-output.dto';
 import { ROLE } from '../constants/role.constant';
 import { AppLogger } from '../../shared/logger/logger.service';
@@ -19,7 +18,6 @@ import { RequestContext } from '../../shared/request-context/request-context.dto
 describe('AuthService', () => {
   let service: AuthService;
 
-  const refreshTokenClaims: UserRefreshTokenClaims = { id: 6 };
   const accessTokenClaims: UserAccessTokenClaims = {
     id: 6,
     username: 'jhon',
@@ -130,7 +128,7 @@ describe('AuthService', () => {
     it('should return auth token for valid user', async () => {
       jest.spyOn(service, 'getAuthToken').mockImplementation(() => authToken);
 
-      const result = service.login(ctx, accessTokenClaims);
+      const result = service.login(ctx);
 
       expect(service.getAuthToken).toBeCalledWith(ctx, accessTokenClaims);
       expect(result).toEqual(authToken);
@@ -151,14 +149,16 @@ describe('AuthService', () => {
   });
 
   describe('refreshToken', () => {
+    ctx.user = accessTokenClaims;
+
     it('should generate auth token', async () => {
       jest
         .spyOn(mockedUserService, 'findById')
         .mockImplementation(async () => userOutput);
 
       jest.spyOn(service, 'getAuthToken').mockImplementation(() => authToken);
 
-      const result = await service.refreshToken(ctx, refreshTokenClaims);
+      const result = await service.refreshToken(ctx);
 
       expect(service.getAuthToken).toBeCalledWith(ctx, userOutput);
       expect(result).toMatchObject(authToken);
@@ -169,9 +169,9 @@ describe('AuthService', () => {
         .spyOn(mockedUserService, 'findById')
         .mockImplementation(async () => null);
 
-      await expect(
-        service.refreshToken(ctx, refreshTokenClaims),
-      ).rejects.toThrowError('Invalid user id');
+      await expect(service.refreshToken(ctx)).rejects.toThrowError(
+        'Invalid user id',
+      );
     });
 
     afterEach(() => {

src/auth/services/auth.service.ts

@@ -10,7 +10,6 @@ import { RegisterOutput } from '../dtos/auth-register-output.dto';
 import {
   AuthTokenOutput,
   UserAccessTokenClaims,
-  UserRefreshTokenClaims,
 } from '../dtos/auth-token-output.dto';
 import { UserOutput } from '../../user/dtos/user-output.dto';
 import { AppLogger } from '../../shared/logger/logger.service';
@@ -49,13 +48,10 @@ export class AuthService {
     return user;
   }
 
-  login(
-    ctx: RequestContext,
-    accessTokenClaims: UserAccessTokenClaims,
-  ): AuthTokenOutput {
+  login(ctx: RequestContext): AuthTokenOutput {
     this.logger.logWithContext(ctx, `${this.login.name} was called`);
 
-    return this.getAuthToken(ctx, accessTokenClaims);
+    return this.getAuthToken(ctx, ctx.user);
   }
 
   async register(
@@ -74,13 +70,10 @@ export class AuthService {
     });
   }
 
-  async refreshToken(
-    ctx: RequestContext,
-    refreshTokenClaims: UserRefreshTokenClaims,
-  ): Promise<AuthTokenOutput> {
+  async refreshToken(ctx: RequestContext): Promise<AuthTokenOutput> {
     this.logger.logWithContext(ctx, `${this.refreshToken.name} was called`);
 
-    const user = await this.userService.findById(ctx, refreshTokenClaims.id);
+    const user = await this.userService.findById(ctx, ctx.user.id);
     if (!user) {
       throw new UnauthorizedException('Invalid user id');
     }

src/auth/strategies/local.strategy.ts

@@ -15,6 +15,7 @@ export class LocalStrategy extends PassportStrategy(Strategy, STRATEGY_LOCAL) {
     private authService: AuthService,
     private readonly logger: AppLogger,
   ) {
+    // Add option passReqToCallback: true to configure strategy to be request-scoped.
     super({
       usernameField: 'username',
       passwordField: 'password',

src/shared/filters/all-exceptions.filter.spec.ts

@@ -25,6 +25,7 @@ describe('AllExceptionsFilter', () => {
   const mockedLogger = {
     warn: jest.fn().mockReturnThis(),
     setContext: jest.fn().mockReturnThis(),
+    warnWithContext: jest.fn().mockReturnThis(),
   };
   let filter: AllExceptionsFilter<any>;
 

src/shared/filters/all-exceptions.filter.ts

@@ -11,6 +11,7 @@ import { ConfigService } from '@nestjs/config';
 import { REQUEST_ID_TOKEN_HEADER } from '../constants';
 import { AppLogger } from '../logger/logger.service';
 import { BaseApiError } from '../errors/base-api-error';
+import { createRequestContext } from '../request-context/util';
 
 @Catch()
 export class AllExceptionsFilter<T> implements ExceptionFilter {
@@ -30,6 +31,7 @@ export class AllExceptionsFilter<T> implements ExceptionFilter {
     const path = req.url;
     const timestamp = new Date().toISOString();
     const requestId = req.headers[REQUEST_ID_TOKEN_HEADER];
+    const requestContext = createRequestContext(req);
 
     let stack: any;
     let statusCode: HttpStatus;
@@ -75,7 +77,10 @@ export class AllExceptionsFilter<T> implements ExceptionFilter {
       requestId,
       timestamp,
     };
-    this.logger.warn({ error, stack });
+    this.logger.warnWithContext(requestContext, error.message, {
+      error,
+      stack,
+    });
 
     // Suppress original internal server error details in prod mode
     const isProMood = this.config.get<string>('env') !== 'development';

src/shared/interceptors/logging.interceptor.ts

@@ -7,7 +7,7 @@ import {
 import { Observable } from 'rxjs';
 import { tap } from 'rxjs/operators';
 import { AppLogger } from '../logger/logger.service';
-import { REQUEST_ID_TOKEN_HEADER } from '../constants';
+import { createRequestContext } from '../request-context/util';
 
 @Injectable()
 export class LoggingInterceptor implements NestInterceptor {
@@ -18,10 +18,7 @@ export class LoggingInterceptor implements NestInterceptor {
   intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
     const request = context.switchToHttp().getRequest();
     const method = request.method;
-    const url = request.originalUrl;
-    const requestID = request.headers[REQUEST_ID_TOKEN_HEADER];
-
-    this.appLogger.log({ method, requestID, url });
+    const ctx = createRequestContext(request);
 
     const now = Date.now();
     return next.handle().pipe(
@@ -30,13 +27,10 @@ export class LoggingInterceptor implements NestInterceptor {
         const statusCode = response.statusCode;
 
         const responseTime = Date.now() - now;
-        this.appLogger.log({
-          method,
-          requestID,
-          url,
-          statusCode,
-          responseTime,
-        });
+
+        const resData = { method, statusCode, responseTime };
+
+        this.appLogger.logWithContext(ctx, 'Request completed', { resData });
       }),
     );
   }

src/shared/logger/logger.service.ts

@@ -55,12 +55,54 @@ export class AppLogger implements LoggerService {
 
   // TODO : This is a temporary function, it will be renamed to `log` once we update it across
   // all controllers, services, etc.
-  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-  logWithContext(ctx: RequestContext, message: any): Logger {
+  logWithContext(
+    ctx: RequestContext,
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    message: any,
+    meta?: Record<string, any>,
+  ): Logger {
+    const timestamp = new Date().toISOString();
+
     return this.logger.info({
       message,
+      contextName: this.context,
+      ctx,
+      timestamp,
+      ...meta,
+    });
+  }
+
+  warnWithContext(
+    ctx: RequestContext,
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    message: any,
+    meta?: Record<string, any>,
+  ): Logger {
+    const timestamp = new Date().toISOString();
+
+    return this.logger.warn({
+      message,
+      contextName: this.context,
       ctx,
+      timestamp,
+      ...meta,
+    });
+  }
+
+  errorWithContext(
+    ctx: RequestContext,
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    message: any,
+    meta?: Record<string, any>,
+  ): Logger {
+    const timestamp = new Date().toISOString();
+
+    return this.logger.error({
+      message,
       contextName: this.context,
+      ctx,
+      timestamp,
+      ...meta,
     });
   }
 }