fix: properly handle non existing configuration sections

[e-mobility-charging-stations-simulator.git] / src / utils / Configuration.ts

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 47c5e160e20b86f10713c09eed61fb00ef08c399..b54f3900988477d6e0ef77113323fc6c1bd8092a 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -7,12 +7,12 @@ import merge from 'just-merge';
 import { WorkerChoiceStrategies } from 'poolifier';
 
 import { Constants } from './Constants';
-import { FileUtils } from './FileUtils';
 import { Utils } from './Utils';
 import {
   ApplicationProtocol,
   type ConfigurationData,
   FileType,
+  type LogConfiguration,
   type StationTemplateUrl,
   type StorageConfiguration,
   StorageType,
@@ -24,7 +24,7 @@ import { WorkerConstants, WorkerProcessType } from '../worker';
 
 export class Configuration {
   private static configurationFile = path.join(
-    path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+    path.dirname(fileURLToPath(import.meta.url)),
     'assets',
     'config.json'
   );
@@ -37,26 +37,16 @@ export class Configuration {
     // This is intentional
   }
 
-  static setConfigurationChangeCallback(cb: () => Promise<void>): void {
+  public static setConfigurationChangeCallback(cb: () => Promise<void>): void {
     Configuration.configurationChangeCallback = cb;
   }
 
-  static getLogStatisticsInterval(): number | undefined {
-    Configuration.warnDeprecatedConfigurationKey(
-      'statisticsDisplayInterval',
-      undefined,
-      "Use 'logStatisticsInterval' instead"
-    );
-    // Read conf
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval')
-      ? Configuration.getConfig()?.logStatisticsInterval
-      : Constants.DEFAULT_LOG_STATISTICS_INTERVAL;
-  }
-
-  static getUIServer(): UIServerConfiguration {
+  public static getUIServer(): UIServerConfiguration {
     if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) {
       console.error(
-        chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead}`
+        `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+          "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead"
+        )}`
       );
     }
     let uiServerConfiguration: UIServerConfiguration = {
@@ -80,7 +70,7 @@ export class Configuration {
     return uiServerConfiguration;
   }
 
-  static getPerformanceStorage(): StorageConfiguration {
+  public static getPerformanceStorage(): StorageConfiguration {
     Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', "Use 'uri' instead");
     let storageConfiguration: StorageConfiguration = {
       enabled: false,
@@ -102,7 +92,7 @@ export class Configuration {
     return storageConfiguration;
   }
 
-  static getAutoReconnectMaxRetries(): number | undefined {
+  public static getAutoReconnectMaxRetries(): number | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'autoReconnectTimeout',
       undefined,
@@ -124,7 +114,7 @@ export class Configuration {
     }
   }
 
-  static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+  public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'stationTemplateURLs',
       undefined,
@@ -138,9 +128,9 @@ export class Configuration {
       (stationTemplateUrl: StationTemplateUrl) => {
         if (!Utils.isUndefined(stationTemplateUrl['numberOfStation'])) {
           console.error(
-            chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${
-              stationTemplateUrl.file
-            }' in 'stationTemplateUrls'. Use 'numberOfStations' instead}`
+            `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+              `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`
+            )}`
           );
         }
       }
@@ -149,7 +139,107 @@ export class Configuration {
     return Configuration.getConfig()?.stationTemplateUrls;
   }
 
