feat: reduce the number of deprecated configuration warnings

reference #630

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>

diff --git a/src/charging-station/ChargingStation.ts b/src/charging-station/ChargingStation.ts
index 4ca577aff1d1cc9895bd899c0c7304aa2bcdedf6..3cf7c60e22de46f98f0b350507f7407a06e15cc1 100644 (file)
--- a/src/charging-station/ChargingStation.ts
+++ b/src/charging-station/ChargingStation.ts
@@ -365,7 +365,6 @@ export class ChargingStation {
 
   public getMaximumPower(stationInfo?: ChargingStationInfo): number {
     const localStationInfo = stationInfo ?? this.stationInfo;
-    // eslint-disable-next-line @typescript-eslint/dot-notation
     return (
       (localStationInfo['maxPower' as keyof ChargingStationInfo] as number) ??
       localStationInfo.maximumPower

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 6d7c4a81b9a7f10a1e2fcc489aa9b61846b33012..b9fc7bd67ca8a778a30c632f55f1806119766960 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -41,8 +41,8 @@ export class Configuration {
     'config.json',
   );
 
-  private static configurationFileWatcher?: FSWatcher;
   private static configurationData?: ConfigurationData;
+  private static configurationFileWatcher?: FSWatcher;
   private static configurationSectionCache = new Map<
     ConfigurationSection,
     ConfigurationSectionType
@@ -53,6 +53,8 @@ export class Configuration {
     [ConfigurationSection.uiServer, Configuration.buildUIServerSection()],
   ]);
 
+  private static warnDeprecatedConfigurationKeys = false;
+
   private static configurationChangeCallback?: () => Promise<void>;
 
   private constructor() {
@@ -73,70 +75,23 @@ export class Configuration {
   }
 
   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',
-    );
     if (hasOwnProp(Configuration.getConfigurationData(), 'autoReconnectMaxRetries')) {
       return Configuration.getConfigurationData()?.autoReconnectMaxRetries;
     }
   }
 
   public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
-    Configuration.warnDeprecatedConfigurationKey(
-      'stationTemplateURLs',
-      undefined,
-      "Use 'stationTemplateUrls' instead",
-    );
-    // eslint-disable-next-line @typescript-eslint/dot-notation
-    !isUndefined(
-      Configuration.getConfigurationData()!['stationTemplateURLs' as keyof ConfigurationData],
-    ) &&
-      (Configuration.getConfigurationData()!.stationTemplateUrls =
-        Configuration.getConfigurationData()![
-          // eslint-disable-next-line @typescript-eslint/dot-notation
-          'stationTemplateURLs' as keyof ConfigurationData
-        ] as StationTemplateUrl[]);
-    Configuration.getConfigurationData()!.stationTemplateUrls.forEach(
-      (stationTemplateUrl: StationTemplateUrl) => {
-        // eslint-disable-next-line @typescript-eslint/dot-notation
-        if (!isUndefined(stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl])) {
-          console.error(
-            `${chalk.green(Configuration.logPrefix())} ${chalk.red(
-              `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
-            )}`,
-          );
-        }
-      },
-    );
+    Configuration.checkDeprecatedConfigurationKeys();
     return Configuration.getConfigurationData()?.stationTemplateUrls;
   }
 
   public static getSupervisionUrls(): string | string[] | undefined {
-    Configuration.warnDeprecatedConfigurationKey(
-      'supervisionURLs',
-      undefined,
-      "Use 'supervisionUrls' instead",
-    );
-    // eslint-disable-next-line @typescript-eslint/dot-notation
     if (
       !isUndefined(
         Configuration.getConfigurationData()!['supervisionURLs' as keyof ConfigurationData],
       )
     ) {
       Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![
-        // eslint-disable-next-line @typescript-eslint/dot-notation
         'supervisionURLs' as keyof ConfigurationData
       ] as string | string[];
     }
@@ -144,16 +99,6 @@ export class Configuration {
   }
 
   public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
-    Configuration.warnDeprecatedConfigurationKey(
-      'distributeStationToTenantEqually',
-      undefined,
-      "Use 'supervisionUrlDistribution' instead",
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'distributeStationsToTenantsEqually',
-      undefined,
-      "Use 'supervisionUrlDistribution' instead",
-    );
     return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution')
       ? Configuration.getConfigurationData()?.supervisionUrlDistribution
       : SupervisionUrlDistribution.ROUND_ROBIN;
@@ -207,13 +152,6 @@ export class Configuration {
   }
 
   private static buildUIServerSection(): UIServerConfiguration {
-    if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
-      console.error(
-        `${chalk.green(Configuration.logPrefix())} ${chalk.red(
-          `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
-        )}`,
-      );
-    }
     let uiServerConfiguration: UIServerConfiguration = {
       enabled: false,
       type: ApplicationProtocol.WS,
@@ -236,11 +174,6 @@ export class Configuration {
   }
 
   private static buildPerformanceStorageSection(): StorageConfiguration {
-    Configuration.warnDeprecatedConfigurationKey(
-      'URI',
-      ConfigurationSection.performanceStorage,
-      "Use 'uri' instead",
-    );
     let storageConfiguration: StorageConfiguration = {
       enabled: false,
       type: StorageType.JSON_FILE,
@@ -263,56 +196,6 @@ export class Configuration {
   }
 
   private static buildLogSection(): LogConfiguration {
-    Configuration.warnDeprecatedConfigurationKey(
-      'logEnabled',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the logging enablement instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logFile',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log file instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logErrorFile',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log error file instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logConsole',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logStatisticsInterval',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logLevel',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log level instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logFormat',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log format instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logRotate',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logMaxFiles',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log maximum files instead`,
-    );
-    Configuration.warnDeprecatedConfigurationKey(
-      'logMaxSize',
-      undefined,
-      `Use '${ConfigurationSection.log}' section to define the log maximum size instead`,
-    );
     const defaultLogConfiguration: LogConfiguration = {
       enabled: true,
       file: 'logs/combined.log',
@@ -364,6 +247,117 @@ export class Configuration {
   }
 
   private static buildWorkerSection(): WorkerConfiguration {
+    const defaultWorkerConfiguration: WorkerConfiguration = {
+      processType: WorkerProcessType.workerSet,
+      startDelay: DEFAULT_WORKER_START_DELAY,
+      elementsPerWorker: 'auto',
+      elementStartDelay: DEFAULT_ELEMENT_START_DELAY,
+      poolMinSize: DEFAULT_POOL_MIN_SIZE,
+      poolMaxSize: DEFAULT_POOL_MAX_SIZE,
+    };
+    const deprecatedWorkerConfiguration: WorkerConfiguration = {
+      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && {
+        processType: Configuration.getConfigurationData()?.workerProcess,
+      }),
+      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && {
+        startDelay: Configuration.getConfigurationData()?.workerStartDelay,
+      }),
+      ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && {
+        elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker,
+      }),
+      ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && {
+        elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay,
+      }),
+      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
+        poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize,
+      }),
+      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
+        poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize,
+      }),
+    };
+    hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') &&
+      delete Configuration.getConfigurationData()?.workerPoolStrategy;
+    const workerConfiguration: WorkerConfiguration = {
+      ...defaultWorkerConfiguration,
+      ...deprecatedWorkerConfiguration,
+      ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) &&
+        Configuration.getConfigurationData()?.worker),
+    };
+    if (!Object.values(WorkerProcessType).includes(workerConfiguration.processType!)) {
+      throw new SyntaxError(
+        `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`,
+      );
+    }
+    return workerConfiguration;
+  }
+
+  private static logPrefix = (): string => {
+    return `${new Date().toLocaleString()} Simulator configuration |`;
+  };
+
+  private static checkDeprecatedConfigurationKeys() {
+    if (Configuration.warnDeprecatedConfigurationKeys) {
+      return;
+    }
+    // connection timeout
+    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",
+    );
+    // connection retries
+    Configuration.warnDeprecatedConfigurationKey(
+      'autoReconnectMaxRetries',
+      undefined,
+      'Use it in charging station template instead',
+    );
+    // station template url(s)
+    Configuration.warnDeprecatedConfigurationKey(
+      'stationTemplateURLs',
+      undefined,
+      "Use 'stationTemplateUrls' instead",
+    );
+    !isUndefined(
+      Configuration.getConfigurationData()!['stationTemplateURLs' as keyof ConfigurationData],
+    ) &&
+      (Configuration.getConfigurationData()!.stationTemplateUrls =
+        Configuration.getConfigurationData()![
+          'stationTemplateURLs' as keyof ConfigurationData
+        ] as StationTemplateUrl[]);
+    Configuration.getConfigurationData()!.stationTemplateUrls.forEach(
+      (stationTemplateUrl: StationTemplateUrl) => {
+        if (!isUndefined(stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl])) {
+          console.error(
+            `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+              `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
+            )}`,
+          );
+        }
+      },
+    );
+    // supervision url(s)
+    Configuration.warnDeprecatedConfigurationKey(
+      'supervisionURLs',
+      undefined,
+      "Use 'supervisionUrls' instead",
+    );
+    // supervision urls distribution
+    Configuration.warnDeprecatedConfigurationKey(
+      'distributeStationToTenantEqually',
+      undefined,
+      "Use 'supervisionUrlDistribution' instead",
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'distributeStationsToTenantsEqually',
+      undefined,
+      "Use 'supervisionUrlDistribution' instead",
+    );
+    // worker section
     Configuration.warnDeprecatedConfigurationKey(
       'useWorkerPool',
       undefined,
@@ -409,59 +403,79 @@ export class Configuration {
       undefined,
       `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`,
     );
-    const defaultWorkerConfiguration: WorkerConfiguration = {
-      processType: WorkerProcessType.workerSet,
-      startDelay: DEFAULT_WORKER_START_DELAY,
-      elementsPerWorker: 'auto',
-      elementStartDelay: DEFAULT_ELEMENT_START_DELAY,
-      poolMinSize: DEFAULT_POOL_MIN_SIZE,
-      poolMaxSize: DEFAULT_POOL_MAX_SIZE,
-    };
-    hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') &&
-      delete Configuration.getConfigurationData()?.workerPoolStrategy;
-    const deprecatedWorkerConfiguration: WorkerConfiguration = {
-      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && {
-        processType: Configuration.getConfigurationData()?.workerProcess,
-      }),
-      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && {
-        startDelay: Configuration.getConfigurationData()?.workerStartDelay,
-      }),
-      ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && {
-        elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker,
-      }),
-      ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && {
-        elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay,
-      }),
-      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
-        poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize,
-      }),
-      ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
-        poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize,
-      }),
-    };
     Configuration.warnDeprecatedConfigurationKey(
       'poolStrategy',
       ConfigurationSection.worker,
       'Not publicly exposed to end users',
     );
