Apply prettier formating
[e-mobility-charging-stations-simulator.git] / src / utils / Configuration.ts
index 57d17c8fa349feca795e97ebec538baac1815c30..5770d76e35ae546150ba2bf6cfe6951d5055aca1 100644 (file)
@@ -1,4 +1,9 @@
-import ConfigurationData, { StationTemplateUrl, StorageConfiguration, SupervisionUrlDistribution, UIWebSocketServerConfiguration } from '../types/ConfigurationData';
+import ConfigurationData, {
+  StationTemplateUrl,
+  StorageConfiguration,
+  SupervisionUrlDistribution,
+  UIWebSocketServerConfiguration,
+} from '../types/ConfigurationData';
 
 import Constants from './Constants';
 import { EmptyObject } from '../types/EmptyObject';
@@ -12,7 +17,11 @@ import fs from 'fs';
 import path from 'path';
 
 export default class Configuration {
-  private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json');
+  private static configurationFilePath = path.join(
+    path.resolve(__dirname, '../'),
+    'assets',
+    'config.json'
+  );
   private static configurationFileWatcher: fs.FSWatcher;
   private static configuration: ConfigurationData | null = null;
   private static configurationChangeCallback: () => Promise<void>;
@@ -22,61 +31,101 @@ export default class Configuration {
   }
 
   static getLogStatisticsInterval(): number {
-    Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', null, 'Use \'logStatisticsInterval\' instead');
+    Configuration.warnDeprecatedConfigurationKey(
+      'statisticsDisplayInterval',
+      null,
+      "Use 'logStatisticsInterval' instead"
+    );
     // Read conf
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval')
+      ? Configuration.getConfig().logStatisticsInterval
+      : 60;
   }
 
   static getUIWebSocketServer(): UIWebSocketServerConfiguration {
     let options: ServerOptions = {
       host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST,
-      port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT
+      port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT,
     };
     let uiWebSocketServerConfiguration: UIWebSocketServerConfiguration = {
       enabled: true,
-      options
+      options,
     };
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) {
-      if (Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'options')) {
+      if (
+        Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'options')
+      ) {
         options = {
           ...options,
-          ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer.options, 'host') && { host: Configuration.getConfig().uiWebSocketServer.options.host },
-          ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer.options, 'port') && { port: Configuration.getConfig().uiWebSocketServer.options.port }
+          ...(Configuration.objectHasOwnProperty(
+            Configuration.getConfig().uiWebSocketServer.options,
+            'host'
+          ) && { host: Configuration.getConfig().uiWebSocketServer.options.host }),
+          ...(Configuration.objectHasOwnProperty(
+            Configuration.getConfig().uiWebSocketServer.options,
+            'port'
+          ) && { port: Configuration.getConfig().uiWebSocketServer.options.port }),
         };
       }
-      uiWebSocketServerConfiguration =
-      {
+      uiWebSocketServerConfiguration = {
         ...uiWebSocketServerConfiguration,
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'enabled') && { enabled: Configuration.getConfig().uiWebSocketServer.enabled },
-        options
+        ...(Configuration.objectHasOwnProperty(
+          Configuration.getConfig().uiWebSocketServer,
+          'enabled'
+        ) && { enabled: Configuration.getConfig().uiWebSocketServer.enabled }),
+        options,
       };
     }
     return uiWebSocketServerConfiguration;
   }
 
   static getPerformanceStorage(): StorageConfiguration {
-    Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', 'Use \'uri\' instead');
+    Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', "Use 'uri' instead");
     let storageConfiguration: StorageConfiguration = {
       enabled: false,
       type: StorageType.JSON_FILE,
-      uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE)
+      uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE),
     };
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
-      storageConfiguration =
-      {
+      storageConfiguration = {
         ...storageConfiguration,
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') && { enabled: Configuration.getConfig().performanceStorage.enabled },
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'type') && { type: Configuration.getConfig().performanceStorage.type },
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'uri') && { uri: this.getDefaultPerformanceStorageUri(Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE) }
+        ...(Configuration.objectHasOwnProperty(
+          Configuration.getConfig().performanceStorage,
+          'enabled'
+        ) && { enabled: Configuration.getConfig().performanceStorage.enabled }),
+        ...(Configuration.objectHasOwnProperty(
+          Configuration.getConfig().performanceStorage,
+          'type'
+        ) && { type: Configuration.getConfig().performanceStorage.type }),
+        ...(Configuration.objectHasOwnProperty(
+          Configuration.getConfig().performanceStorage,
+          'uri'
+        ) && {
+          uri: this.getDefaultPerformanceStorageUri(
+            Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE
+          ),
+        }),
       };
     }
     return storageConfiguration;
   }
 
   static getAutoReconnectMaxRetries(): number {
-    Configuration.warnDeprecatedConfigurationKey('autoReconnectTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
-    Configuration.warnDeprecatedConfigurationKey('connectionTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
-    Configuration.warnDeprecatedConfigurationKey('autoReconnectMaxRetries', null, 'Use it in charging station template instead');
+    Configuration.warnDeprecatedConfigurationKey(
+      'autoReconnectTimeout',
+      null,
+      "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'connectionTimeout',
+      null,
+      "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'autoReconnectMaxRetries',
+      null,
+      'Use it in charging station template instead'
+    );
     // Read conf
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
       return Configuration.getConfig().autoReconnectMaxRetries;
@@ -84,11 +133,22 @@ export default class Configuration {
   }
 
   static getStationTemplateUrls(): StationTemplateUrl[] {
-    Configuration.warnDeprecatedConfigurationKey('stationTemplateURLs', null, 'Use \'stationTemplateUrls\' instead');
-    !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()['stationTemplateURLs'] as StationTemplateUrl[]);
+    Configuration.warnDeprecatedConfigurationKey(
+      'stationTemplateURLs',
+      null,
+      "Use 'stationTemplateUrls' instead"
+    );
+    !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
+      (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
+        'stationTemplateURLs'
+      ] as StationTemplateUrl[]);
     Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => {
       if (!Configuration.isUndefined(stationUrl['numberOfStation'])) {
-        console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${stationUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead}`);
+        console.error(
+          chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${
+            stationUrl.file
+          }' in 'stationTemplateUrls'. Use 'numberOfStations' instead}`
+        );
       }
     });
     // Read conf
