Add tunable for charging station start delay for linear ramp up

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

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 41ac9ba08f3fbf294d337075342c580be6170119..86c9335802bfc1a19eb4c11e10ab074a4ab22dbc 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -1,6 +1,8 @@
-import ConfigurationData, { StationTemplateURL, StorageConfiguration } from '../types/ConfigurationData';
+import ConfigurationData, { StationTemplateUrl, StorageConfiguration, SupervisionUrlDistribution, UIWebSocketServerConfiguration } from '../types/ConfigurationData';
 
 import Constants from './Constants';
+import { HandleErrorParams } from '../types/Error';
+import { ServerOptions } from 'ws';
 import { StorageType } from '../types/Storage';
 import type { WorkerChoiceStrategy } from 'poolifier';
 import { WorkerProcessType } from '../types/Worker';
@@ -24,21 +26,47 @@ export default class Configuration {
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60;
   }
 
-  static getPerformanceStorage(): StorageConfiguration {
-    let storageConfiguration: StorageConfiguration;
-    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
-      storageConfiguration =
+  static getUIWebSocketServer(): UIWebSocketServerConfiguration {
+    let options: ServerOptions = {
+      host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST,
+      port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT
+    };
+    let uiWebSocketServerConfiguration: UIWebSocketServerConfiguration = {
+      enabled: true,
+      options
+    };
+    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) {
+      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 }
+        };
+      }
+      uiWebSocketServerConfiguration =
       {
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') ? { enabled: Configuration.getConfig().performanceStorage.enabled } : { enabled: false },
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'type') ? { type: Configuration.getConfig().performanceStorage.type } : { type: StorageType.JSON_FILE },
-        ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'URI') ? { URI: Configuration.getConfig().performanceStorage.URI } : { URI: 'file:///performanceMeasurements.json' }
+        ...uiWebSocketServerConfiguration,
+        ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'enabled') && { enabled: Configuration.getConfig().uiWebSocketServer.enabled },
+        options
       };
-    } else {
+    }
+    return uiWebSocketServerConfiguration;
+  }
+
+  static getPerformanceStorage(): StorageConfiguration {
+    Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', 'Use \'uri\' instead');
+    let storageConfiguration: StorageConfiguration = {
+      enabled: false,
+      type: StorageType.JSON_FILE,
+      uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE)
+    };
+    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
       storageConfiguration =
       {
-        enabled: false,
-        type: StorageType.JSON_FILE,
-        URI: 'file:///performanceMeasurements.json'
+        ...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) }
       };
     }
     return storageConfiguration;
@@ -54,14 +82,16 @@ export default class Configuration {
     }
   }
 
-  static getStationTemplateURLs(): 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}`);
+  static getStationTemplateUrls(): 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}`);
       }
     });
     // Read conf
-    return Configuration.getConfig().stationTemplateURLs;
+    return Configuration.getConfig().stationTemplateUrls;
   }
 
   static getWorkerProcess(): WorkerProcessType {
@@ -73,6 +103,10 @@ export default class Configuration {
     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;
+  }
+
   static getWorkerPoolMinSize(): number {
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE;
   }
@@ -108,7 +142,7 @@ export default class Configuration {
   }
 
   static getLogLevel(): string {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info';
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel.toLowerCase() : 'info';
   }
 
   static getLogFile(): string {
@@ -120,14 +154,17 @@ export default class Configuration {
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
   }
 
-  static getSupervisionURLs(): string[] {
+  static getSupervisionUrls(): string | 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;
+    return Configuration.getConfig().supervisionUrls;
   }
 
-  static getDistributeStationsToTenantsEqually(): boolean {
-    Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, 'Use \'distributeStationsToTenantsEqually\' instead');
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true;
+  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;
   }
 
   private static logPrefix(): string {
@@ -160,28 +197,43 @@ export default class Configuration {
 
   private static getConfigurationFileWatcher(): fs.FSWatcher {
     try {
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      return fs.watch(Configuration.configurationFilePath).on('change', async (): Promise<void> => {
-        // Nullify to force configuration file reading
-        Configuration.configuration = null;
-        if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) {
-          await Configuration.configurationChangeCallback();
+      return fs.watch(Configuration.configurationFilePath, (event, filename): void => {
+        if (filename && event === 'change') {
+          // Nullify to force configuration file reading
+          Configuration.configuration = null;
+          if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) {
+            Configuration.configurationChangeCallback().catch((error) => {
+              throw typeof error === 'string' ? new Error(error) : error;
+            });
+          }
         }
       });
     } catch (error) {
-      Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error);
+      Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error as Error);
     }
   }
 
-  private static objectHasOwnProperty(object: any, property: string): boolean {
+  private static getDefaultPerformanceStorageUri(storageType: StorageType) {
+    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)}`;
+      case StorageType.SQLITE:
+        return `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`;
+      default:
+        throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`);
+    }
+  }
+
+  private static objectHasOwnProperty(object: unknown, property: string): boolean {
     return Object.prototype.hasOwnProperty.call(object, property) as boolean;
   }
 
-  private static isUndefined(obj: any): boolean {
+  private static isUndefined(obj: unknown): boolean {
     return typeof obj === 'undefined';
   }
 
-  private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException): void {
+  private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException, params: HandleErrorParams = { 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);
@@ -192,6 +244,8 @@ export default class Configuration {
     } else {
       console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '), error);
     }
-    throw error;
+    if (params?.throwError) {
+      throw error;
+    }
   }
 }