feat(logging): apply log masks to http exception body

algoan · Nov 28, 2023 · a3abe51 · a3abe51
1 parent c75572a
commit a3abe51
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 2 deletions.
diff --git a/packages/logging-interceptor/src/logging.interceptor.ts b/packages/logging-interceptor/src/logging.interceptor.ts
@@ -131,12 +131,17 @@ export class LoggingInterceptor implements NestInterceptor {
       const ctx: string = `${this.userPrefix}${this.ctxPrefix} - ${statusCode} - ${method} - ${url}`;
       const message: string = `Outgoing response - ${statusCode} - ${method} - ${url}`;
 
+      const options: LogOptions | undefined = Reflect.getMetadata(METHOD_LOG_METADATA, context.getHandler());
+
+      // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+      const maskedBody = options?.mask?.request ? this.maskData(body, options.mask.request) : body;
+
       if (statusCode >= HttpStatus.INTERNAL_SERVER_ERROR) {
         this.logger.error(
           {
             method,
             url,
-            body,
+            body: maskedBody,
             message,
             error,
           },
@@ -149,7 +154,7 @@ export class LoggingInterceptor implements NestInterceptor {
             method,
             url,
             error,
-            body,
+            body: maskedBody,
             message,
           },
           ctx,

diff --git a/packages/logging-interceptor/test/logging.interceptor.test.ts b/packages/logging-interceptor/test/logging.interceptor.test.ts
@@ -366,5 +366,35 @@ describe('Logging interceptor', () => {
 
       interceptor.setMaskingPlaceholder(placeholder);
     });
+
+    it('should mask http exception response', async () => {
+      const logSpy: jest.SpyInstance = jest.spyOn(Logger.prototype, 'log');
+      const url: string = `/cats`;
+
+      await request(app.getHttpServer())
+        .post(url)
+        .send({
+          name: 'dog',
+          birthdate: '1980-01-01',
+        })
+        .expect(HttpStatus.BAD_REQUEST);
+
+      const ctx: string = `LoggingInterceptor - POST - ${url}`;
+      const incomingMsg: string = `Incoming request - POST - ${url}`;
+
+      expect(logSpy).toBeCalledTimes(1);
+      expect(logSpy.mock.calls[0]).toEqual([
+        {
+          body: {
+            name: 'dog',
+            birthdate: placeholder,
+          },
+          headers: expect.any(Object),
+          message: incomingMsg,
+          method: `POST`,
+        },
+        ctx,
+      ]);
+    });
   });
 });
diff --git a/packages/logging-interceptor/test/test-app/cats/cats.controller.ts b/packages/logging-interceptor/test/test-app/cats/cats.controller.ts
@@ -41,6 +41,10 @@ export class CatsController {
     },
   })
   public createCat(@Body() payload: CreateCatDto) {
+    if (payload.name === 'dog') {
+      throw new BadRequestException({ message: 'You cannot name a cat dog' });
+    }
+
     return { id: 1, ...payload };
   }