improve formatting of Runtime failures (#2461)

Author: tim-smart

.changeset/little-seahorses-lie.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+add Inspectable.toStringUnknown/stringifyCircular

.changeset/mean-nails-divide.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+improve formatting of Runtime failures

.changeset/smooth-turtles-grin.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+use Inspectable.toStringUnknown for absurd runtime errors

packages/effect/src/Inspectable.ts

@@ -82,3 +82,33 @@ export abstract class Class {
     return format(this.toJSON())
   }
 }
+
+/**
+ * @since 2.0.0
+ */
+export const toStringUnknown = (u: unknown, whitespace: number | string | undefined = 2): string => {
+  try {
+    return typeof u === "object" ? stringifyCircular(u, whitespace) : String(u)
+  } catch (_) {
+    return String(u)
+  }
+}
+
+/**
+ * @since 2.0.0
+ */
+export const stringifyCircular = (obj: unknown, whitespace?: number | string | undefined): string => {
+  let cache: Array<unknown> = []
+  const retVal = JSON.stringify(
+    obj,
+    (_key, value) =>
+      typeof value === "object" && value !== null
+        ? cache.includes(value)
+          ? undefined // circular reference
+          : cache.push(value) && value
+        : value,
+    whitespace
+  )
+  ;(cache as any) = undefined
+  return retVal
+}

packages/effect/src/internal/fiberRuntime.ts

@@ -22,6 +22,7 @@ import { dual, identity, pipe } from "../Function.js"
 import { globalValue } from "../GlobalValue.js"
 import * as HashMap from "../HashMap.js"
 import * as HashSet from "../HashSet.js"
+import * as Inspectable from "../Inspectable.js"
 import type { Logger } from "../Logger.js"
 import * as LogLevel from "../LogLevel.js"
 import type * as MetricLabel from "../MetricLabel.js"
@@ -125,7 +126,9 @@ const runtimeFiberVariance = {
 
 const absurd = (_: never): never => {
   throw new Error(
-    `BUG: FiberRuntime - ${JSON.stringify(_)} - please report an issue at https://github.com/Effect-TS/effect/issues`
+    `BUG: FiberRuntime - ${
+      Inspectable.toStringUnknown(_)
+    } - please report an issue at https://github.com/Effect-TS/effect/issues`
   )
 }
 
@@ -1419,7 +1422,7 @@ export const tracerLogger = globalValue(
         return
       }
 
-      const attributes = Object.fromEntries(HashMap.map(annotations, (value) => internalLogger.serializeUnknown(value)))
+      const attributes = Object.fromEntries(HashMap.map(annotations, Inspectable.toStringUnknown))
       attributes["effect.fiberId"] = FiberId.threadName(fiberId)
       attributes["effect.logLevel"] = logLevel.label
 

packages/effect/src/internal/logger.ts

@@ -1,6 +1,7 @@
 import type { LazyArg } from "../Function.js"
 import { constVoid, dual, pipe } from "../Function.js"
 import * as HashMap from "../HashMap.js"
+import * as Inspectable from "../Inspectable.js"
 import * as List from "../List.js"
 import type * as Logger from "../Logger.js"
 import type * as LogLevel from "../LogLevel.js"
@@ -167,7 +168,7 @@ export const stringLogger: Logger.Logger<unknown, string> = makeLogger<unknown,
     ]
 
     let output = outputArray.join(" ")
-    const stringMessage = serializeUnknown(message)
+    const stringMessage = Inspectable.toStringUnknown(message)
 
     if (stringMessage.length > 0) {
       output = output + " message="
@@ -205,22 +206,14 @@ export const stringLogger: Logger.Logger<unknown, string> = makeLogger<unknown,
         }
         output = output + filterKeyName(key)
         output = output + "="
-        output = appendQuoted(serializeUnknown(value), output)
+        output = appendQuoted(Inspectable.toStringUnknown(value), output)
       }
     }
 
     return output
   }
 )
 