@@ -96,25 +156,43 @@ export default class Configuration {
   }
 
   static getWorkerProcess(): WorkerProcessType {
-    Configuration.warnDeprecatedConfigurationKey('useWorkerPool;', null, 'Use \'workerProcess\' to define the type of worker process to use instead');
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig().workerProcess : WorkerProcessType.WORKER_SET;
+    Configuration.warnDeprecatedConfigurationKey(
+      'useWorkerPool;',
+      null,
+      "Use 'workerProcess' to define the type of worker process to use instead"
+    );
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess')
+      ? Configuration.getConfig().workerProcess
+      : WorkerProcessType.WORKER_SET;
   }
 
   static getWorkerStartDelay(): number {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig().workerStartDelay : Constants.WORKER_START_DELAY;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay')
+      ? Configuration.getConfig().workerStartDelay
+      : Constants.WORKER_START_DELAY;
   }
 
   static getElementStartDelay(): number {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'elementStartDelay') ? Configuration.getConfig().elementStartDelay : Constants.ELEMENT_START_DELAY;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'elementStartDelay')
+      ? Configuration.getConfig().elementStartDelay
+      : Constants.ELEMENT_START_DELAY;
   }
 
   static getWorkerPoolMinSize(): number {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize')
+      ? Configuration.getConfig().workerPoolMinSize
+      : Constants.DEFAULT_WORKER_POOL_MIN_SIZE;
   }
 
   static getWorkerPoolMaxSize(): number {
-    Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', null, 'Use \'workerPoolMaxSize\' instead');
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerPoolSize;',
+      null,
+      "Use 'workerPoolMaxSize' instead"
+    );
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize')
+      ? Configuration.getConfig().workerPoolMaxSize
+      : Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
   }
 
   static getWorkerPoolStrategy(): WorkerChoiceStrategy {
@@ -122,62 +200,117 @@ export default class Configuration {
   }
 
   static getChargingStationsPerWorker(): number {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER;
+    return Configuration.objectHasOwnProperty(
+      Configuration.getConfig(),
+      'chargingStationsPerWorker'
+    )
+      ? Configuration.getConfig().chargingStationsPerWorker
+      : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER;
   }
 
   static getLogConsole(): boolean {
-    Configuration.warnDeprecatedConfigurationKey('consoleLog', null, 'Use \'logConsole\' instead');
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
+    Configuration.warnDeprecatedConfigurationKey('consoleLog', null, "Use 'logConsole' instead");
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole')
+      ? Configuration.getConfig().logConsole
+      : false;
   }
 
   static getLogFormat(): string {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple';
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat')
+      ? Configuration.getConfig().logFormat
+      : 'simple';
   }
 
   static getLogRotate(): boolean {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate')
+      ? Configuration.getConfig().logRotate
+      : true;
   }
 
   static getLogMaxFiles(): number {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles')
+      ? Configuration.getConfig().logMaxFiles
+      : 7;
   }
 
   static getLogLevel(): string {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel.toLowerCase() : 'info';
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel')
+      ? Configuration.getConfig().logLevel.toLowerCase()
+      : 'info';
   }
 
   static getLogFile(): string {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log';
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile')
+      ? Configuration.getConfig().logFile
+      : 'combined.log';
   }
 
   static getLogErrorFile(): string {
-    Configuration.warnDeprecatedConfigurationKey('errorFile', null, 'Use \'logErrorFile\' instead');
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
+    Configuration.warnDeprecatedConfigurationKey('errorFile', null, "Use 'logErrorFile' instead");
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile')
+      ? Configuration.getConfig().logErrorFile
+      : 'error.log';
   }
 
   static getSupervisionUrls(): string | string[] {
-    Configuration.warnDeprecatedConfigurationKey('supervisionURLs', null, 'Use \'supervisionUrls\' instead');
-    !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) && (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as string[]);
+    Configuration.warnDeprecatedConfigurationKey(
+      'supervisionURLs',
+      null,
+      "Use 'supervisionUrls' instead"
+    );
+    !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) &&
+      (Configuration.getConfig().supervisionUrls = Configuration.getConfig()[
+        'supervisionURLs'
+      ] as string[]);
     // Read conf
     return Configuration.getConfig().supervisionUrls;
   }
 
   static getSupervisionUrlDistribution(): SupervisionUrlDistribution {
-    Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, 'Use \'supervisionUrlDistribution\' instead');
-    Configuration.warnDeprecatedConfigurationKey('distributeStationsToTenantsEqually', null, 'Use \'supervisionUrlDistribution\' instead');
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'supervisionUrlDistribution') ? Configuration.getConfig().supervisionUrlDistribution : SupervisionUrlDistribution.ROUND_ROBIN;
+    Configuration.warnDeprecatedConfigurationKey(
+      'distributeStationToTenantEqually',
+      null,
+      "Use 'supervisionUrlDistribution' instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'distributeStationsToTenantsEqually',
+      null,
+      "Use 'supervisionUrlDistribution' instead"
+    );
+    return Configuration.objectHasOwnProperty(
+      Configuration.getConfig(),
+      'supervisionUrlDistribution'
+    )
+      ? Configuration.getConfig().supervisionUrlDistribution
+      : SupervisionUrlDistribution.ROUND_ROBIN;
   }
 
   private static logPrefix(): string {
     return new Date().toLocaleString() + ' Simulator configuration |';
   }
 
