Colorize console message ouputs

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

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 8be9a1da92d54a242ac06d4eb882045cf71d0963..53117e2fec7b45669c45edbf2db8129774dc1ab4 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -4,6 +4,7 @@ import Constants from './Constants';
 import { StorageType } from '../types/Storage';
 import type { WorkerChoiceStrategy } from 'poolifier';
 import { WorkerProcessType } from '../types/Worker';
+import chalk from 'chalk';
 import fs from 'fs';
 import path from 'path';
 
@@ -18,7 +19,7 @@ export default class Configuration {
   }
 
   static getLogStatisticsInterval(): number {
-    Configuration.deprecateConfigurationKey('statisticsDisplayInterval', 'Use \'logStatisticsInterval\' instead');
+    Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', 'Use \'logStatisticsInterval\' instead');
     // Read conf
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60;
   }
@@ -44,9 +45,9 @@ export default class Configuration {
   }
 
   static getAutoReconnectMaxRetries(): number {
-    Configuration.deprecateConfigurationKey('autoReconnectTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
-    Configuration.deprecateConfigurationKey('connectionTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
-    Configuration.deprecateConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead');
+    Configuration.warnDeprecatedConfigurationKey('autoReconnectTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
+    Configuration.warnDeprecatedConfigurationKey('connectionTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
+    Configuration.warnDeprecatedConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead');
     // Read conf
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
       return Configuration.getConfig().autoReconnectMaxRetries;
@@ -56,7 +57,7 @@ export default class Configuration {
   static getStationTemplateURLs(): StationTemplateURL[] {
     Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => {
       if (!Configuration.isUndefined(stationURL['numberOfStation'])) {
-        console.error(`${Configuration.logPrefix()} Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead`);
+        console.error(chalk.red(`${Configuration.logPrefix()} Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead`));
       }
     });
     // Read conf
@@ -64,7 +65,7 @@ export default class Configuration {
   }
 
   static getWorkerProcess(): WorkerProcessType {
-    Configuration.deprecateConfigurationKey('useWorkerPool;', 'Use \'workerProcess\' to define the type of worker process to use instead');
+    Configuration.warnDeprecatedConfigurationKey('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;
   }
 
@@ -77,7 +78,7 @@ export default class Configuration {
   }
 
   static getWorkerPoolMaxSize(): number {
-    Configuration.deprecateConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead');
+    Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead');
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
   }
 
@@ -90,7 +91,7 @@ export default class Configuration {
   }
 
   static getLogConsole(): boolean {
-    Configuration.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead');
+    Configuration.warnDeprecatedConfigurationKey('consoleLog', 'Use \'logConsole\' instead');
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
   }
 
@@ -115,7 +116,7 @@ export default class Configuration {
   }
 
   static getLogErrorFile(): string {
-    Configuration.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead');
+    Configuration.warnDeprecatedConfigurationKey('errorFile', 'Use \'logErrorFile\' instead');
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
   }
 
@@ -125,7 +126,7 @@ export default class Configuration {
   }
 
   static getDistributeStationsToTenantsEqually(): boolean {
-    Configuration.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead');
+    Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead');
     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true;
   }
 
@@ -133,9 +134,12 @@ export default class Configuration {
     return new Date().toLocaleString() + ' Simulator configuration |';
   }
 
-  private static deprecateConfigurationKey(key: string, logMsgToAppend = '') {
-    if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
-      console.error(`${Configuration.logPrefix()} Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}`);
+  private static warnDeprecatedConfigurationKey(key: string, sectionName?: string, logMsgToAppend = '') {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    if (sectionName && !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && !Configuration.isUndefined(Configuration.getConfig()[sectionName][key])) {
+      console.error(chalk.red(`${Configuration.logPrefix()} Deprecated configuration key '${key}' usage in section '${sectionName}'${logMsgToAppend && '. ' + logMsgToAppend}`));
+    } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
+      console.error(chalk.red(`${Configuration.logPrefix()} Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}`));
     }
   }
 
@@ -180,13 +184,13 @@ export default class Configuration {
   private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException): void {
     const prefix = logPrefix.length !== 0 ? logPrefix + ' ' : '';
     if (error.code === 'ENOENT') {
-      console.error(prefix + fileType + ' file ' + filePath + ' not found: ', error);
+      console.error(chalk.red(prefix + fileType + ' file ' + filePath + ' not found: '), error);
     } else if (error.code === 'EEXIST') {
-      console.error(prefix + fileType + ' file ' + filePath + ' already exists: ', error);
+      console.error(chalk.red(prefix + fileType + ' file ' + filePath + ' already exists: '), error);
     } else if (error.code === 'EACCES') {
-      console.error(prefix + fileType + ' file ' + filePath + ' access denied: ', error);
+      console.error(chalk.red(prefix + fileType + ' file ' + filePath + ' access denied: '), error);
     } else {
-      console.error(prefix + fileType + ' file ' + filePath + ' error: ', error);
+      console.error(chalk.red(prefix + fileType + ' file ' + filePath + ' error: '), error);
     }
     throw error;
   }