X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=ad8d328df83f1da34d864c59d5431b6b79539dbc;hb=769d3b106c5e4744487bc633da4e4ee93f8f1bf4;hp=544f4a1022ef625404470dfbf427ebcf30443f00;hpb=f74e97ac226b4cb166eafc4a3c38a6c1e8215cef;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 544f4a10..ad8d328d 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -10,6 +10,7 @@ import { hasOwnProp, isCFEnvironment, isNotEmptyString, isUndefined } from './Ut import { ApplicationProtocol, type ConfigurationData, + ConfigurationSection, FileType, type LogConfiguration, type StationTemplateUrl, @@ -19,14 +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'; -enum ConfigurationSection { - log = 'log', - performanceStorage = 'performanceStorage', - worker = 'worker', - uiServer = 'uiServer', -} +type ConfigurationSectionType = + | LogConfiguration + | StorageConfiguration + | WorkerConfiguration + | UIServerConfiguration; export class Configuration { private static configurationFile = join( @@ -35,14 +41,19 @@ export class Configuration { 'config.json', ); - private static configurationFileWatcher: FSWatcher | undefined; - private static configurationData: ConfigurationData | null = null; + private static configurationFileWatcher?: FSWatcher; + private static configurationData?: ConfigurationData; private static configurationSectionCache = new Map< ConfigurationSection, - LogConfiguration | StorageConfiguration | WorkerConfiguration | UIServerConfiguration - >(); + ConfigurationSectionType + >([ + [ConfigurationSection.log, Configuration.buildLogSection()], + [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()], + [ConfigurationSection.worker, Configuration.buildWorkerSection()], + [ConfigurationSection.uiServer, Configuration.buildUIServerSection()], + ]); - private static configurationChangeCallback: () => Promise; + private static configurationChangeCallback?: () => Promise; private constructor() { // This is intentional @@ -52,7 +63,146 @@ export class Configuration { Configuration.configurationChangeCallback = cb; } - public static getUIServer(): UIServerConfiguration { + public static getConfigurationSection( + sectionName: ConfigurationSection, + ): T { + if (!Configuration.isConfigurationSectionCached(sectionName)) { + Configuration.cacheConfigurationSection(sectionName); + } + 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 getStationTemplateUrls(): StationTemplateUrl[] | undefined { + Configuration.warnDeprecatedConfigurationKey( + 'stationTemplateURLs', + undefined, + "Use 'stationTemplateUrls' instead", + ); + // eslint-disable-next-line @typescript-eslint/dot-notation + !isUndefined( + Configuration.getConfigurationData()!['stationTemplateURLs' as keyof ConfigurationData], + ) && + (Configuration.getConfigurationData()!.stationTemplateUrls = + Configuration.getConfigurationData()![ + // eslint-disable-next-line @typescript-eslint/dot-notation + 'stationTemplateURLs' as keyof ConfigurationData + ] as StationTemplateUrl[]); + Configuration.getConfigurationData()!.stationTemplateUrls.forEach( + (stationTemplateUrl: StationTemplateUrl) => { + // eslint-disable-next-line @typescript-eslint/dot-notation + 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`, + )}`, + ); + } + }, + ); + 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' as keyof ConfigurationData], + ) + ) { + Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![ + // eslint-disable-next-line @typescript-eslint/dot-notation + '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; + } + + public static workerPoolInUse(): boolean { + return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes( + Configuration.buildWorkerSection().processType!, + ); + } + + public static workerDynamicPoolInUse(): boolean { + return Configuration.buildWorkerSection().processType === WorkerProcessType.dynamicPool; + } + + 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 { if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) { console.error( `${chalk.green(Configuration.logPrefix())} ${chalk.red( @@ -78,13 +228,10 @@ export class Configuration { delete uiServerConfiguration.options?.host; uiServerConfiguration.options!.port = parseInt(process.env.PORT!); } - return Configuration.getConfigurationSection( - ConfigurationSection.uiServer, - uiServerConfiguration, - ); + return uiServerConfiguration; } - public static getPerformanceStorage(): StorageConfiguration { + private static buildPerformanceStorageSection(): StorageConfiguration { Configuration.warnDeprecatedConfigurationKey( 'URI', ConfigurationSection.performanceStorage, @@ -93,7 +240,7 @@ export class Configuration { 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 = { @@ -108,62 +255,10 @@ export class Configuration { }), }; } - return Configuration.getConfigurationSection( - ConfigurationSection.performanceStorage, - storageConfiguration, - ); - } - - 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 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`, - )}`, - ); - } - }, - ); - return Configuration.getConfigurationData()?.stationTemplateUrls; + return storageConfiguration; } - public static getLog(): LogConfiguration { + private static buildLogSection(): LogConfiguration { Configuration.warnDeprecatedConfigurationKey( 'logEnabled', undefined, @@ -261,13 +356,10 @@ export class Configuration { ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.log) && Configuration.getConfigurationData()?.log), }; - return Configuration.getConfigurationSection( - ConfigurationSection.log, - logConfiguration, - ); + return logConfiguration; } - public static getWorker(): WorkerConfiguration { + private static buildWorkerSection(): WorkerConfiguration { Configuration.warnDeprecatedConfigurationKey( 'useWorkerPool', undefined, @@ -315,11 +407,11 @@ export class Configuration { ); const defaultWorkerConfiguration: WorkerConfiguration = { processType: WorkerProcessType.workerSet, - startDelay: WorkerConstants.DEFAULT_WORKER_START_DELAY, + startDelay: DEFAULT_WORKER_START_DELAY, elementsPerWorker: 'auto', - elementStartDelay: WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: WorkerConstants.DEFAULT_POOL_MAX_SIZE, + elementStartDelay: DEFAULT_ELEMENT_START_DELAY, + poolMinSize: DEFAULT_POOL_MIN_SIZE, + poolMaxSize: DEFAULT_POOL_MAX_SIZE, }; hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') && delete Configuration.getConfigurationData()?.workerPoolStrategy; @@ -359,52 +451,7 @@ export class Configuration { `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`, ); } - return Configuration.getConfigurationSection( - ConfigurationSection.worker, - workerConfiguration, - ); - } - - public static workerPoolInUse(): boolean { - return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes( - Configuration.getWorker().processType!, - ); - } - - public static workerDynamicPoolInUse(): boolean { - return Configuration.getWorker().processType === WorkerProcessType.dynamicPool; - } - - 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'])) { - Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![ - // eslint-disable-next-line @typescript-eslint/dot-notation - 'supervisionURLs' - ] 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; + return workerConfiguration; } private static logPrefix = (): string => { @@ -418,9 +465,14 @@ export class Configuration { ) { if ( sectionName && - !isUndefined(Configuration.getConfigurationData()![sectionName]) && + !isUndefined(Configuration.getConfigurationData()![sectionName as keyof ConfigurationData]) && !isUndefined( - (Configuration.getConfigurationData()![sectionName] as Record)[key], + ( + Configuration.getConfigurationData()![sectionName as keyof ConfigurationData] as Record< + string, + unknown + > + )[key], ) ) { console.error( @@ -430,7 +482,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${ @@ -441,22 +495,15 @@ export class Configuration { } } - private static getConfigurationSection( - sectionName: ConfigurationSection, - sectionConfiguration?: T, - ): T { - if (!Configuration.configurationSectionCache.has(sectionName) && sectionConfiguration) { - Configuration.configurationSectionCache.set(sectionName, sectionConfiguration); - } - return Configuration.configurationSectionCache.get(sectionName) as T; - } - - 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, @@ -465,9 +512,6 @@ export class Configuration { Configuration.logPrefix(), ); } - if (!Configuration.configurationFileWatcher) { - Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); - } } return Configuration.configurationData; } @@ -476,11 +520,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; }); }