Merge pull request #11 from DouglasNeuroInformatics/dev

add functions

Author: joshunrau

package.json

@@ -44,6 +44,7 @@
   "dependencies": {
     "clean-stack": "^5.2.0",
     "extract-stack": "^3.0.0",
+    "serialize-error": "^12.0.0",
     "stringify-object": "^5.0.0",
     "type-fest": "^4.34.1"
   },

pnpm-lock.yaml

@@ -1,7 +1,15 @@
 import type { Simplify } from 'type-fest';
 import { describe, expect, expectTypeOf, it, test } from 'vitest';
 
-import { BaseException, ExceptionBuilder, OutOfRangeException, ValueException } from '../exception.js';
+import {
+  BaseException,
+  errorToJSON,
+  ExceptionBuilder,
+  OutOfRangeException,
+  parseStack,
+  RuntimeException,
+  ValueException
+} from '../exception.js';
 import { Err } from '../vendor/neverthrow.js';
 
 import type { ExceptionConstructor } from '../exception.js';
@@ -189,3 +197,36 @@ describe('OutOfRangeException', () => {
     });
   });
 });
+
+describe('parseStack', () => {
+  it('should return the same value, in terms of value, whether called with an error or a string', () => {
+    const error = new Error();
+    const r1 = parseStack(error);
+    const r2 = parseStack(error.stack);
+    expect(r1).toStrictEqual(r2);
+  });
+});
+
+describe('errorToJSON', () => {
+  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: {
+          foo: true
+        },
+        message: 'Something else went wrong',
+        name: 'RuntimeException',
+        stack: expect.toSatisfy((arg) => Array.isArray(arg) && arg.every((item) => typeof item === 'string'))
+      },
+      message: 'Something went wrong',
+      name: 'Error',
+      stack: expect.toSatisfy((arg) => Array.isArray(arg) && arg.every((item) => typeof item === 'string'))
+    });
+  });
+});

src/__tests__/exception.test.ts

@@ -4,6 +4,7 @@
 
 import cleanStack from 'clean-stack';
 import extractStack from 'extract-stack';
+import { isErrorLike, serializeError } from 'serialize-error';
 import stringifyObject from 'stringify-object';
 import type { IsNever, RequiredKeysOf } from 'type-fest';
 import type { z } from 'zod';
@@ -63,8 +64,23 @@ interface ExceptionLike extends Error, ExceptionOptions {
   toString(): string;
 }
 
-function parseStack(error: Error): string[] {
-  return extractStack.lines(cleanStack(error.stack, { pretty: true }));
+function parseStack(stack: string | undefined): string[];
+function parseStack(error: Error): string[];
+function parseStack(errorOrStack: Error | string | undefined): string[] {
+  const stack = typeof errorOrStack === 'string' ? errorOrStack : errorOrStack?.stack;
+  return extractStack.lines(cleanStack(stack, { pretty: true }));
+}
+
+function errorToJSON(error: Error): string {
+  const serialize = (error: Error): { [key: string]: unknown } => {
+    const { cause, stack, ...serialized } = serializeError(error);
+    return {
+      ...serialized,
+      cause: isErrorLike(cause) ? serialize(cause) : cause,
+      stack: parseStack(stack)
+    };
+  };
+  return JSON.stringify(serialize(error), null, 2);
 }
 
 abstract class BaseException<TParams extends ExceptionParams, TOptions extends ExceptionOptions>
@@ -228,4 +244,14 @@ export type {
   ExceptionStatic,
   ExceptionType
 };
-export { BaseException, ExceptionBuilder, OutOfRangeException, parseStack, RuntimeException, ValueException };
+
+export {
+  BaseException,
+  errorToJSON,
+  ExceptionBuilder,
+  OutOfRangeException,
+  parseStack,
+  RuntimeException,
+  serializeError,
+  ValueException
+};