X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=7d5b217d5faafa331c8b16ae4768e65003e9c691;hb=617cad0c86c3fea53b56a738bb0d6ddc3da05237;hp=f4eb39ad62ae287667e82355255a9f30ca2dbca4;hpb=1f7fa4de53a1b28324f362402f61b81b28d75c2c;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index f4eb39ad..7d5b217d 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,33 +1,36 @@ -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; +import fs from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; import chalk from 'chalk'; - -import ConfigurationData, { - StationTemplateUrl, - StorageConfiguration, +import merge from 'just-merge'; +import { WorkerChoiceStrategies } from 'poolifier'; + +// 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, - UIServerConfiguration, - WorkerConfiguration, -} from '../types/ConfigurationData'; -import { EmptyObject } from '../types/EmptyObject'; -import { HandleErrorParams } from '../types/Error'; -import { FileType } from '../types/FileType'; -import { StorageType } from '../types/Storage'; -import { ApplicationProtocol } from '../types/UIProtocol'; -import { WorkerProcessType } from '../types/Worker'; -import WorkerConstants from '../worker/WorkerConstants'; -import Constants from './Constants'; + type UIServerConfiguration, + type WorkerConfiguration, +} from '../types'; +import { WorkerConstants, WorkerProcessType } from '../worker'; -export default class Configuration { +export class Configuration { private static configurationFile = path.join( path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), 'assets', 'config.json' ); - private static configurationFileWatcher: fs.FSWatcher; + private static configurationFileWatcher: fs.FSWatcher | undefined; private static configuration: ConfigurationData | null = null; private static configurationChangeCallback: () => Promise; @@ -39,38 +42,42 @@ export default class Configuration { Configuration.configurationChangeCallback = cb; } - static getLogStatisticsInterval(): number { + static getLogStatisticsInterval(): number | undefined { Configuration.warnDeprecatedConfigurationKey( 'statisticsDisplayInterval', - null, + undefined, "Use 'logStatisticsInterval' instead" ); // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') - ? Configuration.getConfig().logStatisticsInterval + return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') + ? Configuration.getConfig()?.logStatisticsInterval : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; } static getUIServer(): UIServerConfiguration { - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) { + 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: true, + enabled: false, type: ApplicationProtocol.WS, options: { - host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST, - port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT, + host: Constants.DEFAULT_UI_SERVER_HOST, + port: Constants.DEFAULT_UI_SERVER_PORT, }, }; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) { - uiServerConfiguration = Configuration.deepMerge( + if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) { + uiServerConfiguration = merge( uiServerConfiguration, - Configuration.getConfig().uiServer + Configuration.getConfig()?.uiServer ); } + if (Utils.isCFEnvironment() === true) { + delete uiServerConfiguration.options?.host; + uiServerConfiguration.options.port = parseInt(process.env.PORT); + } return uiServerConfiguration; } @@ -81,49 +88,49 @@ export default class Configuration { type: StorageType.JSON_FILE, uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE), }; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'performanceStorage')) { storageConfiguration = { ...storageConfiguration, - ...Configuration.getConfig().performanceStorage, + ...Configuration.getConfig()?.performanceStorage, }; } return storageConfiguration; } - static getAutoReconnectMaxRetries(): number { + static getAutoReconnectMaxRetries(): number | undefined { Configuration.warnDeprecatedConfigurationKey( 'autoReconnectTimeout', - null, + undefined, "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead" ); Configuration.warnDeprecatedConfigurationKey( 'connectionTimeout', - null, + undefined, "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead" ); Configuration.warnDeprecatedConfigurationKey( 'autoReconnectMaxRetries', - null, + 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[] { + static getStationTemplateUrls(): StationTemplateUrl[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'stationTemplateURLs', - null, + undefined, "Use 'stationTemplateUrls' instead" ); - !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && + !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[ 'stationTemplateURLs' ] as StationTemplateUrl[]); Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => { - if (!Configuration.isUndefined(stationUrl['numberOfStation'])) { + if (!Utils.isUndefined(stationUrl['numberOfStation'])) { console.error( chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${ stationUrl.file @@ -132,174 +139,176 @@ export default class Configuration { } }); // Read conf - return Configuration.getConfig().stationTemplateUrls; + return Configuration.getConfig()?.stationTemplateUrls; } static getWorker(): WorkerConfiguration { Configuration.warnDeprecatedConfigurationKey( 'useWorkerPool', - null, + undefined, "Use 'worker' section to define the type of worker process model instead" ); Configuration.warnDeprecatedConfigurationKey( 'workerProcess', - null, + undefined, "Use 'worker' section to define the type of worker process model instead" ); Configuration.warnDeprecatedConfigurationKey( 'workerStartDelay', - null, + undefined, "Use 'worker' section to define the worker start delay instead" ); Configuration.warnDeprecatedConfigurationKey( 'chargingStationsPerWorker', - null, + undefined, "Use 'worker' section to define the number of element(s) per worker instead" ); Configuration.warnDeprecatedConfigurationKey( 'elementStartDelay', - null, + undefined, "Use 'worker' section to define the worker's element start delay instead" ); Configuration.warnDeprecatedConfigurationKey( 'workerPoolMinSize', - null, + undefined, "Use 'worker' section to define the worker pool minimum size instead" ); Configuration.warnDeprecatedConfigurationKey( 'workerPoolSize;', - null, + undefined, "Use 'worker' section to define the worker pool maximum size instead" ); Configuration.warnDeprecatedConfigurationKey( 'workerPoolMaxSize;', - null, + undefined, "Use 'worker' section to define the worker pool maximum size instead" ); Configuration.warnDeprecatedConfigurationKey( 'workerPoolStrategy;', - null, + undefined, "Use 'worker' section to define the worker pool strategy instead" ); let workerConfiguration: WorkerConfiguration = { - processType: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') - ? Configuration.getConfig().workerProcess - : WorkerProcessType.WORKER_SET, - startDelay: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') - ? Configuration.getConfig().workerStartDelay + 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: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'chargingStationsPerWorker' - ) - ? Configuration.getConfig().chargingStationsPerWorker + elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') + ? Configuration.getConfig()?.chargingStationsPerWorker : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, - elementStartDelay: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'elementStartDelay' - ) - ? Configuration.getConfig().elementStartDelay + elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') + ? Configuration.getConfig()?.elementStartDelay : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'workerPoolMinSize' - ) - ? Configuration.getConfig().workerPoolMinSize + poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') + ? Configuration.getConfig()?.workerPoolMinSize : WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'workerPoolMaxSize' - ) - ? Configuration.getConfig().workerPoolMaxSize + poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') + ? Configuration.getConfig()?.workerPoolMaxSize : WorkerConstants.DEFAULT_POOL_MAX_SIZE, - poolStrategy: Configuration.getConfig().workerPoolStrategy, + poolStrategy: + Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, }; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'worker')) { - workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig().worker }; + if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) { + workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; } return workerConfiguration; } - static getLogConsole(): boolean { - Configuration.warnDeprecatedConfigurationKey('consoleLog', null, "Use 'logConsole' instead"); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') - ? Configuration.getConfig().logConsole + static getLogConsole(): boolean | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'consoleLog', + undefined, + "Use 'logConsole' instead" + ); + return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') + ? Configuration.getConfig()?.logConsole : false; } - static getLogFormat(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') - ? Configuration.getConfig().logFormat + static getLogFormat(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') + ? Configuration.getConfig()?.logFormat : 'simple'; } - static getLogRotate(): boolean { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') - ? Configuration.getConfig().logRotate + static getLogRotate(): boolean | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') + ? Configuration.getConfig()?.logRotate : true; } - static getLogMaxFiles(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') - ? Configuration.getConfig().logMaxFiles - : 7; + static getLogMaxFiles(): number | string | false | undefined { + return ( + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && + Configuration.getConfig()?.logMaxFiles + ); + } + + 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.toLowerCase() + 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 + 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 + 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 | string[] { + static getSupervisionUrls(): string | string[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'supervisionURLs', - null, + undefined, "Use 'supervisionUrls' instead" ); - !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) && - (Configuration.getConfig().supervisionUrls = Configuration.getConfig()[ - 'supervisionURLs' - ] as string[]); + !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 getSupervisionUrlDistribution(): SupervisionUrlDistribution { + static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { Configuration.warnDeprecatedConfigurationKey( 'distributeStationToTenantEqually', - null, + undefined, "Use 'supervisionUrlDistribution' instead" ); Configuration.warnDeprecatedConfigurationKey( 'distributeStationsToTenantsEqually', - null, + undefined, "Use 'supervisionUrlDistribution' instead" ); - return Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'supervisionUrlDistribution' - ) - ? Configuration.getConfig().supervisionUrlDistribution + 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, @@ -308,38 +317,37 @@ export default class Configuration { ) { if ( sectionName && - !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && - !Configuration.isUndefined( - (Configuration.getConfig()[sectionName] as Record)[key] - ) + !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 && '. ' + logMsgToAppend + logMsgToAppend.trim().length > 0 && `. ${logMsgToAppend}` }}` ); - } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) { + } else if (!Utils.isUndefined(Configuration.getConfig()[key])) { console.error( chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${ - logMsgToAppend && '. ' + logMsgToAppend + 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.configurationFile, 'utf8') ) as ConfigurationData; } catch (error) { - Configuration.handleFileException( - Configuration.logPrefix(), - FileType.Configuration, + FileUtils.handleFileException( Configuration.configurationFile, - error as NodeJS.ErrnoException + FileType.Configuration, + error as NodeJS.ErrnoException, + Configuration.logPrefix(), + { consoleOut: true } ); } if (!Configuration.configurationFileWatcher) { @@ -349,13 +357,13 @@ export default class Configuration { return Configuration.configuration; } - private static getConfigurationFileWatcher(): fs.FSWatcher { + private static getConfigurationFileWatcher(): fs.FSWatcher | undefined { try { return fs.watch(Configuration.configurationFile, (event, filename): void => { - if (filename && event === 'change') { + if (filename?.trim().length > 0 && event === 'change') { // Nullify to force configuration file reading Configuration.configuration = null; - if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { + if (!Utils.isUndefined(Configuration.configurationChangeCallback)) { Configuration.configurationChangeCallback().catch((error) => { throw typeof error === 'string' ? new Error(error) : error; }); @@ -363,17 +371,17 @@ export default class Configuration { } }); } catch (error) { - Configuration.handleFileException( - Configuration.logPrefix(), - FileType.Configuration, + FileUtils.handleFileException( Configuration.configurationFile, - error as NodeJS.ErrnoException + FileType.Configuration, + error as NodeJS.ErrnoException, + Configuration.logPrefix(), + { consoleOut: true } ); } } private static getDefaultPerformanceStorageUri(storageType: StorageType) { - const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`; switch (storageType) { case StorageType.JSON_FILE: return `file://${path.join( @@ -383,79 +391,10 @@ export default class Configuration { case StorageType.SQLITE: return `file://${path.join( path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'), - SQLiteFileName + `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db` )}`; default: throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); } } - - private static isObject(item): boolean { - return item && typeof item === 'object' && Array.isArray(item) === false; - } - - private static deepMerge(target: object, ...sources: object[]): object { - if (!sources.length) { - return target; - } - const source = sources.shift(); - - if (Configuration.isObject(target) && Configuration.isObject(source)) { - for (const key in source) { - if (Configuration.isObject(source[key])) { - if (!target[key]) { - Object.assign(target, { [key]: {} }); - } - // eslint-disable-next-line @typescript-eslint/no-unsafe-argument - Configuration.deepMerge(target[key], source[key]); - } else { - // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment - Object.assign(target, { [key]: source[key] }); - } - } - } - return Configuration.deepMerge(target, ...sources); - } - - private static objectHasOwnProperty(object: unknown, property: string): boolean { - return Object.prototype.hasOwnProperty.call(object, property) as boolean; - } - - private static isUndefined(obj: unknown): boolean { - return typeof obj === 'undefined'; - } - - private static handleFileException( - logPrefix: string, - fileType: FileType, - filePath: string, - error: NodeJS.ErrnoException, - params: HandleErrorParams = { throwError: true } - ): 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 - ); - } - if (params?.throwError) { - throw error; - } - } }