refactor: 에러 상세 정보는 응답하지 않고 로깅만 하도록 수정 #187

BaseException 에 에러 필드를 추가해 상세 로깅 가능하도록 수정

Author: Miensoap

backend/src/common/exception/BaseException.ts

@@ -4,7 +4,10 @@ import { ExceptionType } from './ExceptionType';
 export class BaseException extends HttpException {
   readonly code: number;
 
-  constructor(exceptionType: ExceptionType) {
+  constructor(
+    readonly exceptionType: ExceptionType,
+    readonly error?: Error,
+  ) {
     super(exceptionType.message, exceptionType.status);
     this.code = exceptionType.code;
   }

backend/src/common/exception/filter/GlobalExceptionFilter.ts

@@ -18,7 +18,7 @@ export class BaseExceptionFilter implements ExceptionFilter {
     const response = ctx.getResponse<Response>();
 
     const status = exception.getStatus();
-    logException(this.logger, exception.getMessage(), status);
+    logException(this.logger, exception.getMessage(), status, exception.error);
 
     return response.status(status).json({
       code: exception.getCode(),
@@ -59,14 +59,23 @@ export class HttpExceptionFilter implements ExceptionFilter {
   }
 }
 
-function logException(logger: PinoLogger, message: string, status: number) {
+function logException(
+  logger: PinoLogger,
+  message: string,
+  status: number,
+  error?: Error,
+) {
   const WARN = 400;
   const ERROR = 500;
 
   if (status < WARN) return;
   void (status < ERROR
-    ? logger.warn(`${message}`)
-    : logger.error(`${message}`));
+    ? logger.warn(message)
+    : logger.error({
+        message,
+        stack: error?.stack,
+        name: error?.name,
+      }));
 }
 
 @Catch()
@@ -90,8 +99,6 @@ export class UnknownExceptionFilter implements ExceptionFilter {
       });
     }
 
-    console.error(exception);
-
     return response.status(HttpStatus.INTERNAL_SERVER_ERROR).json({
       code: -1,
       message: 'Internal server error',

backend/src/search/exception/ElasticSearchSaveException.ts

@@ -2,12 +2,15 @@ import { BaseException } from '@src/common/exception/BaseException';
 import { HttpStatus } from '@nestjs/common';
 
 export class ElasticSearchSaveException extends BaseException {
-  constructor(id?: number) {
-    const message = `${id && `[${id}]`} ElasticSearch에 데이터를 저장하는데 실패했습니다.`;
-    super({
-      code: 3001,
-      message,
-      status: HttpStatus.INTERNAL_SERVER_ERROR,
-    });
+  constructor(id?: number, error?: Error) {
+    const message = `${id && `[${id}]`} ElasticSearch 데이터를 저장하는데 실패했습니다.`;
+    super(
+      {
+        code: 3001,
+        message,
+        status: HttpStatus.INTERNAL_SERVER_ERROR,
+      },
+      error,
+    );
   }
 }

backend/src/storage/exception/CloudFunctionsFetchException.ts

@@ -3,10 +3,13 @@ import { HttpStatus } from '@nestjs/common';
 
 export class CloudFunctionsFetchException extends BaseException {
   constructor(error: Error) {
-    super({
-      code: 711,
-      message: `Cloud function 과 Fetch 중 오류가 발생했습니다. : ${error.message}`,
-      status: HttpStatus.INTERNAL_SERVER_ERROR,
-    });
+    super(
+      {
+        code: 711,
+        message: `Cloud function 통신 중 오류가 발생했습니다.`,
+        status: HttpStatus.INTERNAL_SERVER_ERROR,
+      },
+      error,
+    );
   }
 }