X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=bf25445c00136eefcb85ed2e11acdf9e660f410c;hb=9ab62ed05a70a1feda05803f085a449ce35a4f14;hp=4bc1853d2d8543db22b4f8c3d35996100467dcc1;hpb=322c9192eaa7142da1bf475cc2c6588ca72d922c;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 4bc1853d..bf25445c 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,54 +1,101 @@ -import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData'; +import ConfigurationData, { StationTemplateUrl, StorageConfiguration, UIWebSocketServerConfiguration } from '../types/ConfigurationData'; import Constants from './Constants'; +import { ServerOptions } from 'ws'; +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'; export default class Configuration { private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json'); private static configurationFileWatcher: fs.FSWatcher; - private static configuration: ConfigurationData; + private static configuration: ConfigurationData | null = null; private static configurationChangeCallback: () => Promise; static setConfigurationChangeCallback(cb: () => Promise): void { 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 getUIWebSocketServer(): UIWebSocketServerConfiguration { + let options: ServerOptions = { + host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST, + port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT + }; + let uiWebSocketServerConfiguration: UIWebSocketServerConfiguration = { + enabled: true, + options + }; + if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) { + if (Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'options')) { + options = { + ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer.options, 'host') && { host: Configuration.getConfig().uiWebSocketServer.options.host }, + ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer.options, 'port') && { port: Configuration.getConfig().uiWebSocketServer.options.port } + }; + } + uiWebSocketServerConfiguration = + { + ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'enabled') && { enabled: Configuration.getConfig().uiWebSocketServer.enabled }, + options + }; + } + return uiWebSocketServerConfiguration; + } + + static getPerformanceStorage(): StorageConfiguration { + Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', 'Use \'uri\' instead'); + let storageConfiguration: StorageConfiguration = { + enabled: false, + type: StorageType.JSON_FILE, + uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE) + }; + if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) { + storageConfiguration = + { + ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') && { enabled: Configuration.getConfig().performanceStorage.enabled }, + ...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: this.getDefaultPerformanceStorageUri(Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE) } + }; } + 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; } } - 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`); + static getStationTemplateUrls(): StationTemplateUrl[] { + Configuration.warnDeprecatedConfigurationKey('stationTemplateURLs', null, 'Use \'stationTemplateUrls\' instead'); + !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()['stationTemplateURLs'] as StationTemplateUrl[]); + Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => { + if (!Configuration.isUndefined(stationUrl['numberOfStation'])) { + console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${stationUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead}`); } }); // Read conf - return Configuration.getConfig().stationTemplateURLs; + return Configuration.getConfig().stationTemplateUrls; } 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; } @@ -57,20 +104,24 @@ export default class Configuration { } static getWorkerPoolMinSize(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : 4; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE; } static getWorkerPoolMaxSize(): number { - Configuration.deprecateConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : 16; + Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', null, 'Use \'workerPoolMaxSize\' instead'); + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE; + } + + static getWorkerPoolStrategy(): WorkerChoiceStrategy { + return Configuration.getConfig().workerPoolStrategy; } static getChargingStationsPerWorker(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : 1; + return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER; } 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; } @@ -95,30 +146,43 @@ 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'; } - static getSupervisionURLs(): string[] { + static getSupervisionUrls(): string[] { + Configuration.warnDeprecatedConfigurationKey('supervisionURLs', null, 'Use \'supervisionUrls\' instead'); + !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) && (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as string[]); // Read conf - return Configuration.getConfig().supervisionURLs; + return Configuration.getConfig().supervisionUrls; } 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(); } @@ -127,21 +191,52 @@ 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 { + 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) { + Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error); + } } - 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(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; + } }