Expose stacktraces from exceptions thrown in before/after hooks. (#6263)

.changeset/little-ads-walk.md

@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': patch
+---
+
+Made the original stacktraces for before/after hooks available on `error.extension.errors`.

packages/keystone/src/lib/core/graphql-errors.ts

@@ -7,9 +7,18 @@ export const validationFailureError = (messages: string[]) => {
   return new ApolloError(`You provided invalid data for this operation.\n${s}`);
 };
 
-export const extensionError = (extension: string, messages: string[]) => {
-  const s = messages.map(m => `  - ${m}`).join('\n');
-  return new ApolloError(`An error occured while running "${extension}".\n${s}`);
+export const extensionError = (extension: string, things: { error: Error; tag: string }[]) => {
+  const s = things.map(t => `  - ${t.tag}: ${t.error.message}`).join('\n');
+  return new ApolloError(
+    `An error occured while running "${extension}".\n${s}`,
+    'INTERNAL_SERVER_ERROR',
+    // Make the original stack traces available in non-production modes.
+    // TODO: We need to have a way to make these stack traces available
+    // for logging in production mode.
+    process.env.NODE_ENV !== 'production'
+      ? { errors: things.map(t => ({ stacktrace: t.error.stack, message: t.error.message })) }
+      : undefined
+  );
 };
 
 // FIXME: In an upcoming PR we will use these args to construct a better

packages/keystone/src/lib/core/mutations/hooks.ts

@@ -31,14 +31,13 @@ export async function runSideEffectOnlyHook<
   }
 
   // Field hooks
-  const fieldsErrors = [];
+  const fieldsErrors: { error: Error; tag: string }[] = [];
   for (const [fieldPath, field] of Object.entries(list.fields)) {
     if (shouldRunFieldLevelHook(fieldPath)) {
       try {
-        // @ts-ignore
         await field.hooks[hookName]?.({ fieldPath, ...args });
-      } catch (err) {
-        fieldsErrors.push(`${list.listKey}.${fieldPath}: ${err.message}`);
+      } catch (error) {
+        fieldsErrors.push({ error, tag: `${list.listKey}.${fieldPath}` });
       }
     }
   }
@@ -49,7 +48,7 @@ export async function runSideEffectOnlyHook<
   // List hooks
   try {
     await list.hooks[hookName]?.(args);
-  } catch (err) {
-    throw extensionError(hookName, [`${list.listKey}: ${err.message}`]);
+  } catch (error) {
+    throw extensionError(hookName, [{ error, tag: list.listKey }]);
   }
 }