-export const serializeUnknown = (u: unknown): string => {
-  try {
-    return typeof u === "object" ? jsonStringifyCircular(u) : String(u)
-  } catch (_) {
-    return String(u)
-  }
-}
-
 /** @internal */
 const escapeDoubleQuotes = (str: string) => `"${str.replace(/\\([\s\S])|(")/g, "\\$1$2")}"`
 
@@ -242,7 +235,7 @@ export const logfmtLogger = makeLogger<unknown, string>(
     ]
 
     let output = outputArray.join(" ")
-    const stringMessage = serializeUnknown(message)
+    const stringMessage = Inspectable.toStringUnknown(message, 0)
 
     if (stringMessage.length > 0) {
       output = output + " message="
@@ -280,7 +273,7 @@ export const logfmtLogger = makeLogger<unknown, string>(
         }
         output = output + filterKeyName(key)
         output = output + "="
-        output = appendQuotedLogfmt(serializeUnknown(value), output)
+        output = appendQuotedLogfmt(Inspectable.toStringUnknown(value, 0), output)
       }
     }
 
@@ -340,23 +333,8 @@ export const structuredMessage = (u: unknown): unknown => {
   }
 }
 
-const jsonStringifyCircular = (obj: unknown) => {
-  let cache: Array<unknown> = []
-  const retVal = JSON.stringify(
-    obj,
-    (_key, value) =>
-      typeof value === "object" && value !== null
-        ? cache.includes(value)
-          ? undefined // circular reference
-          : cache.push(value) && value
-        : value
-  )
-  ;(cache as any) = undefined
-  return retVal
-}
-
 /** @internal */
