chore: added error details and stack to unexpected error message

Author: aryanjassal

src/errors.ts

@@ -80,7 +80,7 @@ class ErrorPolykeyCLIAsynchronousDeadlock<T> extends ErrorPolykeyCLI<T> {
  * If these exceptions occur, there is a bug. Most likely in Polykey.
  */
 class ErrorPolykeyCLIUnexpectedError<T> extends ErrorPolykeyCLI<T> {
-  static description = 'Unexpected error';
+  static description = 'An unexpected error occured';
   exitCode = sysexits.SOFTWARE;
 }
 

src/polykey.ts

@@ -76,7 +76,7 @@ async function polykeyAgentMain(): Promise<number> {
     } else {
       // Unknown error, this should not happen
       const wrappedError = new binErrors.ErrorPolykeyCLIUnexpectedError(
-        'An unexpected error occurred',
+        binUtils.composeErrorMessage(e),
         { cause: e },
       );
       process.stderr.write(
@@ -222,7 +222,7 @@ async function polykeyMain(argv: Array<string>): Promise<number> {
     } else {
       // Unknown error, this should not happen
       const wrappedError = new binErrors.ErrorPolykeyCLIUnexpectedError(
-        'An unexpected error occurred',
+        binUtils.composeErrorMessage(e),
         { cause: e },
       );
       process.stderr.write(

src/utils/utils.ts

@@ -446,10 +446,13 @@ function outputFormatterError(err: any): string {
         for (const [key, value] of Object.entries(err.metadata)) {
           output += `${indent}${key}\t${value}\n`;
         }
+        output += `${indent}timestamp\t${err.timestamp}\n`;
       } else {
         output += '\n';
       }
-      output += `${indent}timestamp\t${err.timestamp}\n`;
+      if (err.stack) {
+        output += `${indent}stack: ${JSON.stringify(err.stack)}\n`;
+      }
       output += `${indent}cause: `;
       err = err.cause;
     } else if (err instanceof ErrorPolykey) {
@@ -483,44 +486,7 @@ function outputFormatterError(err: any): string {
         break;
       }
     } else {
-      let errorName = '';
-      switch (typeof err) {
-        case 'boolean':
-        case 'number':
-        case 'string':
-        case 'bigint':
-        case 'symbol':
-          errorName = `Literal: ${String(err)}`;
-          break;
-        case 'object':
-          if (err == null) break;
-          if ('name' in err && typeof err.name === 'string') {
-            errorName = err.name;
-            break;
-          }
-          if (err.constructor?.name != null) {
-            if (err.constructor.name === 'Object') {
-              // If the constructor name is Object, then the error is a JSON
-              // object.
-              errorName = `Object: ${JSON.stringify(err)}`;
-            } else {
-              // Otherwise, it is a regular object.
-              errorName = `Object: ${err.constructor.name}`;
-            }
-            break;
-          }
-          break;
-      }
-      if (errorName === '') {
-        try {
-          errorName = `Value: ${err}`;
-        } catch (e) {
-          if (e instanceof TypeError) errorName = 'Value: null';
-          else throw e;
-        }
-      }
-
-      output += errorName;
+      output += composeErrorMessage(err);
       if (err.message && err.message !== '') {
         output += `: ${err.message}`;
       }
@@ -532,6 +498,39 @@ function outputFormatterError(err: any): string {
   return output;
 }
 
+function composeErrorMessage(error: any) {
+  switch (typeof error) {
+    case 'boolean':
+    case 'number':
+    case 'string':
+    case 'bigint':
+    case 'symbol':
+      return `Thrown non-error literal '${String(error)}'`;
+    case 'object':
+      if (error == null) break;
+      if ('name' in error && typeof error.name === 'string') {
+        return `Thrown non-error '${error.name}'`;
+      }
+      if (error.constructor?.name != null) {
+        if (error.constructor.name === 'Object') {
+          // If the constructor name is Object, then the error is a JSON
+          // object.
+          return `Thrown non-error JSON '${JSON.stringify(error)}'`;
+        } else {
+          // Otherwise, it is a regular object.
+          return `Thrown non-error object '${error.constructor.name}'`;
+        }
+      }
+      break;
+  }
+  try {
+    return `Thrown non-error value '${error}'`;
+  } catch (e) {
+    if (e instanceof TypeError) return `Thrown non-error value 'null'`;
+    else throw e;
+  }
+}
+
 /**
  * CLI Authentication Retry Loop
  * Retries unary calls on attended authentication errors
@@ -633,6 +632,7 @@ export {
   outputFormatterDict,
   outputFormatterJson,
   outputFormatterError,
+  composeErrorMessage,
   retryAuthentication,
   remoteErrorCause,
   encodeEscapedWrapped,