-  static getWorker(): WorkerConfiguration {
+  public static getLog(): LogConfiguration {
+    Configuration.warnDeprecatedConfigurationKey(
+      'logEnabled',
+      undefined,
+      "Use 'log' section to define the logging enablement instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logFile',
+      undefined,
+      "Use 'log' section to define the log file instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logErrorFile',
+      undefined,
+      "Use 'log' section to define the log error file instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logConsole',
+      undefined,
+      "Use 'log' section to define the console logging enablement instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logStatisticsInterval',
+      undefined,
+      "Use 'log' section to define the log statistics interval instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logLevel',
+      undefined,
+      "Use 'log' section to define the log level instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logFormat',
+      undefined,
+      "Use 'log' section to define the log format instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logRotate',
+      undefined,
+      "Use 'log' section to define the log rotation enablement instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logMaxFiles',
+      undefined,
+      "Use 'log' section to define the log maximum files instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logMaxSize',
+      undefined,
+      "Use 'log' section to define the log maximum size instead"
+    );
+    const defaultLogConfiguration: LogConfiguration = {
+      enabled: true,
+      file: 'logs/combined.log',
+      errorFile: 'logs/error.log',
+      statisticsInterval: Constants.DEFAULT_LOG_STATISTICS_INTERVAL,
+      level: 'info',
+      format: 'simple',
+      rotate: true,
+    };
+    const deprecatedLogConfiguration: LogConfiguration = {
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logEnabled') && {
+        enabled: Configuration.getConfig()?.logEnabled,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFile') && {
+        file: Configuration.getConfig()?.logFile,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') && {
+        errorFile: Configuration.getConfig()?.logErrorFile,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') && {
+        statisticsInterval: Configuration.getConfig()?.logStatisticsInterval,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') && {
+        level: Configuration.getConfig()?.logLevel,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') && {
+        console: Configuration.getConfig()?.logConsole,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') && {
+        format: Configuration.getConfig()?.logFormat,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') && {
+        rotate: Configuration.getConfig()?.logRotate,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && {
+        maxFiles: Configuration.getConfig()?.logMaxFiles,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxSize') && {
+        maxSize: Configuration.getConfig()?.logMaxSize,
+      }),
+    };
+    const logConfiguration: LogConfiguration = {
+      ...defaultLogConfiguration,
+      ...deprecatedLogConfiguration,
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'log') && Configuration.getConfig()?.log),
+    };
+    return logConfiguration;
+  }
+
+  public static getWorker(): WorkerConfiguration {
     Configuration.warnDeprecatedConfigurationKey(
       'useWorkerPool',
       undefined,
@@ -195,95 +285,59 @@ export class Configuration {
       undefined,
       "Use 'worker' section to define the worker pool strategy instead"
     );
-    let workerConfiguration: WorkerConfiguration = {
-      processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess')
-        ? Configuration.getConfig()?.workerProcess
-        : WorkerProcessType.workerSet,
-      startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay')
-        ? Configuration.getConfig()?.workerStartDelay
-        : WorkerConstants.DEFAULT_WORKER_START_DELAY,
-      elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker')
-        ? Configuration.getConfig()?.chargingStationsPerWorker
-        : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER,
-      elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay')
-        ? Configuration.getConfig()?.elementStartDelay
-        : WorkerConstants.DEFAULT_ELEMENT_START_DELAY,
-      poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize')
-        ? Configuration.getConfig()?.workerPoolMinSize
-        : WorkerConstants.DEFAULT_POOL_MIN_SIZE,
-      poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize')
-        ? Configuration.getConfig()?.workerPoolMaxSize
-        : WorkerConstants.DEFAULT_POOL_MAX_SIZE,
-      poolStrategy:
-        Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
+    const defaultWorkerConfiguration: WorkerConfiguration = {
+      processType: WorkerProcessType.workerSet,
+      startDelay: WorkerConstants.DEFAULT_WORKER_START_DELAY,
+      elementsPerWorker: WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER,
+      elementStartDelay: WorkerConstants.DEFAULT_ELEMENT_START_DELAY,
+      poolMinSize: WorkerConstants.DEFAULT_POOL_MIN_SIZE,
+      poolMaxSize: WorkerConstants.DEFAULT_POOL_MAX_SIZE,
+      poolStrategy: WorkerChoiceStrategies.ROUND_ROBIN,
+    };
+    const deprecatedWorkerConfiguration: WorkerConfiguration = {
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') && {
+        processType: Configuration.getConfig()?.workerProcess,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') && {
+        startDelay: Configuration.getConfig()?.workerStartDelay,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') && {
+        elementsPerWorker: Configuration.getConfig()?.chargingStationsPerWorker,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') && {
+        elementStartDelay: Configuration.getConfig()?.elementStartDelay,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') && {
+        poolMinSize: Configuration.getConfig()?.workerPoolMinSize,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') && {
+        poolMaxSize: Configuration.getConfig()?.workerPoolMaxSize,
+      }),
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolStrategy') && {
+        poolStrategy:
+          Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
+      }),
+    };
+    const workerConfiguration: WorkerConfiguration = {
+      ...defaultWorkerConfiguration,
+      ...deprecatedWorkerConfiguration,
+      ...(Utils.hasOwnProp(Configuration.getConfig(), 'worker') &&
+        Configuration.getConfig()?.worker),
     };
-    if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) {
-      workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker };
-    }
     return workerConfiguration;
   }
 
