Allow to log errors using Roarr logger

Author: nodeexx

package-lock.json

@@ -68,6 +68,7 @@
     "posthog-js": "1.102.0",
     "posthog-node": "3.6.1",
     "roarr": "7.21.0",
+    "serialize-error": "11.0.3",
     "sveltekit-flash-message": "2.3.0",
     "sveltekit-superforms": "1.12.0",
     "zod": "3.22.4"

package.json

@@ -1,19 +1,30 @@
 import { Roarr, logLevels, type LogLevelName } from 'roarr';
 import callsites from 'callsites';
 import { config } from '$lib/server/core/config';
-import type { JsonObject, LoggerLoggingMethodName } from './types';
+import type {
+  LoggerContext,
+  LoggerContextWithError,
+  LoggerLoggingMethodName,
+} from './types';
+import { serializeError } from 'serialize-error';
 
 export const roarr = (function () {
   const createLogger = (methodName: LoggerLoggingMethodName) => {
-    return (message: string, context: JsonObject = {}) => {
+    return (message: string, context: LoggerContextWithError = {}) => {
       if (!shouldBeLogged(methodName)) {
         return;
       }
 
+      const contextClone = { ...context } as LoggerContext;
+      const errorContext = contextClone.error;
+      if (errorContext && errorContext instanceof Error) {
+        contextClone.error = serializeError(errorContext);
+      }
+
       Roarr[methodName](
         config.roarr.isDebugContextShown
-          ? enrichContextWithDebugInfo(context)
-          : context,
+          ? enrichContextWithDebugInfo(contextClone)
+          : contextClone,
         message,
       );
     };
@@ -36,7 +47,7 @@ export const roarr = (function () {
     },
     {} as Record<
       LoggerLoggingMethodName,
-      (message: string, context?: JsonObject) => void
+      (message: string, context?: LoggerContextWithError) => void
     >,
   );
 
@@ -51,7 +62,9 @@ function shouldBeLogged(methodName: LoggerLoggingMethodName): boolean {
   return requestedLogLevel >= minLogLevel;
 }
 
-function enrichContextWithDebugInfo(override: JsonObject = {}): JsonObject {
+function enrichContextWithDebugInfo(
+  override: LoggerContext = {},
+): LoggerContext {
   return {
     callName: getCallName(),
     fileName: getFileName(),

src/lib/shared/roarr/client.ts

@@ -8,14 +8,11 @@ import type { LogLevelName } from 'roarr';
 export type LoggerLoggingMethodName =
   | LoggerLoggingMethodNameNoOnce
   | LoggerLoggingMethodNameOnce;
+
 export type JsonObject = {
   [k: string]: JsonValue;
 };
-
-type LoggerLoggingMethodNameNoOnce = LogLevelName;
-type LoggerLoggingMethodNameOnce = `${LoggerLoggingMethodNameNoOnce}Once`;
-
-type JsonValue =
+export type JsonValue =
   | JsonObject
   | JsonValue[]
   | boolean
@@ -24,3 +21,17 @@ type JsonValue =
   | readonly JsonValue[]
   | null
   | undefined;
+
+export interface LoggerContext extends JsonObject {
+  error?: JsonValue;
+}
+
+export interface LoggerContextWithError {
+  error?: Error | JsonValue;
+  // WARN: Other properties should not have an `Error` type, but I don't know
+  // how to enforce it in combination with the type of `error` property.
+  [k: string]: Error | JsonValue;
+}
+
+type LoggerLoggingMethodNameNoOnce = LogLevelName;
+type LoggerLoggingMethodNameOnce = `${LoggerLoggingMethodNameNoOnce}Once`;