X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=e4215f94c973e3be09c6283d9773e489067105d7;hb=60655b2618d2d049b20efb78c1a75a75c2874db6;hp=725dd2e1466bd5ae3df9ecfba8e0e54251963de7;hpb=60a743910478b70e39dcefa5e1b752ec8a93880e;p=e-mobility-charging-stations-simulator.git

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 725dd2e1..e4215f94 100644
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -6,13 +6,12 @@ import chalk from 'chalk';
 import merge from 'just-merge';
 import { WorkerChoiceStrategies } from 'poolifier';
 
-import { Constants } from './internal';
+import { Constants } from './Constants';
+import { Utils } from './Utils';
 import {
   ApplicationProtocol,
   type ConfigurationData,
-  type EmptyObject,
   FileType,
-  type HandleErrorParams,
   type StationTemplateUrl,
   type StorageConfiguration,
   StorageType,
@@ -24,7 +23,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,24 +36,24 @@ 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 {
+  public static getLogStatisticsInterval(): number | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'statisticsDisplayInterval',
       undefined,
       "Use 'logStatisticsInterval' instead"
     );
     // Read conf
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval')
+    return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval')
       ? Configuration.getConfig()?.logStatisticsInterval
       : Constants.DEFAULT_LOG_STATISTICS_INTERVAL;
   }
 
-  static getUIServer(): UIServerConfiguration {
-    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) {
+  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}`
       );
@@ -67,36 +66,42 @@ export class Configuration {
         port: Constants.DEFAULT_UI_SERVER_PORT,
       },
     };
-    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) {
+    if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) {
       uiServerConfiguration = merge<UIServerConfiguration>(
         uiServerConfiguration,
         Configuration.getConfig()?.uiServer
       );
     }
-    if (Configuration.isCFEnvironment() === true) {
+    if (Utils.isCFEnvironment() === true) {
       delete uiServerConfiguration.options?.host;
       uiServerConfiguration.options.port = parseInt(process.env.PORT);
     }
     return uiServerConfiguration;
   }
 
-  static getPerformanceStorage(): StorageConfiguration {
+  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 (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
+    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 getAutoReconnectMaxRetries(): number | undefined {
+  public static getAutoReconnectMaxRetries(): number | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'autoReconnectTimeout',
       undefined,
@@ -113,35 +118,37 @@ export class Configuration {
       'Use it in charging station template instead'
     );
     // Read conf
-    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
+    if (Utils.hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
       return Configuration.getConfig()?.autoReconnectMaxRetries;
     }
   }
 
-  static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+  public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'stationTemplateURLs',
       undefined,
       "Use 'stationTemplateUrls' instead"
     );
-    !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
+    !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
       (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
         'stationTemplateURLs'
-      ] as unknown 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}`
-        );
+      ] as StationTemplateUrl[]);
+    Configuration.getConfig().stationTemplateUrls.forEach(
+      (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}`
+          );
+        }
       }
-    });
+    );
     // Read conf
     return Configuration.getConfig()?.stationTemplateUrls;
   }
 
-  static getWorker(): WorkerConfiguration {
+  public static getWorker(): WorkerConfiguration {
     Configuration.warnDeprecatedConfigurationKey(
       'useWorkerPool',
       undefined,
@@ -188,112 +195,110 @@ export class Configuration {
       "Use 'worker' section to define the worker pool strategy instead"
     );
     let workerConfiguration: WorkerConfiguration = {
-      processType: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess')
+      processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess')
         ? Configuration.getConfig()?.workerProcess
-        : WorkerProcessType.WORKER_SET,
-      startDelay: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay')
+        : WorkerProcessType.workerSet,
+      startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay')
         ? Configuration.getConfig()?.workerStartDelay
         : WorkerConstants.DEFAULT_WORKER_START_DELAY,
-      elementsPerWorker: Configuration.objectHasOwnProperty(
-        Configuration.getConfig(),
-        'chargingStationsPerWorker'
-      )
+      elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker')
         ? Configuration.getConfig()?.chargingStationsPerWorker
         : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER,
-      elementStartDelay: Configuration.objectHasOwnProperty(
-        Configuration.getConfig(),
-        'elementStartDelay'
-      )
+      elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay')
         ? Configuration.getConfig()?.elementStartDelay
         : WorkerConstants.DEFAULT_ELEMENT_START_DELAY,
-      poolMinSize: Configuration.objectHasOwnProperty(
-        Configuration.getConfig(),
-        'workerPoolMinSize'
-      )
+      poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize')
         ? Configuration.getConfig()?.workerPoolMinSize
         : WorkerConstants.DEFAULT_POOL_MIN_SIZE,
-      poolMaxSize: Configuration.objectHasOwnProperty(
-        Configuration.getConfig(),
-        'workerPoolMaxSize'
-      )
+      poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize')
         ? Configuration.getConfig()?.workerPoolMaxSize
         : WorkerConstants.DEFAULT_POOL_MAX_SIZE,
       poolStrategy:
         Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
     };
-    if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'worker')) {
+    if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) {
       workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker };
     }
     return workerConfiguration;
   }
 
-  static getLogConsole(): boolean | undefined {
+  public static workerPoolInUse(): boolean {
+    return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes(
+      Configuration.getWorker().processType
+    );
+  }
+
+  public static workerDynamicPoolInUse(): boolean {
+    return Configuration.getWorker().processType === WorkerProcessType.dynamicPool;
+  }
+
+  public static getLogConsole(): boolean | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'consoleLog',
       undefined,
       "Use 'logConsole' instead"
     );
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole')
+    return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole')
       ? Configuration.getConfig()?.logConsole
       : false;
   }
 
-  static getLogFormat(): string | undefined {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat')
+  public static getLogFormat(): string | undefined {
+    return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat')
       ? Configuration.getConfig()?.logFormat
       : 'simple';
   }
 
-  static getLogRotate(): boolean | undefined {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate')
+  public static getLogRotate(): boolean | undefined {
+    return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate')
       ? Configuration.getConfig()?.logRotate
       : true;
   }
 
-  static getLogMaxFiles(): number | string | false | undefined {
+  public static getLogMaxFiles(): number | string | false | undefined {
     return (
-      Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') &&
+      Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') &&
       Configuration.getConfig()?.logMaxFiles
     );
   }
 
-  static getLogMaxSize(): number | string | false | undefined {
+  public static getLogMaxSize(): number | string | false | undefined {
     return (
-      Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') &&
+      Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') &&
       Configuration.getConfig()?.logMaxSize
     );
   }
 
-  static getLogLevel(): string | undefined {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel')
+  public static getLogLevel(): string | undefined {
+    return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel')
       ? Configuration.getConfig()?.logLevel?.toLowerCase()
       : 'info';
   }
 
-  static getLogFile(): string | undefined {
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile')
+  public static getLogFile(): string | undefined {
+    return Utils.hasOwnProp(Configuration.getConfig(), 'logFile')
       ? Configuration.getConfig()?.logFile
       : 'combined.log';
   }
 
-  static getLogErrorFile(): string | undefined {
+  public static getLogErrorFile(): string | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'errorFile',
       undefined,
       "Use 'logErrorFile' instead"
     );
-    return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile')
+    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,
       "Use 'supervisionUrls' instead"
     );
-    !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) &&
+    !Utils.isUndefined(Configuration.getConfig()['supervisionURLs']) &&
       (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as
         | string
         | string[]);
@@ -301,7 +306,7 @@ export class Configuration {
     return Configuration.getConfig()?.supervisionUrls;
   }
 
-  static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
+  public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
     Configuration.warnDeprecatedConfigurationKey(
       'distributeStationToTenantEqually',
       undefined,
@@ -312,10 +317,7 @@ export class Configuration {
       undefined,
       "Use 'supervisionUrlDistribution' instead"
     );
-    return Configuration.objectHasOwnProperty(
-      Configuration.getConfig(),
-      'supervisionUrlDistribution'
-    )
+    return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution')
       ? Configuration.getConfig()?.supervisionUrlDistribution
       : SupervisionUrlDistribution.ROUND_ROBIN;
   }
@@ -331,20 +333,18 @@ export class Configuration {
   ) {
     if (
       sectionName &&
-      !Configuration.isUndefined(Configuration.getConfig()[sectionName]) &&
-      !Configuration.isUndefined(
-        (Configuration.getConfig()[sectionName] as Record<string, unknown>)[key]
-      )
+      !Utils.isUndefined(Configuration.getConfig()[sectionName]) &&
+      !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}`
+          logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
         }}`
       );
-    } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
+    } else if (!Utils.isUndefined(Configuration.getConfig()[key])) {
       console.error(
         chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${
-          logMsgToAppend.trim().length > 0 && `. ${logMsgToAppend}`
+          logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
         }}`
       );
     }
