fix(logger): do not overwrite ecs objects with custom data

AUT-2249

Co-authored-by: Daniel Gergacz <[email protected]>

Author: akapa

src/logger/logger.spec.ts

@@ -48,6 +48,17 @@ describe('Logger', () => {
     expect(logArguments.details).to.eql('forever');
   });
 
+  it('should not overwrite fields in ecs base log', () => {
+    logger.info('wedidit', { event: { duration: 245 }, log: { ter: 'abc' } });
+
+    const logArguments = JSON.parse(outputStub.args[0][0]);
+    expect(logArguments.event.action).to.eql('wedidit');
+    expect(logArguments.event.duration).to.eql(245);
+    expect(logArguments.log.logger).to.eql('mongo');
+    expect(logArguments.log.level).to.eql(30);
+    expect(logArguments.log.ter).to.eql('abc');
+  });
+
   it('should be callable without the data object', () => {
     logger.info('wedidit');
 
@@ -116,6 +127,23 @@ describe('Logger', () => {
     expect(logArguments.error.context).to.eql(JSON.stringify(error.data));
   });
 
+  it('should not overwrite ecs error fields with custom data', () => {
+    const error: Error & { data?: any } = new Error('failed');
+    error.data = { test: 'data' };
+
+    logger.fromError('hi', error, { error: { bajvan: true } });
+
+    const logArguments = JSON.parse(outputStub.args[0][0]);
+
+    expect(logArguments.error).to.eql({
+      type: error.name,
+      stack_trace: error.stack,
+      message: error.message,
+      context: JSON.stringify(error.data),
+      bajvan: true,
+    });
+  });
+
   it('should log error as warning with action', () => {
     const error: Error & { data?: any } = new Error('failed');
     error.data = { test: 'data' };

src/logger/logger.ts

@@ -4,6 +4,7 @@ const DATA_LIMIT = 3000;
 import { Timer } from '../timer/timer';
 import { jsonFormatter } from '../formatter/json';
 import { consoleOutput } from '../output/console';
+import { merge } from 'lodash';
 const allowedKeys = ['output', 'formatter', 'transformers', 'outputFormat'];
 
 interface ErrorWithData extends Error {
@@ -88,7 +89,7 @@ export class Logger {
   }
 
   customError(severity: string, action: string, error: Error, data: unknown = {}) {
-    this.log(severity, action, Object.assign(this.getErrorDetails(error), data));
+    this.log(severity, action, merge(this.getErrorDetails(error), data));
   }
 
   fromError(action: string, error: unknown, data: unknown = {}) {
@@ -108,7 +109,7 @@ export class Logger {
       return;
     }
 
-    let dataToLog = Object.assign(this.getBaseLogFields(level, action), data);
+    let dataToLog = merge(this.getBaseLogFields(level, action), data);
 
     Logger.config.transformers.forEach((transform) => {
       dataToLog = transform(dataToLog);
@@ -162,7 +163,7 @@ export class Logger {
       return {};
     }
 
-    return Object.assign(this.getBaseErrorDetails(error), this.getAxiosErrorDetails(error as AxiosError));
+    return merge(this.getBaseErrorDetails(error), this.getAxiosErrorDetails(error as AxiosError));
   }
 
   private getBaseErrorDetails(error: Error) {