X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=0926115ce41a0f016b75c799114d8a4553806695;hb=6e0964c8dff48691f7155d12096e777a8f9389f4;hp=9492bb9b37d631865ba0a750c53561d5c41859b4;hpb=524d9cb333fd690edb702c88517f79b3f3d6813e;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 9492bb9b..0926115c 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,65 +1,107 @@ import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData'; -import Utils from './Utils'; +import Constants from './Constants'; +import type { WorkerChoiceStrategy } from 'poolifier'; +import { WorkerProcessType } from '../types/Worker'; import fs from 'fs'; +import path from 'path'; export default class Configuration { - static configuration: ConfigurationData; + private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json'); + private static configurationFileWatcher: fs.FSWatcher; + private static configuration: ConfigurationData | null = null; + private static configurationChangeCallback: () => Promise; - // 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; + static setConfigurationChangeCallback(cb: () => Promise): void { + Configuration.configurationChangeCallback = cb; } 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; } - static useWorkerPool(): boolean { - return Configuration.getConfig().useWorkerPool; + static getWorkerProcess(): WorkerProcessType { + Configuration.deprecateConfigurationKey('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; + } + + static getWorkerStartDelay(): number { + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig().workerStartDelay : Constants.WORKER_START_DELAY; } - static getWorkerPoolSize(): number { - return Configuration.getConfig().workerPoolSize; + static getWorkerPoolMinSize(): number { + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : 4; + } + + static getWorkerPoolMaxSize(): number { + Configuration.deprecateConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead'); + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : 16; + } + + static getWorkerPoolStrategy(): WorkerChoiceStrategy { + return Configuration.getConfig().workerPoolStrategy; + } + + static getChargingStationsPerWorker(): number { + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : 1; } 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 Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true; + } + + static getLogMaxFiles(): number { + 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[] { @@ -68,6 +110,43 @@ 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(Configuration.configurationFilePath, 'utf8')) as ConfigurationData; + if (!Configuration.configurationFileWatcher) { + Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); + } + } + return Configuration.configuration; + } + + private static getConfigurationFileWatcher(): fs.FSWatcher { + // eslint-disable-next-line @typescript-eslint/no-misused-promises + return fs.watch(Configuration.configurationFilePath).on('change', async (e): Promise => { + // Nullify to force configuration file reading + Configuration.configuration = null; + if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { + await Configuration.configurationChangeCallback(); + } + }); + } + + 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'; } }