X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=2ac2664285173756e32a23dc3f905b6e3187231f;hb=87002425fa13e6637bcb337aee4f5688976a5b45;hp=60092940e20eceb395d9ffc8caf1bd2d92385497;hpb=f937f3bb099d9745b6e7282259e67b51523c8821;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 60092940..2ac26642 100644 --- 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.warnDeprecatedConfigurationKey('statisticsDisplayInterval', 'Use \'logStatisticsInterval\' instead'); + Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', null, 'Use \'logStatisticsInterval\' instead'); // Read conf return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60; } @@ -30,23 +31,25 @@ export default class Configuration { { ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') ? { enabled: Configuration.getConfig().performanceStorage.enabled } : { enabled: false }, ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'type') ? { type: Configuration.getConfig().performanceStorage.type } : { type: StorageType.JSON_FILE }, - ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'URI') ? { URI: Configuration.getConfig().performanceStorage.URI } : { URI: 'file:///performanceMeasurements.json' } + ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'URI') + ? { URI: Configuration.getConfig().performanceStorage.URI } + : { URI: this.getDefaultPerformanceStorageURI(Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE) } }; } else { storageConfiguration = { enabled: false, type: StorageType.JSON_FILE, - URI: 'file:///performanceMeasurements.json' + URI: this.getDefaultPerformanceStorageURI(StorageType.JSON_FILE) }; } return storageConfiguration; } static getAutoReconnectMaxRetries(): number { - 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'); + Configuration.warnDeprecatedConfigurationKey('autoReconnectTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead'); + Configuration.warnDeprecatedConfigurationKey('connectionTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead'); + Configuration.warnDeprecatedConfigurationKey('autoReconnectMaxRetries', null, 'Use it in charging station template instead'); // Read conf if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { return Configuration.getConfig().autoReconnectMaxRetries; @@ -56,7 +59,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`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead}`); } }); // Read conf @@ -64,7 +67,7 @@ export default class Configuration { } static getWorkerProcess(): WorkerProcessType { - Configuration.warnDeprecatedConfigurationKey('useWorkerPool;', 'Use \'workerProcess\' to define the type of worker process to use instead'); + Configuration.warnDeprecatedConfigurationKey('useWorkerPool;', null, '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 +80,7 @@ export default class Configuration { } static getWorkerPoolMaxSize(): number { - Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead'); + Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', null, 'Use \'workerPoolMaxSize\' instead'); return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE; } @@ -90,7 +93,7 @@ export default class Configuration { } static getLogConsole(): boolean { - Configuration.warnDeprecatedConfigurationKey('consoleLog', 'Use \'logConsole\' instead'); + Configuration.warnDeprecatedConfigurationKey('consoleLog', null, 'Use \'logConsole\' instead'); return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; } @@ -115,7 +118,7 @@ export default class Configuration { } static getLogErrorFile(): string { - Configuration.warnDeprecatedConfigurationKey('errorFile', 'Use \'logErrorFile\' instead'); + Configuration.warnDeprecatedConfigurationKey('errorFile', null, 'Use \'logErrorFile\' instead'); return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; } @@ -125,7 +128,7 @@ export default class Configuration { } static getDistributeStationsToTenantsEqually(): boolean { - Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead'); + Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, 'Use \'distributeStationsToTenantsEqually\' instead'); return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true; } @@ -133,9 +136,12 @@ export default class Configuration { return new Date().toLocaleString() + ' Simulator configuration |'; } - private static warnDeprecatedConfigurationKey(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`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${logMsgToAppend && '. ' + logMsgToAppend}}`); + } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) { + console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}}`); } } @@ -156,12 +162,13 @@ export default class Configuration { private static getConfigurationFileWatcher(): fs.FSWatcher { try { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - return fs.watch(Configuration.configurationFilePath).on('change', async (): Promise => { - // Nullify to force configuration file reading - Configuration.configuration = null; - if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { - await Configuration.configurationChangeCallback(); + return fs.watch(Configuration.configurationFilePath, async (event, filename): Promise => { + if (filename && event === 'change') { + // Nullify to force configuration file reading + Configuration.configuration = null; + if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { + await Configuration.configurationChangeCallback(); + } } }); } catch (error) { @@ -169,24 +176,36 @@ export default class Configuration { } } - private static objectHasOwnProperty(object: any, property: string): boolean { + private static getDefaultPerformanceStorageURI(storageType: StorageType) { + const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`; + switch (storageType) { + case StorageType.JSON_FILE: + return `file://${path.join(path.resolve(__dirname, '../../'), Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME)}`; + case StorageType.SQLITE: + return `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`; + default: + throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); + } + } + + private static objectHasOwnProperty(object: unknown, property: string): boolean { return Object.prototype.hasOwnProperty.call(object, property) as boolean; } - private static isUndefined(obj: any): boolean { + private static isUndefined(obj: unknown): boolean { return typeof obj === 'undefined'; } 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.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '), error); } else if (error.code === 'EEXIST') { - console.error(prefix + fileType + ' file ' + filePath + ' already exists: ', error); + console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '), error); } else if (error.code === 'EACCES') { - console.error(prefix + fileType + ' file ' + filePath + ' access denied: ', error); + console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '), error); } else { - console.error(prefix + fileType + ' file ' + filePath + ' error: ', error); + console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '), error); } throw error; }