X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=b54f3900988477d6e0ef77113323fc6c1bd8092a;hb=d317ba031e5f4a1a93b13ec136ea7593e8e3386a;hp=ab48cf310a1d9944bfcb0b763b6ff513edb368f8;hpb=7ec46a9aab2376a8a5201ce57aba95116a00d291;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index ab48cf31..b54f3900 100644
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -1,73 +1,496 @@
-import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 
-import Utils from './Utils';
-import fs from 'fs';
+import chalk from 'chalk';
+import merge from 'just-merge';
+import { WorkerChoiceStrategies } from 'poolifier';
 
-export default class Configuration {
-  static configuration: ConfigurationData;
+import { Constants } from './Constants';
+import { Utils } from './Utils';
+import {
+  ApplicationProtocol,
+  type ConfigurationData,
+  FileType,
+  type LogConfiguration,
+  type StationTemplateUrl,
+  type StorageConfiguration,
+  StorageType,
+  SupervisionUrlDistribution,
+  type UIServerConfiguration,
+  type WorkerConfiguration,
+} from '../types';
+import { WorkerConstants, WorkerProcessType } from '../worker';
 
-  // Read the config file
-  static getConfig(): ConfigurationData {
-    if (!Configuration.configuration) {
-      Configuration.configuration = JSON.parse(fs.readFileSync('./src/assets/config.json', 'utf8')) as ConfigurationData;
+export class Configuration {
+  private static configurationFile = path.join(
+    path.dirname(fileURLToPath(import.meta.url)),
+    'assets',
+    'config.json'
+  );
+
+  private static configurationFileWatcher: fs.FSWatcher | undefined;
+  private static configuration: ConfigurationData | null = null;
+  private static configurationChangeCallback: () => Promise<void>;
+
+  private constructor() {
+    // This is intentional
+  }
+
+  public static setConfigurationChangeCallback(cb: () => Promise<void>): void {
+    Configuration.configurationChangeCallback = cb;
+  }
+
+  public static getUIServer(): UIServerConfiguration {
+    if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) {
+      console.error(
+        `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+          "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead"
+        )}`
+      );
     }
-    return Configuration.configuration;
+    let uiServerConfiguration: UIServerConfiguration = {
+      enabled: false,
+      type: ApplicationProtocol.WS,
+      options: {
+        host: Constants.DEFAULT_UI_SERVER_HOST,
+        port: Constants.DEFAULT_UI_SERVER_PORT,
+      },
+    };
+    if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) {
+      uiServerConfiguration = merge<UIServerConfiguration>(
+        uiServerConfiguration,
+        Configuration.getConfig()?.uiServer
+      );
+    }
+    if (Utils.isCFEnvironment() === true) {
+      delete uiServerConfiguration.options?.host;
+      uiServerConfiguration.options.port = parseInt(process.env.PORT);
+    }
+    return uiServerConfiguration;
   }
 
-  static getStatisticsDisplayInterval(): number {
-    // Read conf
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60;
+  public 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 (Utils.hasOwnProp(Configuration.getConfig(), 'performanceStorage')) {
+      storageConfiguration = {
+        ...storageConfiguration,
+        ...Configuration.getConfig()?.performanceStorage,
+        ...(Configuration.getConfig()?.performanceStorage?.type === StorageType.JSON_FILE &&
+          Configuration.getConfig()?.performanceStorage?.uri && {
+            uri: Configuration.buildPerformanceUriFilePath(
+              new URL(Configuration.getConfig()?.performanceStorage?.uri).pathname
+            ),
+          }),
+      };
+    }
+    return storageConfiguration;
   }
 
-  static getAutoReconnectTimeout(): number {
+  public static getAutoReconnectMaxRetries(): number | undefined {
+    Configuration.warnDeprecatedConfigurationKey(
+      'autoReconnectTimeout',
+      undefined,
+      "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'connectionTimeout',
+      undefined,
+      "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'autoReconnectMaxRetries',
+      undefined,
+      'Use it in charging station template instead'
+    );
     // Read conf
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectTimeout') ? Configuration.getConfig().autoReconnectTimeout : 10;
+    if (Utils.hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
+      return Configuration.getConfig()?.autoReconnectMaxRetries;
+    }
   }
 
-  static getAutoReconnectMaxRetries(): number {
+  public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+    Configuration.warnDeprecatedConfigurationKey(
+      'stationTemplateURLs',
+      undefined,
+      "Use 'stationTemplateUrls' instead"
+    );
+    !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
+      (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
+        'stationTemplateURLs'
+      ] as StationTemplateUrl[]);
+    Configuration.getConfig().stationTemplateUrls.forEach(
+      (stationTemplateUrl: StationTemplateUrl) => {
+        if (!Utils.isUndefined(stationTemplateUrl['numberOfStation'])) {
+          console.error(
+            `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+              `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`
+            )}`
+          );
+        }
+      }
+    );
     // Read conf
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries') ? Configuration.getConfig().autoReconnectMaxRetries : -1;
+    return Configuration.getConfig()?.stationTemplateUrls;
   }
 
-  static getStationTemplateURLs(): StationTemplateURL[] {
-    // Read conf
-    return Configuration.getConfig().stationTemplateURLs;
+  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;
   }
 
-  static useWorkerPool(): boolean {
-    return Configuration.getConfig().useWorkerPool;
+  public static getWorker(): WorkerConfiguration {
+    Configuration.warnDeprecatedConfigurationKey(
+      'useWorkerPool',
+      undefined,
+      "Use 'worker' section to define the type of worker process model instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerProcess',
+      undefined,
+      "Use 'worker' section to define the type of worker process model instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerStartDelay',
+      undefined,
+      "Use 'worker' section to define the worker start delay instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'chargingStationsPerWorker',
+      undefined,
+      "Use 'worker' section to define the number of element(s) per worker instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'elementStartDelay',
+      undefined,
+      "Use 'worker' section to define the worker's element start delay instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerPoolMinSize',
+      undefined,
+      "Use 'worker' section to define the worker pool minimum size instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerPoolSize;',
+      undefined,
+      "Use 'worker' section to define the worker pool maximum size instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerPoolMaxSize;',
+      undefined,
+      "Use 'worker' section to define the worker pool maximum size instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'workerPoolStrategy;',
+      undefined,
+      "Use 'worker' section to define the worker pool strategy instead"
+    );
+    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),
+    };
+    return workerConfiguration;
   }
 
-  static getWorkerPoolSize(): number {
-    return Configuration.getConfig().workerPoolSize;
+  public static workerPoolInUse(): boolean {
+    return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes(
+      Configuration.getWorker().processType
+    );
   }
 
-  static getLogConsole(): boolean {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
+  public static workerDynamicPoolInUse(): boolean {
+    return Configuration.getWorker().processType === WorkerProcessType.dynamicPool;
   }
 
-  static getLogFormat(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple';
+  public static getSupervisionUrls(): string | string[] | undefined {
+    Configuration.warnDeprecatedConfigurationKey(
+      'supervisionURLs',
+      undefined,
+      "Use 'supervisionUrls' instead"
+    );
+    !Utils.isUndefined(Configuration.getConfig()['supervisionURLs']) &&
+      (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as
+        | string
+        | string[]);
+    // Read conf
+    return Configuration.getConfig()?.supervisionUrls;
   }
 
-  static getLogLevel(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info';
+  public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
+    Configuration.warnDeprecatedConfigurationKey(
+      'distributeStationToTenantEqually',
+      undefined,
+      "Use 'supervisionUrlDistribution' instead"
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'distributeStationsToTenantsEqually',
+      undefined,
+      "Use 'supervisionUrlDistribution' instead"
+    );
+    return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution')
+      ? Configuration.getConfig()?.supervisionUrlDistribution
+      : SupervisionUrlDistribution.ROUND_ROBIN;
   }
 
-  static getLogFile(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log';
+  private static logPrefix = (): string => {
+    return `${new Date().toLocaleString()} Simulator configuration |`;
+  };
+
+  private static warnDeprecatedConfigurationKey(
+    key: string,
+    sectionName?: string,
+    logMsgToAppend = ''
+  ) {
+    if (
+      sectionName &&
+      !Utils.isUndefined(Configuration.getConfig()[sectionName]) &&
+      !Utils.isUndefined((Configuration.getConfig()[sectionName] as Record<string, unknown>)[key])
+    ) {
+      console.error(
+        `${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())} ${chalk.red(
+          `Deprecated configuration key '${key}' usage${
+            logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
+          }`
+        )}`
+      );
+    }
   }
 
-  static getLogErrorFile(): string {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
+  // Read the config file
+  private static getConfig(): ConfigurationData | null {
+    if (!Configuration.configuration) {
+      try {
+        Configuration.configuration = JSON.parse(
+          fs.readFileSync(Configuration.configurationFile, 'utf8')
+        ) as ConfigurationData;
+      } catch (error) {
+        Configuration.handleFileException(
+          Configuration.configurationFile,
+          FileType.Configuration,
+          error as NodeJS.ErrnoException,
+          Configuration.logPrefix()
+        );
+      }
+      if (!Configuration.configurationFileWatcher) {
+        Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
+      }
+    }
+    return Configuration.configuration;
   }
 
-  static getSupervisionURLs(): string[] {
-    // Read conf
-    return Configuration.getConfig().supervisionURLs;
+  private static getConfigurationFileWatcher(): fs.FSWatcher | undefined {
+    try {
+      return fs.watch(Configuration.configurationFile, (event, filename): void => {
+        if (filename?.trim().length > 0 && event === 'change') {
+          // Nullify to force configuration file reading
+          Configuration.configuration = null;
+          if (!Utils.isUndefined(Configuration.configurationChangeCallback)) {
+            Configuration.configurationChangeCallback().catch((error) => {
+              throw typeof error === 'string' ? new Error(error) : error;
+            });
+          }
+        }
+      });
+    } catch (error) {
+      Configuration.handleFileException(
+        Configuration.configurationFile,
+        FileType.Configuration,
+        error as NodeJS.ErrnoException,
+        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:
+        return Configuration.buildPerformanceUriFilePath(
+          Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME
+        );
+      case StorageType.SQLITE:
+        return Configuration.buildPerformanceUriFilePath(
+          `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`
+        );
+      default:
+        throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`);
+    }
   }
 
-  static getDistributeStationToTenantEqually(): boolean {
-    return Utils.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationToTenantEqually') ? Configuration.getConfig().distributeStationToTenantEqually : true;
+  private static buildPerformanceUriFilePath(file: string) {
+    return `file://${path.join(
+      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+      file
+    )}`;
   }
 }