Warn about deprecated configuration key at startup.

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>

diff --git a/package-lock.json b/package-lock.json
index e15fda00471828580c809b600417333fa642e8aa..2cb919f3f2408e757e22356c35b882c83b4a97fd 100644 (file)
--- a/package-lock.json
+++ b/package-lock.json
@@ -508,9 +508,9 @@
       "dev": true
     },
     "@types/node": {
-      "version": "14.14.8",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.8.tgz",
-      "integrity": "sha512-z/5Yd59dCKI5kbxauAJgw6dLPzW+TNOItNE00PkpzNwUIEwdj/Lsqwq94H5DdYBX7C13aRA0CY32BK76+neEUA==",
+      "version": "14.14.9",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.9.tgz",
+      "integrity": "sha512-JsoLXFppG62tWTklIoO4knA+oDTYsmqWxHRvd4lpmfQRNhX6osheUOWETP2jMoV/2bEHuMra8Pp3Dmo/stBFcw==",
       "dev": true
     },
     "@types/offscreencanvas": {

diff --git a/package.json b/package.json
index 56455997863a8a0a7d41e1d74a2720dd0273107a..c4ade427169908565bb3583dead6798b4f31e907 100644 (file)
--- a/package.json
+++ b/package.json
@@ -57,7 +57,7 @@
     "utf-8-validate": "^5.0.3"
   },
   "devDependencies": {
-    "@types/node": "^14.14.8",
+    "@types/node": "^14.14.9",
     "@types/uuid": "^8.3.0",
     "@types/worker-threads-pool": "^2.0.0",
     "@types/ws": "^7.4.0",

diff --git a/src/start.ts b/src/start.ts
index 61a6b5f9f56c03fe4602ac9723cede9aeacf635e..1c91dea361f5e5b9224ce6f8d6529e5758d524b4 100644 (file)
--- a/src/start.ts
+++ b/src/start.ts
@@ -1,13 +1,10 @@
 import Configuration from './utils/Configuration';
 import { StationTemplateURL } from './types/ConfigurationData';
-import Utils from './utils/Utils';
 import Wrk from './charging-station/Worker';
-import logger from './utils/Logger';
 
 class Bootstrap {
   static start() {
     try {
-      logger.debug('%s Configuration: %j', Utils.logPrefix(), Configuration.getConfig());
       let numStationsTotal = 0;
       // Start each ChargingStation object in a worker thread
       if (Configuration.getStationTemplateURLs()) {

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 57aa1ad9c0d92bf15dbb5f7bb460a52ce1dbc6c3..17c04da0c6728e8fbcdd01851e96add337c24983 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -4,17 +4,10 @@ import Utils from './Utils';
 import fs from 'fs';
 
 export default class Configuration {
-  static configuration: ConfigurationData;
-
-  // Read the config file
-  static getConfig(): ConfigurationData {
-    if (!Configuration.configuration) {
-      Configuration.configuration = JSON.parse(fs.readFileSync('./src/assets/config.json', 'utf8')) as ConfigurationData;
-    }
-    return Configuration.configuration;
-  }
+  private static configuration: ConfigurationData;
 
   static getStatisticsDisplayInterval(): number {
+    Configuration.deprecateConfigurationKey('');
     // Read conf
     return Utils.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60;
   }
@@ -30,6 +23,11 @@ export default class Configuration {
   }
 
   static getStationTemplateURLs(): StationTemplateURL[] {
+    Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => {
+      if (!Utils.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;
   }
@@ -43,6 +41,7 @@ export default class Configuration {
   }
 
   static getLogConsole(): boolean {
+    Configuration.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead');
     return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
   }
 
@@ -67,6 +66,7 @@ export default class Configuration {
   }
 
   static getLogErrorFile(): string {
+    Configuration.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead');
     return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
   }
 
@@ -76,6 +76,21 @@ export default class Configuration {
   }
 
   static getDistributeStationsToTenantsEqually(): boolean {
+    Configuration.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead');
     return Utils.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true;
   }
+
+  private static deprecateConfigurationKey(key: string, logMsgToAppend = '') {
+    if (!Utils.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('./src/assets/config.json', 'utf8')) as ConfigurationData;
+    }
+    return Configuration.configuration;
+  }
 }