Misc fixes to error logging (#834)

Remove next-logger and register console loggers directly in registerLoggers function
Fix messageKey for log messages
Fix errorKey to serialize errors correctly
Rename all "cause" fields to "error" so that we can serialize backend errors correctly
Add logs to listAllDomains for errors
Add request URL to RequestError (and update tests)

Author: adhityamamallan

next-logger.config.js

@@ -3,7 +3,7 @@
   "version": "4.0.0",
   "private": true,
   "scripts": {
-    "dev": "next dev -p ${CADENCE_WEB_PORT} | pino-pretty",
+    "dev": "next dev -p ${CADENCE_WEB_PORT} | pino-pretty --messageKey message",
     "build": "NODE_ENV=production && next build",
     "start": "next start -p ${CADENCE_WEB_PORT}",
     "lint": "next lint",
@@ -34,7 +34,6 @@
     "lodash": "^4.17.21",
     "lossless-json": "^4.0.2",
     "next": "14.2.16",
-    "next-logger": "^5.0.0",
     "pino": "^9.3.2",
     "query-string": "^9.0.0",
     "react": "^18.2.0",

package-lock.json

@@ -13,7 +13,7 @@ export async function register() {
       // by "Cannot set property message of [object Object] which has only a getter"
       logger.error({
         message: 'Failed to load configs',
-        cause: String(e),
+        error: e,
       });
       process.exit(1); // use process.exit to exit without an extra error log from instrumentation
     }

package.json

@@ -45,7 +45,7 @@ export async function cancelWorkflow(
     return NextResponse.json({} satisfies CancelWorkflowResponse);
   } catch (e) {
     logger.error<RouteHandlerErrorPayload>(
-      { requestParams: decodedParams, cause: e },
+      { requestParams: decodedParams, error: e },
       'Error cancelling workflow'
     );
 

src/instrumentation.ts

@@ -47,7 +47,7 @@ export async function describeCluster(
     return NextResponse.json(sanitizedRes);
   } catch (e) {
     logger.error<RouteHandlerErrorPayload>(
-      { requestParams: decodedParams, cause: e },
+      { requestParams: decodedParams, error: e },
       'Error fetching cluster info'
     );
 

src/route-handlers/cancel-workflow/cancel-workflow.ts

@@ -25,7 +25,7 @@ export async function describeDomain(
     return NextResponse.json(res.domain);
   } catch (e) {
     logger.error<RouteHandlerErrorPayload>(
-      { requestParams: decodedParams, cause: e },
+      { requestParams: decodedParams, error: e },
       'Error fetching domain info'
     );
 

src/route-handlers/describe-cluster/describe-cluster.ts

@@ -46,7 +46,7 @@ export async function describeTaskList(
     return NextResponse.json({ taskList });
   } catch (e) {
     logger.error<RouteHandlerErrorPayload>(
-      { requestParams: decodedParams, cause: e },
+      { requestParams: decodedParams, error: e },
       'Error fetching task list'
     );
 

src/route-handlers/describe-domain/describe-domain.ts

@@ -140,7 +140,7 @@ export default async function describeWorkflow(
         );
       } else {
         logger.error<RouteHandlerErrorPayload>(
-          { requestParams: decodedParams, cause: e },
+          { requestParams: decodedParams, error: e },
           'Error fetching workflow execution info'
         );
 

src/route-handlers/describe-task-list/describe-task-list.ts

@@ -44,7 +44,7 @@ export default async function fetchWorkflowQueryTypes(
     }
 
     logger.error<RouteHandlerErrorPayload>(
-      { requestParams: decodedParams, cause: e },
+      { requestParams: decodedParams, error: e },
       'Error querying workflow for query types'
     );