fix: add includeStack option to errorToJSON

Author: joshunrau

src/__tests__/exception.test.ts

@@ -208,13 +208,13 @@ describe('parseStack', () => {
 });
 
 describe('errorToJSON', () => {
+  const cause = new RuntimeException('Something else went wrong', {
+    details: {
+      foo: true
+    }
+  });
+  const error = new Error('Something went wrong', { cause });
   it('should return the expected output', () => {
-    const cause = new RuntimeException('Something else went wrong', {
-      details: {
-        foo: true
-      }
-    });
-    const error = new Error('Something went wrong', { cause });
     expect(JSON.parse(errorToJSON(error))).toStrictEqual({
       cause: {
         details: {
@@ -229,4 +229,17 @@ describe('errorToJSON', () => {
       stack: expect.toSatisfy((arg) => Array.isArray(arg) && arg.every((item) => typeof item === 'string'))
     });
   });
+  it('should not include the stack, if set in the options', () => {
+    expect(JSON.parse(errorToJSON(error, { includeStack: false }))).toStrictEqual({
+      cause: {
+        details: {
+          foo: true
+        },
+        message: 'Something else went wrong',
+        name: 'RuntimeException'
+      },
+      message: 'Something went wrong',
+      name: 'Error'
+    });
+  });
 });

src/exception.ts

@@ -71,14 +71,17 @@ function parseStack(errorOrStack: Error | string | undefined): string[] {
   return extractStack.lines(cleanStack(stack, { pretty: true }));
 }
 
-function errorToJSON(error: Error): string {
+function errorToJSON(error: Error, { includeStack = true }: { includeStack?: boolean } = {}): string {
   const serialize = (error: Error): { [key: string]: unknown } => {
     const { cause, stack, ...serialized } = serializeError(error);
-    return {
+    const result: { [key: string]: unknown } = {
       ...serialized,
-      cause: isErrorLike(cause) ? serialize(cause) : cause,
-      stack: parseStack(stack)
+      cause: isErrorLike(cause) ? serialize(cause) : cause
     };
+    if (includeStack) {
+      result.stack = parseStack(stack);
+    }
+    return result;
   };
   return JSON.stringify(serialize(error), null, 2);
 }