X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=7d5b217d5faafa331c8b16ae4768e65003e9c691;hb=617cad0c86c3fea53b56a738bb0d6ddc3da05237;hp=f7fe64bf5c7db4603e4b23751cd9d134ac4ac632;hpb=d5603918a8ea990f7dcc11b612dea931aa084fdc;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index f7fe64bf..7d5b217d 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,157 +1,354 @@ -import ConfigurationData, { StationTemplateURL, StorageConfiguration } from '../types/ConfigurationData'; +import fs from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; -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'; +import merge from 'just-merge'; +import { WorkerChoiceStrategies } from 'poolifier'; -export default class Configuration { - private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json'); - private static configurationFileWatcher: fs.FSWatcher; +// import { Constants, FileUtils, Utils } from './internal'; +import { Constants } from './Constants'; +import { FileUtils } from './FileUtils'; +import { Utils } from './Utils'; +import { + ApplicationProtocol, + type ConfigurationData, + FileType, + type StationTemplateUrl, + type StorageConfiguration, + StorageType, + SupervisionUrlDistribution, + type UIServerConfiguration, + type WorkerConfiguration, +} from '../types'; +import { WorkerConstants, WorkerProcessType } from '../worker'; + +export class Configuration { + private static configurationFile = path.join( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), + 'assets', + 'config.json' + ); + + private static configurationFileWatcher: fs.FSWatcher | undefined; private static configuration: ConfigurationData | null = null; private static configurationChangeCallback: () => Promise; + private constructor() { + // This is intentional + } + static setConfigurationChangeCallback(cb: () => Promise): void { Configuration.configurationChangeCallback = cb; } - static getLogStatisticsInterval(): number { - Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', null, 'Use \'logStatisticsInterval\' instead'); + static getLogStatisticsInterval(): number | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'statisticsDisplayInterval', + undefined, + "Use 'logStatisticsInterval' instead" + ); // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60; + return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') + ? Configuration.getConfig()?.logStatisticsInterval + : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; + } + + static getUIServer(): UIServerConfiguration { + if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) { + console.error( + chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead}` + ); + } + let uiServerConfiguration: UIServerConfiguration = { + enabled: false, + type: ApplicationProtocol.WS, + options: { + host: Constants.DEFAULT_UI_SERVER_HOST, + port: Constants.DEFAULT_UI_SERVER_PORT, + }, + }; + if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) { + uiServerConfiguration = merge( + uiServerConfiguration, + Configuration.getConfig()?.uiServer + ); + } + if (Utils.isCFEnvironment() === true) { + delete uiServerConfiguration.options?.host; + uiServerConfiguration.options.port = parseInt(process.env.PORT); + } + return uiServerConfiguration; } static getPerformanceStorage(): StorageConfiguration { - 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: this.getDefaultPerformanceStorageURI(Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE) } - }; - } else { - storageConfiguration = - { - enabled: false, - type: StorageType.JSON_FILE, - URI: this.getDefaultPerformanceStorageURI(StorageType.JSON_FILE) + Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', "Use 'uri' instead"); + let storageConfiguration: StorageConfiguration = { + enabled: false, + type: StorageType.JSON_FILE, + uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE), + }; + if (Utils.hasOwnProp(Configuration.getConfig(), 'performanceStorage')) { + storageConfiguration = { + ...storageConfiguration, + ...Configuration.getConfig()?.performanceStorage, }; } return storageConfiguration; } - static getAutoReconnectMaxRetries(): number { - 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'); + static getAutoReconnectMaxRetries(): number | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'autoReconnectTimeout', + undefined, + "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'connectionTimeout', + undefined, + "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'autoReconnectMaxRetries', + undefined, + 'Use it in charging station template instead' + ); // Read conf - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { - return Configuration.getConfig().autoReconnectMaxRetries; + if (Utils.hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) { + return Configuration.getConfig()?.autoReconnectMaxRetries; } } - static getStationTemplateURLs(): 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}`); + static getStationTemplateUrls(): StationTemplateUrl[] | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'stationTemplateURLs', + undefined, + "Use 'stationTemplateUrls' instead" + ); + !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && + (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[ + 'stationTemplateURLs' + ] as StationTemplateUrl[]); + Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => { + if (!Utils.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; - } - - static getWorkerProcess(): WorkerProcessType { - 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; - } - - static getWorkerStartDelay(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig().workerStartDelay : Constants.WORKER_START_DELAY; + return Configuration.getConfig()?.stationTemplateUrls; } - static getWorkerPoolMinSize(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE; - } - - static getWorkerPoolMaxSize(): number { - 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 getWorker(): WorkerConfiguration { + Configuration.warnDeprecatedConfigurationKey( + 'useWorkerPool', + undefined, + "Use 'worker' section to define the type of worker process model instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'workerProcess', + undefined, + "Use 'worker' section to define the type of worker process model instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'workerStartDelay', + undefined, + "Use 'worker' section to define the worker start delay instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'chargingStationsPerWorker', + undefined, + "Use 'worker' section to define the number of element(s) per worker instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'elementStartDelay', + undefined, + "Use 'worker' section to define the worker's element start delay instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolMinSize', + undefined, + "Use 'worker' section to define the worker pool minimum size instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolSize;', + undefined, + "Use 'worker' section to define the worker pool maximum size instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolMaxSize;', + undefined, + "Use 'worker' section to define the worker pool maximum size instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolStrategy;', + undefined, + "Use 'worker' section to define the worker pool strategy instead" + ); + let workerConfiguration: WorkerConfiguration = { + processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') + ? Configuration.getConfig()?.workerProcess + : WorkerProcessType.workerSet, + startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') + ? Configuration.getConfig()?.workerStartDelay + : WorkerConstants.DEFAULT_WORKER_START_DELAY, + elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') + ? Configuration.getConfig()?.chargingStationsPerWorker + : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, + elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') + ? Configuration.getConfig()?.elementStartDelay + : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, + poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') + ? Configuration.getConfig()?.workerPoolMinSize + : WorkerConstants.DEFAULT_POOL_MIN_SIZE, + poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') + ? Configuration.getConfig()?.workerPoolMaxSize + : WorkerConstants.DEFAULT_POOL_MAX_SIZE, + poolStrategy: + Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, + }; + if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) { + workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; + } + return workerConfiguration; } - static getChargingStationsPerWorker(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER; + static getLogConsole(): boolean | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'consoleLog', + undefined, + "Use 'logConsole' instead" + ); + return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') + ? Configuration.getConfig()?.logConsole + : false; } - static getLogConsole(): boolean { - Configuration.warnDeprecatedConfigurationKey('consoleLog', null, 'Use \'logConsole\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; + static getLogFormat(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') + ? Configuration.getConfig()?.logFormat + : 'simple'; } - static getLogFormat(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple'; + static getLogRotate(): boolean | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') + ? Configuration.getConfig()?.logRotate + : true; } - static getLogRotate(): boolean { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true; + static getLogMaxFiles(): number | string | false | undefined { + return ( + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && + Configuration.getConfig()?.logMaxFiles + ); } - static getLogMaxFiles(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7; + static getLogMaxSize(): number | string | false | undefined { + return ( + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && + Configuration.getConfig()?.logMaxSize + ); } - static getLogLevel(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info'; + static getLogLevel(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') + ? Configuration.getConfig()?.logLevel?.toLowerCase() + : 'info'; } - static getLogFile(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log'; + static getLogFile(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logFile') + ? Configuration.getConfig()?.logFile + : 'combined.log'; } - static getLogErrorFile(): string { - Configuration.warnDeprecatedConfigurationKey('errorFile', null, 'Use \'logErrorFile\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; + static getLogErrorFile(): string | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'errorFile', + undefined, + "Use 'logErrorFile' instead" + ); + return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') + ? Configuration.getConfig()?.logErrorFile + : 'error.log'; } - static getSupervisionURLs(): string[] { + static getSupervisionUrls(): string | string[] | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'supervisionURLs', + undefined, + "Use 'supervisionUrls' instead" + ); + !Utils.isUndefined(Configuration.getConfig()['supervisionURLs']) && + (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as + | string + | string[]); // Read conf - return Configuration.getConfig().supervisionURLs; + return Configuration.getConfig()?.supervisionUrls; } - static getDistributeStationsToTenantsEqually(): boolean { - Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, 'Use \'distributeStationsToTenantsEqually\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true; + static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'distributeStationToTenantEqually', + undefined, + "Use 'supervisionUrlDistribution' instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'distributeStationsToTenantsEqually', + undefined, + "Use 'supervisionUrlDistribution' instead" + ); + return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution') + ? Configuration.getConfig()?.supervisionUrlDistribution + : SupervisionUrlDistribution.ROUND_ROBIN; } - private static logPrefix(): string { - return new Date().toLocaleString() + ' Simulator configuration |'; - } + 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}}`); + private static warnDeprecatedConfigurationKey( + key: string, + sectionName?: string, + logMsgToAppend = '' + ) { + if ( + sectionName && + !Utils.isUndefined(Configuration.getConfig()[sectionName]) && + !Utils.isUndefined((Configuration.getConfig()[sectionName] as Record)[key]) + ) { + console.error( + chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${ + logMsgToAppend.trim().length > 0 && `. ${logMsgToAppend}` + }}` + ); + } else if (!Utils.isUndefined(Configuration.getConfig()[key])) { + console.error( + chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${ + logMsgToAppend.trim().length > 0 && `. ${logMsgToAppend}` + }}` + ); } } // Read the config file - private static getConfig(): ConfigurationData { + private static getConfig(): ConfigurationData | null { if (!Configuration.configuration) { try { - Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData; + Configuration.configuration = JSON.parse( + fs.readFileSync(Configuration.configurationFile, 'utf8') + ) as ConfigurationData; } catch (error) { - Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error); + FileUtils.handleFileException( + Configuration.configurationFile, + FileType.Configuration, + error as NodeJS.ErrnoException, + Configuration.logPrefix(), + { consoleOut: true } + ); } if (!Configuration.configurationFileWatcher) { Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); @@ -160,52 +357,44 @@ export default class Configuration { return Configuration.configuration; } - private static getConfigurationFileWatcher(): fs.FSWatcher { + private static getConfigurationFileWatcher(): fs.FSWatcher | undefined { 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.configurationFile, (event, filename): void => { + if (filename?.trim().length > 0 && event === 'change') { + // Nullify to force configuration file reading + Configuration.configuration = null; + if (!Utils.isUndefined(Configuration.configurationChangeCallback)) { + Configuration.configurationChangeCallback().catch((error) => { + throw typeof error === 'string' ? new Error(error) : error; + }); + } } }); } catch (error) { - Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error); + FileUtils.handleFileException( + Configuration.configurationFile, + FileType.Configuration, + error as NodeJS.ErrnoException, + Configuration.logPrefix(), + { consoleOut: true } + ); } } - private static getDefaultPerformanceStorageURI(storageType: StorageType) { - const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`; + private static getDefaultPerformanceStorageUri(storageType: StorageType) { switch (storageType) { case StorageType.JSON_FILE: - return `file://${path.join(path.resolve(__dirname, '../../'), Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME)}`; + return `file://${path.join( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'), + Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME + )}`; case StorageType.SQLITE: - return `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`; + return `file://${path.join( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'), + `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db` + )}`; default: throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); } } - - private static objectHasOwnProperty(object: any, property: string): boolean { - 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; - } }