@heyramzi/utils 1.12.0 → 1.13.0

package/src/errors/sentry/sveltekit.ts

@@ -16,7 +16,7 @@ export type CaughtInput = {
 type BaseOptions<R> = {
   /** Public client key on the browser, private on the server. Empty or missing sends nothing. */
   dsn: string | undefined;
-  /** `dev` from `$app/env`. Reports nothing while true. */
+  /** `dev` from `$app/env`. Reports nothing while true, and answers a crash with its real message and stack. */
   dev: boolean;
   /** `version` from `$app/env`. Set `kit.version.name` to the commit SHA so a fix is traceable. */
   release: string | undefined;
@@ -109,6 +109,34 @@ function toError(raw: unknown): unknown {
   return typeof message === "string" ? new Error(message) : raw;
 }
 
+/** What the dev-only "Error details" block on an error page shows. */
+export type DevErrorDetails = { message: string; stack?: string };
+
+const STACK_LINES = 8;
+
+/** The real message and first stack frames, for dev only: kit answers a crash with "Internal Error". */
+export function devErrorDetails(error: unknown): DevErrorDetails {
+  // A framework error is a plain { status, message }: a stack made for it would point here.
+  if (!(error instanceof Error)) {
+    const message = (error as { message?: unknown } | null)?.message;
+    if (typeof message === "string") return { message };
+    try {
+      return { message: typeof error === "object" ? JSON.stringify(error) : String(error) };
+    } catch {
+      return { message: String(error) };
+    }
+  }
+  // WHY strip the header: V8 starts the stack with "Name: message", which the block already shows.
+  const header = String(error);
+  const stack = error.stack?.startsWith(header) ? error.stack.slice(header.length) : error.stack;
+  const frames = stack
+    ?.split("\n")
+    .map((line) => line.trim())
+    .filter(Boolean)
+    .slice(0, STACK_LINES);
+  return { message: error.message, stack: frames?.length ? frames.join("\n") : undefined };
+}
+
 function isLocalHost(input: CaughtInput): boolean {
   return LOCAL_HOSTS.has(input.event.url.hostname);
 }
@@ -142,13 +170,23 @@ async function respondTo<R>(options: BaseOptions<R>, input: CaughtInput): Promis
   }
 }
 
+/** The app's answer, with the real message and stack laid over it in dev for an error we'd report. */
+async function answer<R>(
+  options: BaseOptions<R>,
+  input: CaughtInput,
+): Promise<R | DevErrorDetails | undefined> {
+  const body = await respondTo(options, input);
+  if (!options.dev || !shouldReport(input)) return body;
+  return { ...body, ...devErrorDetails(input.error) };
+}
+
 /**
  * `handleError` for `hooks.client.ts`. A stale-chunk error reloads the page once instead
  * of reporting. Everything else that's ours goes to Sentry, tagged with the environment
  * and release.
  */
 export function createHandleClientError<R = undefined>(options: ClientErrorOptions<R>) {
-  return async (input: CaughtInput): Promise<R | undefined> => {
+  return async (input: CaughtInput): Promise<R | DevErrorDetails | undefined> => {
     try {
       let tags: Record<string, SentryScalar> | undefined;
       if (isStaleChunk(input.error)) {
@@ -163,7 +201,7 @@ export function createHandleClientError<R = undefined>(options: ClientErrorOptio
     } catch (err) {
       console.error("[handleError] reporting failed:", err);
     }
-    return respondTo(options, input);
+    return answer(options, input);
   };
 }
 
@@ -173,7 +211,7 @@ export function createHandleClientError<R = undefined>(options: ClientErrorOptio
  * in the event (see `buildErrorRequest`).
  */
 export function createHandleServerError<R = undefined>(options: ServerErrorOptions<R>) {
-  return async (input: CaughtInput): Promise<R | undefined> => {
+  return async (input: CaughtInput): Promise<R | DevErrorDetails | undefined> => {
     try {
       if (shouldReport(input)) {
         // WHY the error itself, not its stack: Node and workerd print `cause` for an Error.
@@ -183,6 +221,6 @@ export function createHandleServerError<R = undefined>(options: ServerErrorOptio
     } catch (err) {
       console.error("[handleError] reporting failed:", err);
     }
-    return respondTo(options, input);
+    return answer(options, input);
   };
 }