Make the build app self contained.

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

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 995ab5d3a5b95a74a71368c198f698d0f585446d..99519b7da3086ba9883e212ced852e3fbfbccff5 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -1,71 +1,136 @@
-import Utils from './Utils';
+import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData';
+
+import Bootstrap from '../charging-station/Bootstrap';
+import { WorkerProcessType } from '../types/Worker';
 import fs from 'fs';
+import path from 'path';
 
 export default class Configuration {
-  static configuration;
-
-  // Read the config file
-  static getConfig() {
-    if (!Configuration.configuration) {
-      Configuration.configuration = JSON.parse(fs.readFileSync('./src/assets/config.json', 'utf8'));
-    }
-    return Configuration.configuration;
-  }
+  private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json');
+  private static configurationFileWatcher: fs.FSWatcher;
+  private static configuration: ConfigurationData;
 
   static getStatisticsDisplayInterval(): number {
     // Read conf
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60;
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60;
   }
 
-  static getAutoReconnectTimeout(): number {
+  static getConnectionTimeout(): number {
+    Configuration.deprecateConfigurationKey('autoReconnectTimeout', 'Use \'connectionTimeout\' in charging station instead');
+    Configuration.deprecateConfigurationKey('connectionTimeout', 'Use it in charging station template instead');
     // Read conf
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectTimeout') ? Configuration.getConfig().autoReconnectTimeout : 10;
+    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'connectionTimeout')) {
+      return Configuration.getConfig().connectionTimeout;
+    }
   }
 
   static getAutoReconnectMaxRetries(): number {
+    Configuration.deprecateConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead');
     // Read conf
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries') ? Configuration.getConfig().autoReconnectMaxRetries : -1;
+    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
+      return Configuration.getConfig().autoReconnectMaxRetries;
+    }
   }
 
-  static getStationTemplateURLs(): any[] {
+  static getStationTemplateURLs(): StationTemplateURL[] {
+    Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => {
+      if (!Configuration.isUndefined(stationURL['numberOfStation'])) {
+        console.error(`Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead`);
+      }
+    });
     // Read conf
     return Configuration.getConfig().stationTemplateURLs;
   }
 
-  static useWorkerPool(): boolean {
-    return Configuration.getConfig().useWorkerPool;
+  static getWorkerProcess(): WorkerProcessType {
+    Configuration.deprecateConfigurationKey('useWorkerPool;', '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 getWorkerPoolMinSize(): number {
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : 4;
+  }
+
+  static getWorkerPoolMaxSize(): number {
+    Configuration.deprecateConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead');
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : 16;
   }
 
-  static getWorkerPoolSize(): number {
-    return Configuration.getConfig().workerPoolSize;
+  static getChargingStationsPerWorker(): number {
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : 1;
   }
 
-  static getConsoleLog(): boolean {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'consoleLog') ? Configuration.getConfig().consoleLog : false;
+  static getLogConsole(): boolean {
+    Configuration.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead');
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
   }
 
   static getLogFormat(): string {
-    return Utils.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;
+  }
+
+  static getLogMaxFiles(): number {
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7;
   }
 
   static getLogLevel(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info';
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info';
   }
 
   static getLogFile(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log';
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log';
   }
 
-  static getErrorFile(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'errorFile') ? Configuration.getConfig().errorFile : 'error.log';
+  static getLogErrorFile(): string {
+    Configuration.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead');
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
   }
 
-  static getSupervisionURLs(): string {
+  static getSupervisionURLs(): string[] {
     // Read conf
     return Configuration.getConfig().supervisionURLs;
   }
 
-  static getDistributeStationToTenantEqually(): boolean {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationToTenantEqually') ? Configuration.getConfig().distributeStationToTenantEqually : true;
+  static getDistributeStationsToTenantsEqually(): boolean {
+    Configuration.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead');
+    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true;
+  }
+
+  private static deprecateConfigurationKey(key: string, logMsgToAppend = '') {
+    if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
+      console.error(`Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}`);
+    }
+  }
+
+  // Read the config file
+  private static getConfig(): ConfigurationData {
+    if (!Configuration.configuration) {
+      Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData;
+      if (!Configuration.configurationFileWatcher) {
+        Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
+      }
+    }
+    return Configuration.configuration;
+  }
+
+  private static getConfigurationFileWatcher(): fs.FSWatcher {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    return fs.watch(Configuration.configurationFilePath).on('change', async (e): Promise<void> => {
+      // Nullify to force configuration file reading
+      Configuration.configuration = null;
+      await Bootstrap.getInstance().restart();
+    });
+  }
+
+  private static objectHasOwnProperty(object: any, property: string): boolean {
+    return Object.prototype.hasOwnProperty.call(object, property) as boolean;
+  }
+
+  private static isUndefined(obj: any): boolean {
+    return typeof obj === 'undefined';
   }
 }