X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=57e2943642bbdab9b163fa127cc83eb539b68cde;hb=0898a067b2130b9a63a7aa3f79e460ddd570b7cb;hp=ae3d8e9f186aeb47e89d71a97db1f84273c87cf5;hpb=c831d2bcf192839310f736ab508a0050eec451ea;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index ae3d8e9f..57e29436 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -6,7 +6,7 @@ import chalk from 'chalk'; import merge from 'just-merge'; import { Constants } from './Constants'; -import { hasOwnProp, isCFEnvironment, isNotEmptyString, isUndefined } from './Utils'; +import { hasOwnProp, isCFEnvironment, isNotEmptyString, isUndefined, once } from './Utils'; import { ApplicationProtocol, type ConfigurationData, @@ -20,7 +20,19 @@ import { type UIServerConfiguration, type WorkerConfiguration, } from '../types'; -import { WorkerConstants, WorkerProcessType } from '../worker'; +import { + DEFAULT_ELEMENT_START_DELAY, + DEFAULT_POOL_MAX_SIZE, + DEFAULT_POOL_MIN_SIZE, + DEFAULT_WORKER_START_DELAY, + WorkerProcessType, +} from '../worker'; + +type ConfigurationSectionType = + | LogConfiguration + | StorageConfiguration + | WorkerConfiguration + | UIServerConfiguration; export class Configuration { private static configurationFile = join( @@ -29,11 +41,11 @@ export class Configuration { 'config.json', ); - private static configurationFileWatcher: FSWatcher | undefined; - private static configurationData: ConfigurationData | null = null; + private static configurationData?: ConfigurationData; + private static configurationFileWatcher?: FSWatcher; private static configurationSectionCache = new Map< ConfigurationSection, - LogConfiguration | StorageConfiguration | WorkerConfiguration | UIServerConfiguration + ConfigurationSectionType >([ [ConfigurationSection.log, Configuration.buildLogSection()], [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()], @@ -41,7 +53,9 @@ export class Configuration { [ConfigurationSection.uiServer, Configuration.buildUIServerSection()], ]); - private static configurationChangeCallback: () => Promise; + private static warnDeprecatedConfigurationKeys = false; + + private static configurationChangeCallback?: () => Promise; private constructor() { // This is intentional @@ -51,86 +65,38 @@ export class Configuration { Configuration.configurationChangeCallback = cb; } - public static getConfigurationSection(sectionName: ConfigurationSection): T { - return Configuration.configurationSectionCache.get(sectionName) as T; - } - - public 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', - ); - if (hasOwnProp(Configuration.getConfigurationData(), 'autoReconnectMaxRetries')) { - return Configuration.getConfigurationData()?.autoReconnectMaxRetries; + public static getConfigurationSection( + sectionName: ConfigurationSection, + ): T { + if (!Configuration.isConfigurationSectionCached(sectionName)) { + Configuration.cacheConfigurationSection(sectionName); } + return Configuration.configurationSectionCache.get(sectionName) as T; } public static getStationTemplateUrls(): StationTemplateUrl[] | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'stationTemplateURLs', - undefined, - "Use 'stationTemplateUrls' instead", - ); - // eslint-disable-next-line @typescript-eslint/dot-notation - !isUndefined(Configuration.getConfigurationData()!['stationTemplateURLs']) && - (Configuration.getConfigurationData()!.stationTemplateUrls = - Configuration.getConfigurationData()![ - // eslint-disable-next-line @typescript-eslint/dot-notation - 'stationTemplateURLs' - ] as StationTemplateUrl[]); - Configuration.getConfigurationData()!.stationTemplateUrls.forEach( - (stationTemplateUrl: StationTemplateUrl) => { - // eslint-disable-next-line @typescript-eslint/dot-notation - if (!isUndefined(stationTemplateUrl['numberOfStation'])) { - console.error( - `${chalk.green(Configuration.logPrefix())} ${chalk.red( - `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`, - )}`, - ); - } - }, + const checkDeprecatedConfigurationKeysOnce = once( + Configuration.checkDeprecatedConfigurationKeys.bind(Configuration), + Configuration, ); + checkDeprecatedConfigurationKeysOnce(); return Configuration.getConfigurationData()?.stationTemplateUrls; } public static getSupervisionUrls(): string | string[] | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'supervisionURLs', - undefined, - "Use 'supervisionUrls' instead", - ); - // eslint-disable-next-line @typescript-eslint/dot-notation - if (!isUndefined(Configuration.getConfigurationData()!['supervisionURLs'])) { + if ( + !isUndefined( + Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData], + ) + ) { Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![ - // eslint-disable-next-line @typescript-eslint/dot-notation - 'supervisionURLs' + 'supervisionURLs' as keyof ConfigurationData ] as string | string[]; } return Configuration.getConfigurationData()?.supervisionUrls; } public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'distributeStationToTenantEqually', - undefined, - "Use 'supervisionUrlDistribution' instead", - ); - Configuration.warnDeprecatedConfigurationKey( - 'distributeStationsToTenantsEqually', - undefined, - "Use 'supervisionUrlDistribution' instead", - ); return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution') ? Configuration.getConfigurationData()?.supervisionUrlDistribution : SupervisionUrlDistribution.ROUND_ROBIN; @@ -138,22 +104,52 @@ export class Configuration { public static workerPoolInUse(): boolean { return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes( - Configuration.buildWorkerSection().processType!, + Configuration.getConfigurationSection(ConfigurationSection.worker) + .processType!, ); } public static workerDynamicPoolInUse(): boolean { - return Configuration.buildWorkerSection().processType === WorkerProcessType.dynamicPool; + return ( + Configuration.getConfigurationSection(ConfigurationSection.worker) + .processType === WorkerProcessType.dynamicPool + ); } - private static buildUIServerSection(): UIServerConfiguration { - if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) { - console.error( - `${chalk.green(Configuration.logPrefix())} ${chalk.red( - `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`, - )}`, - ); + private static isConfigurationSectionCached(sectionName: ConfigurationSection): boolean { + return Configuration.configurationSectionCache.has(sectionName); + } + + private static cacheConfigurationSection(sectionName: ConfigurationSection): void { + switch (sectionName) { + case ConfigurationSection.log: + Configuration.configurationSectionCache.set(sectionName, Configuration.buildLogSection()); + break; + case ConfigurationSection.performanceStorage: + Configuration.configurationSectionCache.set( + sectionName, + Configuration.buildPerformanceStorageSection(), + ); + break; + case ConfigurationSection.worker: + Configuration.configurationSectionCache.set( + sectionName, + Configuration.buildWorkerSection(), + ); + break; + case ConfigurationSection.uiServer: + Configuration.configurationSectionCache.set( + sectionName, + Configuration.buildUIServerSection(), + ); + break; + default: + // eslint-disable-next-line @typescript-eslint/restrict-template-expressions + throw new Error(`Unknown configuration section '${sectionName}'`); } + } + + private static buildUIServerSection(): UIServerConfiguration { let uiServerConfiguration: UIServerConfiguration = { enabled: false, type: ApplicationProtocol.WS, @@ -176,15 +172,10 @@ export class Configuration { } private static buildPerformanceStorageSection(): StorageConfiguration { - Configuration.warnDeprecatedConfigurationKey( - 'URI', - ConfigurationSection.performanceStorage, - "Use 'uri' instead", - ); let storageConfiguration: StorageConfiguration = { enabled: false, type: StorageType.JSON_FILE, - uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE), + uri: Configuration.getDefaultPerformanceStorageUri(StorageType.JSON_FILE), }; if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.performanceStorage)) { storageConfiguration = { @@ -203,56 +194,6 @@ export class Configuration { } private static buildLogSection(): LogConfiguration { - Configuration.warnDeprecatedConfigurationKey( - 'logEnabled', - undefined, - `Use '${ConfigurationSection.log}' section to define the logging enablement instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logFile', - undefined, - `Use '${ConfigurationSection.log}' section to define the log file instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logErrorFile', - undefined, - `Use '${ConfigurationSection.log}' section to define the log error file instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logConsole', - undefined, - `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logStatisticsInterval', - undefined, - `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logLevel', - undefined, - `Use '${ConfigurationSection.log}' section to define the log level instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logFormat', - undefined, - `Use '${ConfigurationSection.log}' section to define the log format instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logRotate', - undefined, - `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logMaxFiles', - undefined, - `Use '${ConfigurationSection.log}' section to define the log maximum files instead`, - ); - Configuration.warnDeprecatedConfigurationKey( - 'logMaxSize', - undefined, - `Use '${ConfigurationSection.log}' section to define the log maximum size instead`, - ); const defaultLogConfiguration: LogConfiguration = { enabled: true, file: 'logs/combined.log', @@ -304,6 +245,117 @@ export class Configuration { } private static buildWorkerSection(): WorkerConfiguration { + const defaultWorkerConfiguration: WorkerConfiguration = { + processType: WorkerProcessType.workerSet, + startDelay: DEFAULT_WORKER_START_DELAY, + elementsPerWorker: 'auto', + elementStartDelay: DEFAULT_ELEMENT_START_DELAY, + poolMinSize: DEFAULT_POOL_MIN_SIZE, + poolMaxSize: DEFAULT_POOL_MAX_SIZE, + }; + const deprecatedWorkerConfiguration: WorkerConfiguration = { + ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && { + processType: Configuration.getConfigurationData()?.workerProcess, + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && { + startDelay: Configuration.getConfigurationData()?.workerStartDelay, + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && { + elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker, + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && { + elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay, + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && { + poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize, + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && { + poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize, + }), + }; + hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') && + delete Configuration.getConfigurationData()?.workerPoolStrategy; + const workerConfiguration: WorkerConfiguration = { + ...defaultWorkerConfiguration, + ...deprecatedWorkerConfiguration, + ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) && + Configuration.getConfigurationData()?.worker), + }; + if (!Object.values(WorkerProcessType).includes(workerConfiguration.processType!)) { + throw new SyntaxError( + `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`, + ); + } + return workerConfiguration; + } + + private static logPrefix = (): string => { + return `${new Date().toLocaleString()} Simulator configuration |`; + }; + + private static checkDeprecatedConfigurationKeys() { + if (Configuration.warnDeprecatedConfigurationKeys) { + return; + } + // connection timeout + 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", + ); + // connection retries + Configuration.warnDeprecatedConfigurationKey( + 'autoReconnectMaxRetries', + undefined, + 'Use it in charging station template instead', + ); + // station template url(s) + Configuration.warnDeprecatedConfigurationKey( + 'stationTemplateURLs', + undefined, + "Use 'stationTemplateUrls' instead", + ); + !isUndefined( + Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData], + ) && + (Configuration.getConfigurationData()!.stationTemplateUrls = + Configuration.getConfigurationData()![ + 'stationTemplateURLs' as keyof ConfigurationData + ] as StationTemplateUrl[]); + Configuration.getConfigurationData()?.stationTemplateUrls.forEach( + (stationTemplateUrl: StationTemplateUrl) => { + if (!isUndefined(stationTemplateUrl?.['numberOfStation' as keyof StationTemplateUrl])) { + console.error( + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`, + )}`, + ); + } + }, + ); + // supervision url(s) + Configuration.warnDeprecatedConfigurationKey( + 'supervisionURLs', + undefined, + "Use 'supervisionUrls' instead", + ); + // supervision urls distribution + Configuration.warnDeprecatedConfigurationKey( + 'distributeStationToTenantEqually', + undefined, + "Use 'supervisionUrlDistribution' instead", + ); + Configuration.warnDeprecatedConfigurationKey( + 'distributeStationsToTenantsEqually', + undefined, + "Use 'supervisionUrlDistribution' instead", + ); + // worker section Configuration.warnDeprecatedConfigurationKey( 'useWorkerPool', undefined, @@ -349,59 +401,79 @@ export class Configuration { undefined, `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`, ); - const defaultWorkerConfiguration: WorkerConfiguration = { - processType: WorkerProcessType.workerSet, - startDelay: WorkerConstants.DEFAULT_WORKER_START_DELAY, - elementsPerWorker: 'auto', - elementStartDelay: WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: WorkerConstants.DEFAULT_POOL_MAX_SIZE, - }; - hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') && - delete Configuration.getConfigurationData()?.workerPoolStrategy; - const deprecatedWorkerConfiguration: WorkerConfiguration = { - ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && { - processType: Configuration.getConfigurationData()?.workerProcess, - }), - ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && { - startDelay: Configuration.getConfigurationData()?.workerStartDelay, - }), - ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && { - elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker, - }), - ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && { - elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay, - }), - ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && { - poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize, - }), - ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && { - poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize, - }), - }; Configuration.warnDeprecatedConfigurationKey( 'poolStrategy', ConfigurationSection.worker, 'Not publicly exposed to end users', ); - const workerConfiguration: WorkerConfiguration = { - ...defaultWorkerConfiguration, - ...deprecatedWorkerConfiguration, - ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) && - Configuration.getConfigurationData()?.worker), - }; - if (!Object.values(WorkerProcessType).includes(workerConfiguration.processType!)) { - throw new SyntaxError( - `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`, + // log section + Configuration.warnDeprecatedConfigurationKey( + 'logEnabled', + undefined, + `Use '${ConfigurationSection.log}' section to define the logging enablement instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logFile', + undefined, + `Use '${ConfigurationSection.log}' section to define the log file instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logErrorFile', + undefined, + `Use '${ConfigurationSection.log}' section to define the log error file instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logConsole', + undefined, + `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logStatisticsInterval', + undefined, + `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logLevel', + undefined, + `Use '${ConfigurationSection.log}' section to define the log level instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logFormat', + undefined, + `Use '${ConfigurationSection.log}' section to define the log format instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logRotate', + undefined, + `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logMaxFiles', + undefined, + `Use '${ConfigurationSection.log}' section to define the log maximum files instead`, + ); + Configuration.warnDeprecatedConfigurationKey( + 'logMaxSize', + undefined, + `Use '${ConfigurationSection.log}' section to define the log maximum size instead`, + ); + // performanceStorage section + Configuration.warnDeprecatedConfigurationKey( + 'URI', + ConfigurationSection.performanceStorage, + "Use 'uri' instead", + ); + // uiServer section + if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) { + console.error( + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`, + )}`, ); } - return workerConfiguration; + Configuration.warnDeprecatedConfigurationKeys = true; } - private static logPrefix = (): string => { - return `${new Date().toLocaleString()} Simulator configuration |`; - }; - private static warnDeprecatedConfigurationKey( key: string, sectionName?: string, @@ -409,9 +481,16 @@ export class Configuration { ) { if ( sectionName && - !isUndefined(Configuration.getConfigurationData()![sectionName]) && !isUndefined( - (Configuration.getConfigurationData()![sectionName] as Record)[key], + Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData], + ) && + !isUndefined( + ( + Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] as Record< + string, + unknown + > + )?.[key], ) ) { console.error( @@ -421,7 +500,9 @@ export class Configuration { }`, )}`, ); - } else if (!isUndefined(Configuration.getConfigurationData()![key])) { + } else if ( + !isUndefined(Configuration.getConfigurationData()?.[key as keyof ConfigurationData]) + ) { console.error( `${chalk.green(Configuration.logPrefix())} ${chalk.red( `Deprecated configuration key '${key}' usage${ @@ -432,12 +513,15 @@ export class Configuration { } } - private static getConfigurationData(): ConfigurationData | null { + private static getConfigurationData(): ConfigurationData | undefined { if (!Configuration.configurationData) { try { Configuration.configurationData = JSON.parse( readFileSync(Configuration.configurationFile, 'utf8'), ) as ConfigurationData; + if (!Configuration.configurationFileWatcher) { + Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); + } } catch (error) { Configuration.handleFileException( Configuration.configurationFile, @@ -446,9 +530,6 @@ export class Configuration { Configuration.logPrefix(), ); } - if (!Configuration.configurationFileWatcher) { - Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); - } } return Configuration.configurationData; } @@ -457,11 +538,10 @@ export class Configuration { try { return watch(Configuration.configurationFile, (event, filename): void => { if (filename!.trim()!.length > 0 && event === 'change') { - // Nullify to force configuration file reading - Configuration.configurationData = null; + delete Configuration.configurationData; Configuration.configurationSectionCache.clear(); if (!isUndefined(Configuration.configurationChangeCallback)) { - Configuration.configurationChangeCallback().catch((error) => { + Configuration.configurationChangeCallback!().catch((error) => { throw typeof error === 'string' ? new Error(error) : error; }); } @@ -516,7 +596,7 @@ export class Configuration { `${Constants.DEFAULT_PERFORMANCE_DIRECTORY}/${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`, ); default: - throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); + throw new Error(`Unsupported storage type '${storageType}'`); } }