DIME-8714 stacktrace now contains the recursive cause in one string with truncation

Author: balint-barki-sap

package-lock.json

@@ -270,16 +270,9 @@ describe('Logger', () => {
     const logArguments = JSON.parse(outputStub.args[0][0]);
     expect(logArguments.error.type).to.eql('MainError');
     expect(logArguments.error.message).to.eql('Main error occurred');
-    expect(logArguments.error.cause).to.eql({
-      type: 'IntermediateError',
-      message: 'Intermediate error',
-      stack_trace: intermediateError.stack,
-      cause: {
-        type: 'RootCauseError',
-        message: 'Root cause error',
-        stack_trace: rootCause.stack,
-      },
-    });
+    expect(logArguments.error.stack_trace).to.eql(
+      [mainError.stack, 'Caused by: ' + intermediateError.stack, 'Caused by: ' + rootCause.stack].join('\n'),
+    );
   });
 
   describe('#customError', () => {
@@ -350,7 +343,7 @@ describe('Logger', () => {
         const logArguments = JSON.parse(outputStub.args[0][0]);
 
         expect(logArguments.error.type).to.eql(errorObject.name);
-        expect(logArguments.error.stack_trace).to.eql(errorObject.stack);
+        expect(logArguments.error.stack_trace).to.eql([errorObject.name, errorObject.stack].join('\n'));
         expect(logArguments.error.message).to.eql(errorObject.message);
         expect(logArguments.error.context).to.eql(JSON.stringify(errorObject.data));
       });

src/logger/logger.spec.ts

@@ -171,32 +171,90 @@ export class Logger {
   }
 
   private getBaseErrorDetails(error: Error) {
+    const shortenedData = this.shortenData((error as ErrorWithData).data);
+
     if (Logger.config.outputFormat === 'legacy') {
       return {
         error_name: error.name,
         error_stack: this.shortenStackTrace(error.stack || ''),
         error_message: error.message,
-        error_data: this.shortenData((error as ErrorWithData).data),
+        error_data: shortenedData,
       };
     }
 
     return {
-      error: this.extractError(error),
+      error: {
+        type: error.name,
+        message: error.message,
+        ...(shortenedData && { context: shortenedData }),
+        stack_trace: this.getShortenedStackTrace(error),
+      },
       event: {
         reason: error.message,
       },
     };
   }
 
-  private extractError(error: Error): unknown {
-    const shortenedData = this.shortenData((error as ErrorWithData).data);
-    return {
-      type: error.name,
-      message: error.message,
-      ...(shortenedData && { context: shortenedData }),
-      stack_trace: this.shortenStackTrace(error.stack || ''),
-      ...(error.cause instanceof Error && { cause: this.extractError(error.cause) }),
+  private getShortenedStackTrace(error: Error): string {
+    const getNumberOfCommonFrames = (ownTrace: string[], enclosingTrace: string[]): number => {
+      let m = ownTrace.length - 1;
+      let n = enclosingTrace.length - 1;
+
+      while (m > 0 && n > 0 && ownTrace[m] === enclosingTrace[n]) {
+        m--;
+        n--;
+      }
+      return ownTrace.length - 1 - m;
     };
+
+    const getEnclosedStackTrace = (error: Error, enclosingTrace: string[], caption: string): string[] => {
+      const output: string[] = [];
+
+      let errorName: string;
+      let errorStack: string[];
+      const errorStackLines = error.stack ? error.stack.split('\n') : [];
+      const firstLine = errorStackLines.at(0);
+
+      if (error.stack) {
+        if (firstLine?.includes(error.name)) {
+          errorName = firstLine!;
+          errorStack = errorStackLines.slice(1);
+        } else {
+          errorName = error.name;
+          errorStack = errorStackLines;
+        }
+      } else {
+        errorName = error.name;
+        errorStack = [];
+      }
+
+      const commonFrames = getNumberOfCommonFrames(errorStack, enclosingTrace);
+      const uniqueFrames = errorStack.length - commonFrames;
+
+      output.push(caption + errorName);
+      errorStack.slice(0, uniqueFrames).forEach((line) => output.push(line));
+      if (commonFrames > 0) {
+        output.push(`\t... ${commonFrames} more`);
+      }
+
+      if (error.cause instanceof Error) {
+        output.push(...getEnclosedStackTrace(error.cause, errorStackLines, 'Caused by: '));
+      }
+
+      return output;
+    };
+
+    const stackTrace = getEnclosedStackTrace(error, [], '');
+    const joinedStackTrace = stackTrace.join('\n');
+    let resultStackTraceStr: string;
+
+    if (joinedStackTrace.length > STACK_TRACE_LIMIT) {
+      resultStackTraceStr = joinedStackTrace.substring(0, STACK_TRACE_LIMIT) + ' ...';
+    } else {
+      resultStackTraceStr = joinedStackTrace;
+    }
+
+    return resultStackTraceStr;
   }
 
   private getAxiosErrorDetails(error: AxiosError) {