-    const workerConfiguration: WorkerConfiguration = {
-      ...defaultWorkerConfiguration,
-      ...deprecatedWorkerConfiguration,
-      ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) &&
-        Configuration.getConfigurationData()?.worker),
-    };
-    if (!Object.values(WorkerProcessType).includes(workerConfiguration.processType!)) {
-      throw new SyntaxError(
-        `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`,
+    // log section
+    Configuration.warnDeprecatedConfigurationKey(
+      'logEnabled',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the logging enablement instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logFile',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log file instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logErrorFile',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log error file instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logConsole',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logStatisticsInterval',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logLevel',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log level instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logFormat',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log format instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logRotate',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logMaxFiles',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log maximum files instead`,
+    );
+    Configuration.warnDeprecatedConfigurationKey(
+      'logMaxSize',
+      undefined,
+      `Use '${ConfigurationSection.log}' section to define the log maximum size instead`,
+    );
+    // performanceStorage section
+    Configuration.warnDeprecatedConfigurationKey(
+      'URI',
+      ConfigurationSection.performanceStorage,
+      "Use 'uri' instead",
+    );
+    // uiServer section
+    if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
+      console.error(
+        `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+          `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
+        )}`,
       );
     }
-    return workerConfiguration;
+    Configuration.warnDeprecatedConfigurationKeys = true;
   }
 
-  private static logPrefix = (): string => {
-    return `${new Date().toLocaleString()} Simulator configuration |`;
-  };
-
   private static warnDeprecatedConfigurationKey(
     key: string,
     sectionName?: string,