fix(logging): use object cause in TRPCErrors so event name is logged correctly (#749)

Author: danadajian

app/backend/src/acceptVisualChanges.ts

@@ -32,15 +32,15 @@ export const acceptVisualChanges = async (
     throw new TRPCError({
       code: 'FORBIDDEN',
       message: reasonToPreventUpdate,
-      cause: 'VISUAL_CHANGE_ACCEPTANCE_BLOCKED'
+      cause: { event: 'VISUAL_CHANGE_ACCEPTANCE_BLOCKED' }
     });
   }
   const hash = commitHash ?? diffId;
   if (!hash) {
     throw new TRPCError({
       code: 'BAD_REQUEST',
       message: 'Please provide either a commitHash or a diffId.',
-      cause: 'MISSING_IDENTIFIER'
+      cause: { event: 'MISSING_IDENTIFIER' }
     });
   }
 

app/backend/src/fetchCurrentPage.ts

@@ -15,7 +15,7 @@ export const fetchCurrentPage = async ({
     throw new TRPCError({
       code: 'NOT_FOUND',
       message: `Page ${page} does not exist. Only ${paginatedKeys.length} pages were found.`,
-      cause: 'PAGE_NOT_FOUND'
+      cause: { event: 'PAGE_NOT_FOUND' }
     });
   }
   const { keys, title } = currentPage;
@@ -26,7 +26,7 @@ export const fetchCurrentPage = async ({
         throw new TRPCError({
           code: 'BAD_REQUEST',
           message: `Invalid file name: ${key}. ${result.error.message}`,
-          cause: 'INVALID_FILE_NAME'
+          cause: { event: 'INVALID_FILE_NAME' }
         });
       }
 

app/backend/src/getGroupedKeys.ts

@@ -11,7 +11,7 @@ export const getGroupedKeys = async (hash: string, bucket: string) => {
       code: 'NOT_FOUND',
       message:
         'The commit hash was not associated with any visual regression test failures.',
-      cause: 'COMMIT_HASH_NOT_FOUND'
+      cause: { event: 'COMMIT_HASH_NOT_FOUND' }
     });
   }
 
@@ -36,7 +36,7 @@ export const getGroupedKeys = async (hash: string, bucket: string) => {
       code: 'NOT_FOUND',
       message:
         'There was no new or diff images associated with the commit hash.\nThis might be because the tests failed before a screenshot could be taken and it could be compared to the base.',
-      cause: 'NO_NEW_OR_DIFF_IMAGES'
+      cause: { event: 'NO_NEW_OR_DIFF_IMAGES' }
     });
   }
 

app/backend/src/getOctokit.ts

@@ -9,7 +9,7 @@ export const getOctokit = (owner: string, repo: string) => {
     throw new TRPCError({
       code: 'UNAUTHORIZED',
       message: 'Missing secrets.json file',
-      cause: 'MISSING_SECRETS_FILE'
+      cause: { event: 'MISSING_SECRETS_FILE' }
     });
   }
   const parsedJson = JSON.parse(readFileSync(secretsFilePath).toString());
@@ -18,7 +18,7 @@ export const getOctokit = (owner: string, repo: string) => {
     throw new TRPCError({
       code: 'INTERNAL_SERVER_ERROR',
       message: `Failed to parse secrets.json: ${result.error}`,
-      cause: 'SECRETS_PARSE_ERROR'
+      cause: { event: 'SECRETS_PARSE_ERROR' }
     });
   }
   const repoSecrets = result.data[`${owner}/${repo}`];
@@ -27,7 +27,7 @@ export const getOctokit = (owner: string, repo: string) => {
     throw new TRPCError({
       code: 'UNAUTHORIZED',
       message: `Missing githubToken for repo ${owner}/${repo}`,
-      cause: 'MISSING_GITHUB_TOKEN'
+      cause: { event: 'MISSING_GITHUB_TOKEN' }
     });
   }
   return new Octokit({

app/backend/src/logger.ts

@@ -1,6 +1,6 @@
 export const logEvent = (
   level: 'INFO' | 'WARN' | 'ERROR',
-  payload: Record<string, unknown>
+  payload: { event: string } & Record<string, unknown>
 ) => {
   // eslint-disable-next-line no-console
   console.log(

app/backend/src/updateCommitStatus.ts

@@ -22,7 +22,7 @@ export const updateCommitStatus = async ({
       throw new TRPCError({
         code: 'INTERNAL_SERVER_ERROR',
         message: `Failed to update GitHub commit status: ${error}`,
-        cause: 'COMMIT_STATUS_UPDATE_FAILED'
+        cause: { event: 'COMMIT_STATUS_UPDATE_FAILED' }
       });
     });
 };

app/server.ts

@@ -14,7 +14,11 @@ const trpcHandler = createBunHttpHandler({
   endpoint: '/trpc',
   createContext,
   onError: ({ error: { code, message, cause }, path, ctx }) => {
-    logEvent('ERROR', { path, code, message, cause, ...ctx?.urlParams });
+    const causeInfo =
+      cause && 'event' in cause && typeof cause.event === 'string'
+        ? { event: cause.event }
+        : { event: 'UNKNOWN', cause: cause?.message };
+    logEvent('ERROR', { path, code, message, ...causeInfo, ...ctx?.urlParams });
   }
 });
 
@@ -39,4 +43,7 @@ const server = serve({
   }
 });
 
-logEvent('INFO', { message: `Server running at ${server.url}` });
+logEvent('INFO', {
+  event: 'STARTUP',
+  message: `Server running at ${server.url}`
+});