@digitraffic/common 2023.3.21-2 → 2023.4.3-1

package/src/utils/logging.ts

@@ -4,38 +4,72 @@ import { getEnvVariableOrElse } from "./utils";
 
 const functionName = getEnvVariableOrElse("AWS_LAMBDA_FUNCTION_NAME", "test");
 
-export function logException(
-    logger: DtLogger,
-    error: Error | string,
-    includeStack?: boolean
-): void;
-export function logException(logger: DtLogger, error: AxiosError): void;
+/**
+ * Curried version of logException.
+ *
+ * @example <caption>Using default configuration</caption>
+ * Promise.reject(x).catch(createExceptionLogger())
+ *
+ * @example <caption>Providing external logger and requiring stack</caption>
+ * import {logger} from "@digitraffic/common/dist/aws/runtime/dt-logger-default"
+ * Promise.reject(x).catch(createExceptionLogger(logger, true))
+ *
+ * @param [logger=undefined] - DtLogger to use. If not given, will create a new instance of DtLogger
+ * @param [includeStack=false] - Define if the stack trace should be logged.
+ * @param error - The error instance to be logged.
+ * @returns Logs the error without rethrowing.
+ * @see {@link logException}
+ */
+export function createExceptionLogger(
+    logger: DtLogger | undefined = undefined,
+    includeStack = false
+) {
+    let thatLogger: DtLogger;
+    if (logger) {
+        thatLogger = logger;
+    } else {
+        thatLogger = new DtLogger();
+    }
+
+    return (error: unknown) => {
+        logException(thatLogger, error, includeStack);
+    };
+}
 
 /**
  * Log given exception with level ERROR to given logger.
  *
  * Supports AxiosError, Error and string
  *
- * @param logger DtLogger to use
- * @param error AxiosError, Error or string to log
- * @param includeStack Include stack in the message, default false
- * @see log
+ * @param logger - DtLogger to use
+ * @param error - AxiosError, Error or string to log
+ * @param [includeStack=true] - Include stack in the message, default false
+ * @returns Logs the error without rethrowing
+ * @see {@link DtLogger.log}
+ * @see {@link createExceptionLogger} for a curried setup
  */
 export function logException(
     logger: DtLogger,
-    error: Error | string | AxiosError,
+    error: unknown,
     includeStack = false
 ) {
-    const message = error instanceof Error ? error.message : error;
+    const message =
+        error instanceof Error
+            ? error.message
+            : typeof error === "string"
+            ? error
+            : JSON.stringify(error);
+
     const stack =
         error instanceof Error && includeStack ? error.stack : undefined;
-    const code = error instanceof AxiosError ? error.code : undefined;
+
+    const customCode = error instanceof AxiosError ? error.code : undefined;
 
     logger.error({
         type: "Error",
         method: `${functionName}.logException`,
         message,
-        code,
+        customCode,
         stack,
     });
 }