-  static getLogConsole(): boolean | undefined {
-    Configuration.warnDeprecatedConfigurationKey(
-      'consoleLog',
-      undefined,
-      "Use 'logConsole' instead"
+  public static workerPoolInUse(): boolean {
+    return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes(
+      Configuration.getWorker().processType
     );
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole')
-      ? Configuration.getConfig()?.logConsole
-      : false;
-  }
-
-  static getLogFormat(): string | undefined {
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat')
-      ? Configuration.getConfig()?.logFormat
-      : 'simple';
-  }
-
-  static getLogRotate(): boolean | undefined {
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate')
-      ? Configuration.getConfig()?.logRotate
-      : true;
   }
 
-  static getLogMaxFiles(): number | string | false | undefined {
-    return (
-      Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') &&
-      Configuration.getConfig()?.logMaxFiles
-    );
+  public static workerDynamicPoolInUse(): boolean {
+    return Configuration.getWorker().processType === WorkerProcessType.dynamicPool;
   }
 
-  static getLogMaxSize(): number | string | false | undefined {
-    return (
-      Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') &&
-      Configuration.getConfig()?.logMaxSize
-    );
-  }
-
-  static getLogLevel(): string | undefined {
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel')
-      ? Configuration.getConfig()?.logLevel?.toLowerCase()
-      : 'info';
-  }
-
-  static getLogFile(): string | undefined {
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logFile')
-      ? Configuration.getConfig()?.logFile
-      : 'combined.log';
-  }
-
-  static getLogErrorFile(): string | undefined {
-    Configuration.warnDeprecatedConfigurationKey(
-      'errorFile',
-      undefined,
-      "Use 'logErrorFile' instead"
-    );
-    return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile')
-      ? Configuration.getConfig()?.logErrorFile
-      : 'error.log';
-  }
-
-  static getSupervisionUrls(): string | string[] | undefined {
+  public static getSupervisionUrls(): string | string[] | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'supervisionURLs',
       undefined,
@@ -297,7 +351,7 @@ export class Configuration {
     return Configuration.getConfig()?.supervisionUrls;
   }
 
-  static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
+  public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'distributeStationToTenantEqually',
       undefined,
@@ -328,15 +382,19 @@ export class Configuration {
       !Utils.isUndefined((Configuration.getConfig()[sectionName] as Record<string, unknown>)[key])
     ) {
       console.error(
-        chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${
-          logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
-        }}`
+        `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+          `Deprecated configuration key '${key}' usage in section '${sectionName}'${
+            logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
+          }`
+        )}`
       );
     } else if (!Utils.isUndefined(Configuration.getConfig()[key])) {
       console.error(
-        chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${
-          logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
-        }}`
+        `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+          `Deprecated configuration key '${key}' usage${
+            logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
+          }`
+        )}`
       );
     }
   }
@@ -349,12 +407,11 @@ export class Configuration {
           fs.readFileSync(Configuration.configurationFile, 'utf8')
         ) as ConfigurationData;
       } catch (error) {
-        FileUtils.handleFileException(
+        Configuration.handleFileException(
           Configuration.configurationFile,
           FileType.Configuration,
           error as NodeJS.ErrnoException,
-          Configuration.logPrefix(),
-          { consoleOut: true }
+          Configuration.logPrefix()
         );
       }
       if (!Configuration.configurationFileWatcher) {
@@ -378,16 +435,43 @@ export class Configuration {
         }
       });
     } catch (error) {
-      FileUtils.handleFileException(
+      Configuration.handleFileException(
         Configuration.configurationFile,
         FileType.Configuration,
         error as NodeJS.ErrnoException,
-        Configuration.logPrefix(),
-        { consoleOut: true }
+        Configuration.logPrefix()
       );
     }
   }
 
+  private static handleFileException(
+    file: string,
+    fileType: FileType,
+    error: NodeJS.ErrnoException,
+    logPrefix: string
+  ): void {
+    const prefix = Utils.isNotEmptyString(logPrefix) ? `${logPrefix} ` : '';
+    let logMsg: string;
+    switch (error.code) {
+      case 'ENOENT':
+        logMsg = `${fileType} file ${file} not found:`;
+        break;
+      case 'EEXIST':
+        logMsg = `${fileType} file ${file} already exists:`;
+        break;
+      case 'EACCES':
+        logMsg = `${fileType} file ${file} access denied:`;
+        break;
+      case 'EPERM':
+        logMsg = `${fileType} file ${file} permission denied:`;
+        break;
+      default:
+        logMsg = `${fileType} file ${file} error:`;
+    }
+    console.error(`${chalk.green(prefix)}${chalk.red(`${logMsg} `)}`, error);
+    throw error;
+  }
+
   private static getDefaultPerformanceStorageUri(storageType: StorageType) {
     switch (storageType) {
       case StorageType.JSON_FILE:
@@ -405,7 +489,7 @@ export class Configuration {
 
   private static buildPerformanceUriFilePath(file: string) {
     return `file://${path.join(
-      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'),
+      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
       file
     )}`;
   }