-export const jsonLogger = map(structuredLogger, jsonStringifyCircular)
+export const jsonLogger = map(structuredLogger, Inspectable.stringifyCircular)
 
 /** @internal */
 const filterKeyName = (key: string) => key.replace(/[\s="]/g, "_")

packages/effect/src/internal/runtime.ts

@@ -8,7 +8,7 @@ import * as FiberId from "../FiberId.js"
 import type * as FiberRef from "../FiberRef.js"
 import * as FiberRefs from "../FiberRefs.js"
 import { dual, pipe } from "../Function.js"
-import { format, NodeInspectSymbol } from "../Inspectable.js"
+import * as Inspectable from "../Inspectable.js"
 import * as Option from "../Option.js"
 import { pipeArguments } from "../Pipeable.js"
 import * as Predicate from "../Predicate.js"
@@ -131,38 +131,22 @@ export const unsafeRunSync = <R>(runtime: Runtime.Runtime<R>) => <A, E>(effect:
   }
 }
 
+class AsyncFiberExceptionImpl<A, E = never> extends Error implements Runtime.AsyncFiberException<A, E> {
+  readonly _tag = "AsyncFiberException"
+  constructor(readonly fiber: Fiber.RuntimeFiber<A, E>) {
+    super(
+      `Fiber #${fiber.id().id} cannot be be resolved synchronously, this is caused by using runSync on an effect that performs async work`
+    )
+    this.name = this._tag
+    this.stack = this.message
+  }
+}
+
 const asyncFiberException = <A, E>(fiber: Fiber.RuntimeFiber<A, E>): Runtime.AsyncFiberException<A, E> => {
   const limit = Error.stackTraceLimit
   Error.stackTraceLimit = 0
-  const error = (new Error()) as any
+  const error = new AsyncFiberExceptionImpl(fiber)
   Error.stackTraceLimit = limit
-  const message =
-    `Fiber #${fiber.id().id} cannot be be resolved synchronously, this is caused by using runSync on an effect that performs async work`
-  const _tag = "AsyncFiberException"
-  Object.defineProperties(error, {
-    _tag: {
-      value: _tag
-    },
-    fiber: {
-      value: fiber
-    },
-    message: {
-      value: message
-    },
-    name: {
-      value: _tag
-    },
-    toString: {
-      get() {
-        return () => message
-      }
-    },
-    [NodeInspectSymbol]: {
-      get() {
-        return () => message
-      }
-    }
-  })
   return error
 }
 
@@ -177,37 +161,46 @@ export const FiberFailureCauseId: Runtime.FiberFailureCauseId = Symbol.for(
   "effect/Runtime/FiberFailure/Cause"
 ) as any
 
-type Mutable<A> = {
-  -readonly [k in keyof A]: A[k]
-}
+class FiberFailureImpl extends Error implements Runtime.FiberFailure {
+  readonly [FiberFailureId]: Runtime.FiberFailureId
+  readonly [FiberFailureCauseId]: Cause.Cause<unknown>
+  constructor(cause: Cause.Cause<unknown>) {
+    super()
+
+    this[FiberFailureId] = FiberFailureId
+    this[FiberFailureCauseId] = cause
+
+    const prettyErrors = InternalCause.prettyErrors(cause)
+    if (prettyErrors.length > 0) {
+      const head = prettyErrors[0]
+      this.name = head.message.split(":")[0]
+      this.message = head.message.substring(this.name.length + 2)
+      this.stack = InternalCause.pretty(cause)
+    }
 
-/** @internal */
-export const fiberFailure = <E>(cause: Cause.Cause<E>): Runtime.FiberFailure => {
-  const limit = Error.stackTraceLimit
-  Error.stackTraceLimit = 0
-  const error = (new Error()) as Mutable<Runtime.FiberFailure>
-  Error.stackTraceLimit = limit
-  const prettyErrors = InternalCause.prettyErrors(cause)
-  if (prettyErrors.length > 0) {
-    const head = prettyErrors[0]
-    error.name = head.message.split(":")[0]
-    error.message = head.message.substring(error.name.length + 2)
-    error.stack = InternalCause.pretty(cause)
+    this.name = `(FiberFailure) ${this.name}`
   }
-  error[FiberFailureId] = FiberFailureId
-  error[FiberFailureCauseId] = cause
-  error.toJSON = () => {
+
+  toJSON(): unknown {
     return {
       _id: "FiberFailure",
-      cause: cause.toJSON()
+      cause: this[FiberFailureCauseId].toJSON()
     }
   }
-  error.toString = () => {
-    return format(error.toJSON())
+  toString(): string {
+    return "(FiberFailure) " + InternalCause.pretty(this[FiberFailureCauseId])
   }
-  error[NodeInspectSymbol] = () => {
-    return error.toJSON()
+  [Inspectable.NodeInspectSymbol](): unknown {
+    return this.toString()
   }
+}
+
+/** @internal */
+export const fiberFailure = <E>(cause: Cause.Cause<E>): Runtime.FiberFailure => {
+  const limit = Error.stackTraceLimit
+  Error.stackTraceLimit = 0
+  const error = new FiberFailureImpl(cause)
+  Error.stackTraceLimit = limit
   return error
 }
 

packages/effect/test/Logger.test.ts

@@ -53,7 +53,9 @@ describe("stringLogger", () => {
     })
 
     expect(result).toEqual(
-      `timestamp=${date.toJSON()} level=INFO fiber= message="My message" imma_span__=7ms just_a_key=just_a_value good_key="I am a good value" good_bool=true I_am_bad_key_name="{\\"coolValue\\":\\"cool value\\"}" good_number=123`
+      `timestamp=${date.toJSON()} level=INFO fiber= message="My message" imma_span__=7ms just_a_key=just_a_value good_key="I am a good value" good_bool=true I_am_bad_key_name="{
+  \\"coolValue\\": \\"cool value\\"
+}" good_number=123`
     )
   })
 
@@ -81,7 +83,11 @@ describe("stringLogger", () => {
 
     expect(result).toEqual(
       `timestamp=${date.toJSON()} level=INFO fiber= message="My
-message" imma_span__=7ms I_am_also_a_bad_key_name="{\\"return\\":\\"cool\\nvalue\\"}" good_key="{\\"returnWithSpace\\":\\"cool\\nvalue or not\\"}" good_key2="I am a good value
+message" imma_span__=7ms I_am_also_a_bad_key_name="{
+  \\"return\\": \\"cool\\nvalue\\"
+}" good_key="{
+  \\"returnWithSpace\\": \\"cool\\nvalue or not\\"
+}" good_key2="I am a good value
 with line breaks" good_key3="I_have=a"`
     )
   })