X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=760695253531f6c64863315287eb36063895b5a7;hb=1b0147cae119f5b519cffd8cdf2a733a3df20b11;hp=57aa1ad9c0d92bf15dbb5f7bb460a52ce1dbc6c3;hpb=6bf6769ef4ee4fd3935a442243984a8aa2136e53;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 57aa1ad9..76069525 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,35 +1,38 @@ import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData'; -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 { // Read conf - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60; } - static getAutoReconnectTimeout(): number { + static getConnectionTimeout(): number { + Configuration.deprecateConfigurationKey('autoReconnectTimeout', 'Use \'connectionTimeout\' in charging station instead'); + Configuration.deprecateConfigurationKey('connectionTimeout', 'Use it in charging station template instead'); // Read conf - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectTimeout') ? Configuration.getConfig().autoReconnectTimeout : 10; + if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'connectionTimeout')) { + return Configuration.getConfig().connectionTimeout; + } } static getAutoReconnectMaxRetries(): number { + Configuration.deprecateConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead'); // Read conf - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries') ? Configuration.getConfig().autoReconnectMaxRetries : -1; + if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { + return Configuration.getConfig().autoReconnectMaxRetries; + } } static getStationTemplateURLs(): StationTemplateURL[] { + Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => { + if (!Configuration.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,31 +46,33 @@ export default class Configuration { } static getLogConsole(): boolean { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; + Configuration.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead'); + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; } static getLogFormat(): string { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple'; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple'; } static getLogRotate(): boolean { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true; } static getLogMaxFiles(): number { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7; } static getLogLevel(): string { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info'; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info'; } static getLogFile(): string { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log'; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log'; } static getLogErrorFile(): string { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; + Configuration.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead'); + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; } static getSupervisionURLs(): string[] { @@ -76,6 +81,29 @@ export default class Configuration { } static getDistributeStationsToTenantsEqually(): boolean { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true; + Configuration.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead'); + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true; + } + + private static deprecateConfigurationKey(key: string, logMsgToAppend = '') { + if (!Configuration.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; + } + + private static objectHasOwnProperty(object: any, property: string): boolean { + return Object.prototype.hasOwnProperty.call(object, property); + } + + private static isUndefined(obj: any): boolean { + return typeof obj === 'undefined'; } }