X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=1b95f341e0ca8f5d05190e30dcdf996a3cc6a467;hb=a6b3c6c313f1c0314a1445ed630cac85edf55b2c;hp=a347969683fe546333c3db870934c64b55a4f369;hpb=1f0052b9fa7d0a13a1e85d8a0f761ba250af7fd5;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index a3479696..1b95f341 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,8 +1,10 @@ -import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData'; +import ConfigurationData, { StationTemplateURL, StorageConfiguration } from '../types/ConfigurationData'; 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'; @@ -16,22 +18,41 @@ export default class Configuration { Configuration.configurationChangeCallback = cb; } - static getStatisticsDisplayInterval(): number { + static getLogStatisticsInterval(): number { + Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', null, 'Use \'logStatisticsInterval\' instead'); // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60; - } - - static getConnectionTimeout(): number { - Configuration.deprecateConfigurationKey('autoReconnectTimeout', 'Use \'connectionTimeout\' in charging station instead'); - Configuration.deprecateConfigurationKey('connectionTimeout', 'Use it in charging station template instead'); - // Read conf - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'connectionTimeout')) { - return Configuration.getConfig().connectionTimeout; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60; + } + + static getPerformanceStorage(): StorageConfiguration { + const defaultJSONFilePathURI = `file://${path.join(path.resolve(__dirname, '../../'), Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME)}`; + const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`; + const defaultSQLiteFilePathURI = `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`; + let storageConfiguration: StorageConfiguration; + if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) { + storageConfiguration = + { + ...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: (Configuration.getConfig().performanceStorage.type === StorageType.JSON_FILE) ? defaultJSONFilePathURI : defaultSQLiteFilePathURI } + }; + } else { + storageConfiguration = + { + enabled: false, + type: StorageType.JSON_FILE, + URI: defaultJSONFilePathURI + }; } + return storageConfiguration; } static getAutoReconnectMaxRetries(): number { - Configuration.deprecateConfigurationKey('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; @@ -41,7 +62,7 @@ export default class Configuration { 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`); + console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead}`); } }); // Read conf @@ -49,7 +70,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;', 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; } @@ -62,7 +83,7 @@ export default class Configuration { } static getWorkerPoolMaxSize(): number { - Configuration.deprecateConfigurationKey('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; } @@ -75,7 +96,7 @@ export default class Configuration { } static getLogConsole(): boolean { - Configuration.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead'); + Configuration.warnDeprecatedConfigurationKey('consoleLog', null, 'Use \'logConsole\' instead'); return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; } @@ -100,7 +121,7 @@ export default class Configuration { } static getLogErrorFile(): string { - Configuration.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead'); + Configuration.warnDeprecatedConfigurationKey('errorFile', null, 'Use \'logErrorFile\' instead'); return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; } @@ -110,20 +131,31 @@ export default class Configuration { } static getDistributeStationsToTenantsEqually(): boolean { - Configuration.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead'); + Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, '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}`); + private static logPrefix(): string { + return new Date().toLocaleString() + ' Simulator configuration |'; + } + + 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}}`); } } // Read the config file private static getConfig(): ConfigurationData { if (!Configuration.configuration) { - Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData; + try { + Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData; + } catch (error) { + Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error); + } if (!Configuration.configurationFileWatcher) { Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); } @@ -132,21 +164,39 @@ export default class 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(); - } - }); + 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(); + } + }); + } catch (error) { + Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error); + } } private static objectHasOwnProperty(object: any, property: string): boolean { - return Object.prototype.hasOwnProperty.call(object, property); + return Object.prototype.hasOwnProperty.call(object, property) as boolean; } private static isUndefined(obj: any): 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(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '), error); + } else if (error.code === 'EEXIST') { + console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '), error); + } else if (error.code === 'EACCES') { + console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '), error); + } else { + console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '), error); + } + throw error; + } }