improve error report

effect-ts-app · Oct 18, 2024 · 4a814f5 · 4a814f5
1 parent 5b3e01d
commit 4a814f5
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 51 deletions.
diff --git a/.changeset/tender-deers-shout.md b/.changeset/tender-deers-shout.md
@@ -0,0 +1,8 @@
+---
+"@effect-app/infra-adapters": patch
+"effect-app": patch
+"@effect-app/infra": patch
+"@effect-app/vue": patch
+---
+
+improve error report
diff --git a/packages/infra-adapters/src/ServiceBus.ts b/packages/infra-adapters/src/ServiceBus.ts
@@ -101,7 +101,7 @@ export function subscribe<RMsg, RErr>(hndlr: MessageHandlers<RMsg, RErr>, sessio
             if (Exit.isSuccess(exit)) {
               resolve(exit.value)
             } else {
-              reject(Cause.pretty(exit.cause))
+              reject(Cause.pretty(exit.cause, { renderErrorCause: true }))
             }
           })
       )

diff --git a/packages/infra/src/errorReporter.ts b/packages/infra/src/errorReporter.ts
@@ -1,32 +1,15 @@
 import { dropUndefined } from "@effect-app/core/utils"
 import * as Sentry from "@sentry/node"
 import { Cause, Effect, Option } from "effect-app"
-import { annotateSpanWithError, CauseException, ErrorReported } from "./errors.js"
+import { CauseException, ErrorReported, tryToJson } from "./errors.js"
 import { InfraLogger } from "./logger.js"
 import { RequestContextContainer } from "./services/RequestContextContainer.js"
 