-  private static warnDeprecatedConfigurationKey(key: string, sectionName?: string, logMsgToAppend = '') {
+  private static warnDeprecatedConfigurationKey(
+    key: string,
+    sectionName?: string,
+    logMsgToAppend = ''
+  ) {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    if (sectionName && !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && !Configuration.isUndefined(Configuration.getConfig()[sectionName][key])) {
-      console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${logMsgToAppend && '. ' + logMsgToAppend}}`);
+    if (
+      sectionName &&
+      !Configuration.isUndefined(Configuration.getConfig()[sectionName]) &&
+      !Configuration.isUndefined(Configuration.getConfig()[sectionName][key])
+    ) {
+      console.error(
+        chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${
+          logMsgToAppend && '. ' + logMsgToAppend
+        }}`
+      );
     } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
-      console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}}`);
+      console.error(
+        chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${
+          logMsgToAppend && '. ' + logMsgToAppend
+        }}`
+      );
     }
   }
 
@@ -185,9 +318,16 @@ export default class Configuration {
   private static getConfig(): ConfigurationData {
     if (!Configuration.configuration) {
       try {
-        Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData;
+        Configuration.configuration = JSON.parse(
+          fs.readFileSync(Configuration.configurationFilePath, 'utf8')
+        ) as ConfigurationData;
       } catch (error) {
-        Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error);
+        Configuration.handleFileException(
+          Configuration.logPrefix(),
+          'Configuration',
+          Configuration.configurationFilePath,
+          error
+        );
       }
       if (!Configuration.configurationFileWatcher) {
         Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
@@ -210,7 +350,12 @@ export default class Configuration {
         }
       });
     } catch (error) {
-      Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error as Error);
+      Configuration.handleFileException(
+        Configuration.logPrefix(),
+        'Configuration',
+        Configuration.configurationFilePath,
+        error as Error
+      );
     }
   }
 
@@ -218,7 +363,10 @@ export default class Configuration {
     const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`;
     switch (storageType) {
       case StorageType.JSON_FILE:
-        return `file://${path.join(path.resolve(__dirname, '../../'), Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME)}`;
+        return `file://${path.join(
+          path.resolve(__dirname, '../../'),
+          Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME
+        )}`;
       case StorageType.SQLITE:
         return `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`;
       default:
@@ -234,17 +382,34 @@ export default class Configuration {
     return typeof obj === 'undefined';
   }
 
-  private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException,
-      params: HandleErrorParams<EmptyObject> = { throwError: true }): void {
+  private static handleFileException(
+    logPrefix: string,
+    fileType: string,
+    filePath: string,
+    error: NodeJS.ErrnoException,
+    params: HandleErrorParams<EmptyObject> = { throwError: true }
+  ): void {
     const prefix = logPrefix.length !== 0 ? logPrefix + ' ' : '';
     if (error.code === 'ENOENT') {
-      console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '), error);
+      console.error(
+        chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '),
+        error
+      );
     } else if (error.code === 'EEXIST') {
-      console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '), error);
+      console.error(
+        chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '),
+        error
+      );
     } else if (error.code === 'EACCES') {
-      console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '), error);
+      console.error(
+        chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '),
+        error
+      );
     } else {
-      console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '), error);
+      console.error(
+        chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '),
+        error
+      );
     }
     if (params?.throwError) {
       throw error;