@@ -378,7 +378,7 @@ export class Configuration {
         if (filename?.trim().length > 0 && event === 'change') {
           // Nullify to force configuration file reading
           Configuration.configuration = null;
-          if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) {
+          if (!Utils.isUndefined(Configuration.configurationChangeCallback)) {
             Configuration.configurationChangeCallback().catch((error) => {
               throw typeof error === 'string' ? new Error(error) : error;
             });
@@ -395,60 +395,53 @@ export class Configuration {
     }
   }
 
-  private static isCFEnvironment(): boolean {
-    return process.env.VCAP_APPLICATION !== undefined;
-  }
-
-  private static getDefaultPerformanceStorageUri(storageType: StorageType) {
-    switch (storageType) {
-      case StorageType.JSON_FILE:
-        return `file://${path.join(
-          path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'),
-          Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME
-        )}`;
-      case StorageType.SQLITE:
-        return `file://${path.join(
-          path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'),
-          `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`
-        )}`;
-      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: unknown): boolean {
-    return obj === undefined;
-  }
-
   private static handleFileException(
-    filePath: string,
+    file: string,
     fileType: FileType,
     error: NodeJS.ErrnoException,
-    logPrefix: string,
-    params: HandleErrorParams<EmptyObject> = { throwError: true }
+    logPrefix: string
   ): void {
-    const prefix = logPrefix?.trim().length > 0 ? `${logPrefix} ` : '';
+    const prefix = Utils.isNotEmptyString(logPrefix) ? `${logPrefix} ` : '';
     let logMsg: string;
     switch (error.code) {
       case 'ENOENT':
-        logMsg = `${fileType} file ${filePath} not found: `;
+        logMsg = `${fileType} file ${file} not found:`;
         break;
       case 'EEXIST':
-        logMsg = `${fileType} file ${filePath} already exists: `;
+        logMsg = `${fileType} file ${file} already exists:`;
         break;
       case 'EACCES':
-        logMsg = `${fileType} file ${filePath} access denied: `;
+        logMsg = `${fileType} file ${file} access denied:`;
+        break;
+      case 'EPERM':
+        logMsg = `${fileType} file ${file} permission denied:`;
         break;
       default:
-        logMsg = `${fileType} file ${filePath} error: `;
+        logMsg = `${fileType} file ${file} error:`;
     }
-    console.error(`${chalk.green(prefix)}${chalk.red(logMsg)}`, error);
-    if (params?.throwError) {
-      throw 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}'`);
     }
   }
+
+  private static buildPerformanceUriFilePath(file: string) {
+    return `file://${path.join(
+      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+      file
+    )}`;
+  }
 }