-const tryToJson = <T>(error: CauseException<T>) => {
-  try {
-    return error.toJSON()
-  } catch {
-    try {
-      return error.toString()
-    } catch (err) {
-      try {
-        return `Failed to convert error: ${err}`
-      } catch {
-        return `Failed to convert error: unknown failure`
-      }
-    }
-  }
-}
-
 export function reportError(
   name: string
 ) {
   return (cause: Cause<unknown>, extras?: Record<string, unknown>) =>
     Effect.gen(function*() {
-      yield* annotateSpanWithError(cause, name)
       if (Cause.isInterrupted(cause)) {
         yield* InfraLogger.logDebug("Interrupted").pipe(Effect.annotateLogs("extras", JSON.stringify(extras ?? {})))
         return
@@ -39,7 +22,7 @@ export function reportError(
         .pipe(
           Effect.annotateLogs(dropUndefined({
             extras,
-            __cause__: tryToJson(error),
+            cause: tryToJson(error),
             __error_name__: name
           })),
           Effect.catchAllCause((cause) => InfraLogger.logError("Failed to log error", cause)),
@@ -61,6 +44,7 @@ function reportSentry(
     if (context) scope.setContext("context", context as unknown as Record<string, unknown>)
     if (extras) scope.setContext("extras", extras)
     scope.setContext("error", tryToJson(error) as any)
+    scope.setContext("cause", tryToJson(error.originalCause) as any)
     Sentry.captureException(error, scope)
   }))
 }
@@ -74,13 +58,12 @@ export function logError<E>(
         yield* InfraLogger.logDebug("Interrupted").pipe(Effect.annotateLogs(dropUndefined({ extras })))
         return
       }
-      const error = new CauseException(cause, name)
       yield* InfraLogger
         .logWarning("Logging error", cause)
         .pipe(
           Effect.annotateLogs(dropUndefined({
             extras,
-            __cause__: tryToJson(error),
+            cause: tryToJson(cause),
             __error_name__: name
           })),
           Effect.catchAllCause((cause) => InfraLogger.logError("Failed to log error", cause)),

diff --git a/packages/infra/src/logger/jsonLogger.ts b/packages/infra/src/logger/jsonLogger.ts
@@ -14,7 +14,7 @@ export const jsonLogger = Logger.make<unknown, void>(
       fiber: FiberId.threadName(fiberId),
       message,
       request: Option.getOrUndefined(c),
-      cause: cause != null && cause != Cause.empty ? Cause.pretty(cause) : undefined,
+      cause: cause !== null && cause !== Cause.empty ? Cause.pretty(cause, { renderErrorCause: true }) : undefined,
       spans: List.map(spans, (_) => ({ label: _.label, timing: nowMillis - _.startTime })).pipe(List.toArray),
       annotations: HashMap.size(annotations) > 0
         ? [...annotations].reduce((prev, [k, v]) => {

diff --git a/packages/prelude/src/client/errors.ts b/packages/prelude/src/client/errors.ts
@@ -1,6 +1,22 @@
 import { TaggedError } from "effect-app/schema"
 import { makeFiberFailure } from "effect/Runtime"
-import { Cause, Effect, Predicate, S } from "../lib.js"
+import { Cause, S } from "../lib.js"
+
+export const tryToJson = (error: { toJSON(): unknown; toString(): string }) => {
+  try {
+    return error.toJSON()
+  } catch {
+    try {
+      return error.toString()
+    } catch (err) {
+      try {
+        return `Failed to convert error: ${err}`
+      } catch {
+        return `Failed to convert error: unknown failure`
+      }
+    }
+  }
+}
 
 // eslint-disable-next-line unused-imports/no-unused-vars
 // @ts-expect-error type not used
@@ -149,30 +165,16 @@ export class CauseException<E> extends Error {
     return {
       _tag: this._tag,
       name: this.name,
-      message: this.message,
-      pretty: this.toString(),
-      cause: this.originalCause.toJSON()
+      message: this.message
     }
   }
 
   [Symbol.for("nodejs.util.inspect.custom")]() {
     return this.toJSON()
   }
   override toString() {
-    return `[${this._tag}] ` + Cause.pretty(this.originalCause)
+    return `[${this._tag}] ` + Cause.pretty(this.originalCause, { renderErrorCause: true })
   }
 
   [ErrorReported] = false
 }
-
-export const annotateSpanWithError = (cause: Cause<unknown>, name?: string) =>
-  Effect.annotateCurrentSpan({
-    "exception.escaped": true,
-    "exception.message": "Reported error for " + (name ?? cause._tag),
-    "exception.stacktrace": Cause.pretty(cause),
-    "exception.type": Cause.squashWith(
-      cause,
-      (_) => Predicate.hasProperty(_, "_tag") ? _._tag : Predicate.hasProperty(_, "name") ? _.name : `${_}`
-    ),
-    "error.type": cause._tag
-  })
diff --git a/packages/vue/src/errorReporter.ts b/packages/vue/src/errorReporter.ts
@@ -2,15 +2,14 @@
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 import { dropUndefined } from "@effect-app/core/utils"
 import * as Sentry from "@sentry/browser"
-import { Cause, Effect } from "effect"
-import { annotateSpanWithError, CauseException, ErrorReported } from "effect-app/client/errors"
+import { Cause, Effect } from "effect-app"
+import { CauseException, ErrorReported, tryToJson } from "effect-app/client/errors"
 
 export function reportError(
   name: string
 ) {
   return (cause: Cause.Cause<unknown>, extras?: Record<string, unknown>) =>
     Effect.gen(function*() {
-      yield* annotateSpanWithError(cause, name)
       if (Cause.isInterrupted(cause)) {
         yield* Effect.logDebug("Interrupted").pipe(Effect.annotateLogs("extras", JSON.stringify(extras ?? {})))
         return Cause.squash(cause)
@@ -22,7 +21,7 @@ export function reportError(
         .logError("Reporting error", cause)
         .pipe(Effect.annotateLogs(dropUndefined({
           extras,
-          __cause__: error.toJSON(),
+          cause: tryToJson(cause),
           __error_name__: name
         })))
 
@@ -38,7 +37,8 @@ function reportSentry(
   return Effect.sync(() => {
     const scope = new Sentry.Scope()
     if (extras) scope.setContext("extras", extras)
-    scope.setContext("error", error.toJSON() as any)
+    scope.setContext("error", tryToJson(error) as any)
+    scope.setContext("cause", tryToJson(error.originalCause) as any)
     Sentry.captureException(error, scope)
   })
 }
@@ -52,14 +52,15 @@ export function logError<E>(
         yield* Effect.logDebug("Interrupted").pipe(Effect.annotateLogs(dropUndefined({ extras })))
         return
       }
-      const error = new CauseException(cause, name)
       yield* Effect
         .logWarning("Logging error", cause)
-        .pipe(Effect.annotateLogs(dropUndefined({
-          extras,
-          __cause__: error.toJSON(),
-          __error_name__: name
-        })))
+        .pipe(
+          Effect.annotateLogs(dropUndefined({
+            extras,
+            cause: tryToJson(cause),
+            __error_name__: name
+          }))
+        )
     })
 }