test: improve ErrorUtils coverage
[e-mobility-charging-stations-simulator.git] / src / utils / ErrorUtils.ts
index 0e3dbc50058c669c1c5a30a17c8ecbe14e9138c9..0a444c6b1f5d945e5577dd7fbebc6ec235df16e6 100644 (file)
@@ -1,33 +1,39 @@
-import chalk from 'chalk';
+import process from 'node:process'
 
-import { logger } from './Logger';
-import { isNotEmptyString } from './Utils';
-import type { ChargingStation } from '../charging-station';
+import chalk from 'chalk'
+
+import type { ChargingStation } from '../charging-station/index.js'
+import { getMessageTypeString } from '../charging-station/ocpp/OCPPServiceUtils.js'
 import type {
   EmptyObject,
   FileType,
   HandleErrorParams,
   IncomingRequestCommand,
   JsonType,
-  RequestCommand,
-} from '../types';
+  MessageType,
+  RequestCommand
+} from '../types/index.js'
+import { logger } from './Logger.js'
+import { isNotEmptyString } from './Utils.js'
+
+const moduleName = 'ErrorUtils'
 
 const defaultErrorParams = {
   throwError: true,
-  consoleOut: false,
-};
+  consoleOut: false
+} satisfies HandleErrorParams<EmptyObject>
 
 export const handleUncaughtException = (): void => {
   process.on('uncaughtException', (error: Error) => {
-    console.error(chalk.red('Uncaught exception: '), error);
-  });
-};
+    console.error(chalk.red('Uncaught exception: '), error)
+  })
+}
 
 export const handleUnhandledRejection = (): void => {
   process.on('unhandledRejection', (reason: unknown) => {
-    console.error(chalk.red('Unhandled rejection: '), reason);
-  });
-};
+    console.error(chalk.red('Unhandled rejection: '), reason)
+  })
+}
 
 export const handleFileException = (
   file: string,
@@ -36,60 +42,89 @@ export const handleFileException = (
   logPrefix: string,
   params: HandleErrorParams<EmptyObject> = defaultErrorParams
 ): void => {
-  setDefaultErrorParams(params);
-  const prefix = isNotEmptyString(logPrefix) ? `${logPrefix} ` : '';
-  let logMsg: string;
+  params = setDefaultErrorParams(params)
+  const prefix = isNotEmptyString(logPrefix) ? `${logPrefix} ` : ''
+  let logMsg: string
   switch (error.code) {
     case 'ENOENT':
-      logMsg = `${fileType} file ${file} not found:`;
-      break;
+      logMsg = `${fileType} file ${file} not found:`
+      break
     case 'EEXIST':
-      logMsg = `${fileType} file ${file} already exists:`;
-      break;
+      logMsg = `${fileType} file ${file} already exists:`
+      break
     case 'EACCES':
-      logMsg = `${fileType} file ${file} access denied:`;
-      break;
+      logMsg = `${fileType} file ${file} access denied:`
+      break
     case 'EPERM':
-      logMsg = `${fileType} file ${file} permission denied:`;
-      break;
+      logMsg = `${fileType} file ${file} permission denied:`
+      break
     default:
-      logMsg = `${fileType} file ${file} error:`;
+      logMsg = `${fileType} file ${file} error:`
   }
-  if (params?.consoleOut === true) {
-    if (params?.throwError) {
-      console.error(`${chalk.green(prefix)}${chalk.red(`${logMsg} `)}`, error);
+  if (params.consoleOut === true) {
+    logMsg = `${logMsg} `
+    if (params.throwError === true) {
+      console.error(`${chalk.green(prefix)}${chalk.red(logMsg)}`, error)
     } else {
-      console.warn(`${chalk.green(prefix)}${chalk.yellow(`${logMsg} `)}`, error);
+      console.warn(`${chalk.green(prefix)}${chalk.yellow(logMsg)}`, error)
     }
-  } else if (params?.consoleOut === false) {
-    if (params?.throwError) {
-      logger.error(`${prefix}${logMsg}`, error);
+  } else if (params.consoleOut === false) {
+    if (params.throwError === true) {
+      logger.error(`${prefix}${logMsg}`, error)
     } else {
-      logger.warn(`${prefix}${logMsg}`, error);
+      logger.warn(`${prefix}${logMsg}`, error)
     }
   }
-  if (params?.throwError) {
-    throw error;
+  if (params.throwError === true) {
+    throw error
   }
-};
+}
 
 export const handleSendMessageError = (
   chargingStation: ChargingStation,
   commandName: RequestCommand | IncomingRequestCommand,
+  messageType: MessageType,
   error: Error,
-  params: HandleErrorParams<EmptyObject> = { throwError: false, consoleOut: false }
+  params: HandleErrorParams<EmptyObject> = {
+    throwError: false,
+    consoleOut: false
+  }
 ): void => {
-  setDefaultErrorParams(params, { throwError: false, consoleOut: false });
-  logger.error(`${chargingStation.logPrefix()} Request command '${commandName}' error:`, error);
-  if (params?.throwError === true) {
-    throw error;
+  params = setDefaultErrorParams(params, { throwError: false, consoleOut: false })
+  logger.error(
+    `${chargingStation.logPrefix()} ${moduleName}.handleSendMessageError: Send ${getMessageTypeString(messageType)} command '${commandName}' error:`,
+    error
+  )
+  if (params.throwError === true) {
+    throw error
+  }
+}
+
+export const handleIncomingRequestError = <T extends JsonType>(
+  chargingStation: ChargingStation,
+  commandName: IncomingRequestCommand,
+  error: Error,
+  params: HandleErrorParams<T> = { throwError: true, consoleOut: false }
+): T | undefined => {
+  params = setDefaultErrorParams(params)
+  logger.error(
+    `${chargingStation.logPrefix()} ${moduleName}.handleIncomingRequestError: Incoming request command '${commandName}' error:`,
+    error
+  )
+  if (params.throwError === false && params.errorResponse != null) {
+    return params.errorResponse
+  }
+  if (params.throwError === true && params.errorResponse == null) {
+    throw error
+  }
+  if (params.throwError === true && params.errorResponse != null) {
+    return params.errorResponse
   }
-};
+}
 
 export const setDefaultErrorParams = <T extends JsonType>(
   params: HandleErrorParams<T>,
   defaultParams: HandleErrorParams<T> = defaultErrorParams
 ): HandleErrorParams<T> => {
-  params = { ...defaultParams, ...params };
-  return params;
-};
+  return { ...defaultParams, ...params }
+}