X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=5df7bdc5521debb1091388c38620497fa1eee96b;hb=8f8f87c4fd9a0863d0aeb4a9a8671d1a2b4308e0;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..25a1475b 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,461 +1,608 @@ -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; - -import chalk from 'chalk'; - -import ConfigurationData, { - StationTemplateUrl, - StorageConfiguration, +import { type FSWatcher, readFileSync, watch } from 'node:fs' +import { dirname, join } from 'node:path' +import { env } from 'node:process' +import { fileURLToPath } from 'node:url' + +import chalk from 'chalk' +import { mergeDeepRight, once } from 'rambda' + +import { + ApplicationProtocol, + ApplicationProtocolVersion, + type ConfigurationData, + ConfigurationSection, + FileType, + type LogConfiguration, + 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'; - -export default class Configuration { - private static configurationFile = path.join( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), + type UIServerConfiguration, + type WorkerConfiguration +} from '../types/index.js' +import { + DEFAULT_ELEMENT_ADD_DELAY, + DEFAULT_POOL_MAX_SIZE, + DEFAULT_POOL_MIN_SIZE, + DEFAULT_WORKER_START_DELAY, + WorkerProcessType +} from '../worker/index.js' +import { + buildPerformanceUriFilePath, + checkWorkerElementsPerWorker, + checkWorkerProcessType, + getDefaultPerformanceStorageUri, + handleFileException, + logPrefix +} from './ConfigurationUtils.js' +import { Constants } from './Constants.js' +import { hasOwnProp, isCFEnvironment } from './Utils.js' + +type ConfigurationSectionType = + | LogConfiguration + | StorageConfiguration + | WorkerConfiguration + | UIServerConfiguration + +// eslint-disable-next-line @typescript-eslint/no-extraneous-class +export class Configuration { + public static configurationChangeCallback?: () => Promise + + private static readonly configurationFile = join( + dirname(fileURLToPath(import.meta.url)), 'assets', 'config.json' - ); + ) + + private static configurationFileReloading = false + private static configurationData?: ConfigurationData + private static configurationFileWatcher?: FSWatcher + private static readonly configurationSectionCache = new Map< + ConfigurationSection, + ConfigurationSectionType + >([ + [ConfigurationSection.log, Configuration.buildLogSection()], + [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()], + [ConfigurationSection.worker, Configuration.buildWorkerSection()], + [ConfigurationSection.uiServer, Configuration.buildUIServerSection()] + ]) + + private constructor () { + // This is intentional + } - private static configurationFileWatcher: fs.FSWatcher; - private static configuration: ConfigurationData | null = null; - private static configurationChangeCallback: () => Promise; + public static getConfigurationSection( + sectionName: ConfigurationSection + ): T { + if (!Configuration.isConfigurationSectionCached(sectionName)) { + Configuration.cacheConfigurationSection(sectionName) + } + return Configuration.configurationSectionCache.get(sectionName) as T + } - private constructor() { - // This is intentional + public static getStationTemplateUrls (): StationTemplateUrl[] | undefined { + const checkDeprecatedConfigurationKeysOnce = once( + Configuration.checkDeprecatedConfigurationKeys.bind(Configuration) + ) + checkDeprecatedConfigurationKeysOnce() + return Configuration.getConfigurationData()?.stationTemplateUrls } - static setConfigurationChangeCallback(cb: () => Promise): void { - Configuration.configurationChangeCallback = cb; + public static getSupervisionUrls (): string | string[] | undefined { + if ( + Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData] != null + ) { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![ + 'supervisionURLs' as keyof ConfigurationData + ] as string | string[] + } + return Configuration.getConfigurationData()?.supervisionUrls } - static getLogStatisticsInterval(): number { - Configuration.warnDeprecatedConfigurationKey( - 'statisticsDisplayInterval', - null, - "Use 'logStatisticsInterval' instead" - ); - // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') - ? Configuration.getConfig().logStatisticsInterval - : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; + public static getSupervisionUrlDistribution (): SupervisionUrlDistribution | undefined { + return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution') + ? Configuration.getConfigurationData()?.supervisionUrlDistribution + : SupervisionUrlDistribution.ROUND_ROBIN } - static getUIServer(): UIServerConfiguration { - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) { - console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead}` - ); + public static workerPoolInUse (): boolean { + return [WorkerProcessType.dynamicPool, WorkerProcessType.fixedPool].includes( + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + Configuration.getConfigurationSection(ConfigurationSection.worker) + .processType! + ) + } + + public static workerDynamicPoolInUse (): boolean { + return ( + Configuration.getConfigurationSection(ConfigurationSection.worker) + .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 { let uiServerConfiguration: UIServerConfiguration = { - enabled: true, + enabled: false, type: ApplicationProtocol.WS, + version: ApplicationProtocolVersion.VERSION_11, options: { - host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST, - port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT, - }, - }; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) { - uiServerConfiguration = Configuration.deepMerge( + host: Constants.DEFAULT_UI_SERVER_HOST, + port: Constants.DEFAULT_UI_SERVER_PORT + } + } + if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) { + uiServerConfiguration = mergeDeepRight( uiServerConfiguration, - Configuration.getConfig().uiServer - ); + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + Configuration.getConfigurationData()!.uiServer! + ) + } + if (isCFEnvironment()) { + delete uiServerConfiguration.options?.host + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + uiServerConfiguration.options!.port = parseInt(env.PORT!) } - return uiServerConfiguration; + return uiServerConfiguration } - 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')) { + private static buildPerformanceStorageSection (): StorageConfiguration { + let storageConfiguration: StorageConfiguration + switch (Configuration.getConfigurationData()?.performanceStorage?.type) { + case StorageType.SQLITE: + storageConfiguration = { + enabled: false, + type: StorageType.SQLITE, + uri: getDefaultPerformanceStorageUri(StorageType.SQLITE) + } + break + case StorageType.JSON_FILE: + storageConfiguration = { + enabled: false, + type: StorageType.JSON_FILE, + uri: getDefaultPerformanceStorageUri(StorageType.JSON_FILE) + } + break + case StorageType.NONE: + default: + storageConfiguration = { + enabled: true, + type: StorageType.NONE + } + break + } + if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.performanceStorage)) { storageConfiguration = { ...storageConfiguration, - ...Configuration.getConfig().performanceStorage, - }; + ...Configuration.getConfigurationData()?.performanceStorage, + ...((Configuration.getConfigurationData()?.performanceStorage?.type === + StorageType.JSON_FILE || + Configuration.getConfigurationData()?.performanceStorage?.type === StorageType.SQLITE) && + Configuration.getConfigurationData()?.performanceStorage?.uri != null && { + uri: buildPerformanceUriFilePath( + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + new URL(Configuration.getConfigurationData()!.performanceStorage!.uri!).pathname + ) + }) + } + } + return storageConfiguration + } + + private static buildLogSection (): LogConfiguration { + const defaultLogConfiguration: LogConfiguration = { + enabled: true, + file: 'logs/combined.log', + errorFile: 'logs/error.log', + statisticsInterval: Constants.DEFAULT_LOG_STATISTICS_INTERVAL, + level: 'info', + format: 'simple', + rotate: true + } + const deprecatedLogConfiguration: LogConfiguration = { + ...(hasOwnProp(Configuration.getConfigurationData(), 'logEnabled') && { + enabled: Configuration.getConfigurationData()?.logEnabled + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logFile') && { + file: Configuration.getConfigurationData()?.logFile + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logErrorFile') && { + errorFile: Configuration.getConfigurationData()?.logErrorFile + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logStatisticsInterval') && { + statisticsInterval: Configuration.getConfigurationData()?.logStatisticsInterval + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logLevel') && { + level: Configuration.getConfigurationData()?.logLevel + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logConsole') && { + console: Configuration.getConfigurationData()?.logConsole + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logFormat') && { + format: Configuration.getConfigurationData()?.logFormat + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logRotate') && { + rotate: Configuration.getConfigurationData()?.logRotate + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxFiles') && { + maxFiles: Configuration.getConfigurationData()?.logMaxFiles + }), + ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxSize') && { + maxSize: Configuration.getConfigurationData()?.logMaxSize + }) + } + const logConfiguration: LogConfiguration = { + ...defaultLogConfiguration, + ...deprecatedLogConfiguration, + ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.log) && + Configuration.getConfigurationData()?.log) } - return storageConfiguration; + return logConfiguration } - static getAutoReconnectMaxRetries(): number { + private static buildWorkerSection (): WorkerConfiguration { + const defaultWorkerConfiguration: WorkerConfiguration = { + processType: WorkerProcessType.workerSet, + startDelay: DEFAULT_WORKER_START_DELAY, + elementsPerWorker: 'auto', + elementAddDelay: DEFAULT_ELEMENT_ADD_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(), 'elementAddDelay') && { + elementAddDelay: Configuration.getConfigurationData()?.elementAddDelay + }), + ...(hasOwnProp(Configuration.getConfigurationData()?.worker, 'elementStartDelay') && { + elementAddDelay: Configuration.getConfigurationData()?.worker?.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) + } + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + checkWorkerProcessType(workerConfiguration.processType!) + checkWorkerElementsPerWorker(workerConfiguration.elementsPerWorker) + return workerConfiguration + } + + private static checkDeprecatedConfigurationKeys (): void { + // connection timeout 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" - ); + ) + // connection retries Configuration.warnDeprecatedConfigurationKey( 'autoReconnectMaxRetries', - null, + undefined, 'Use it in charging station template instead' - ); - // Read conf - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { - return Configuration.getConfig().autoReconnectMaxRetries; - } - } - - static getStationTemplateUrls(): StationTemplateUrl[] { + ) + // station template url(s) Configuration.warnDeprecatedConfigurationKey( 'stationTemplateURLs', - null, + undefined, "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}` - ); + ) + Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData] != + null && + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + (Configuration.getConfigurationData()!.stationTemplateUrls = + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + Configuration.getConfigurationData()![ + 'stationTemplateURLs' as keyof ConfigurationData + ] as StationTemplateUrl[]) + Configuration.getConfigurationData()?.stationTemplateUrls.forEach( + (stationTemplateUrl: StationTemplateUrl) => { + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + if (stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl] != null) { + console.error( + `${chalk.green(logPrefix())} ${chalk.red( + `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead` + )}` + ) + } } - }); - // Read conf - return Configuration.getConfig().stationTemplateUrls; - } - - static getWorker(): WorkerConfiguration { + ) + // 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', - null, - "Use 'worker' section to define the type of worker process model instead" - ); + undefined, + `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead` + ) Configuration.warnDeprecatedConfigurationKey( 'workerProcess', - null, - "Use 'worker' section to define the type of worker process model instead" - ); + undefined, + `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead` + ) Configuration.warnDeprecatedConfigurationKey( 'workerStartDelay', - null, - "Use 'worker' section to define the worker start delay instead" - ); + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker start delay instead` + ) Configuration.warnDeprecatedConfigurationKey( 'chargingStationsPerWorker', - null, - "Use 'worker' section to define the number of element(s) per worker instead" - ); + undefined, + `Use '${ConfigurationSection.worker}' section to define the number of element(s) per worker instead` + ) Configuration.warnDeprecatedConfigurationKey( - 'elementStartDelay', - null, - "Use 'worker' section to define the worker's element start delay instead" - ); + 'elementAddDelay', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker's element add delay instead` + ) Configuration.warnDeprecatedConfigurationKey( 'workerPoolMinSize', - null, - "Use 'worker' section to define the worker pool minimum size instead" - ); + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead` + ) Configuration.warnDeprecatedConfigurationKey( - 'workerPoolSize;', - null, - "Use 'worker' section to define the worker pool maximum size instead" - ); + 'workerPoolSize', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead` + ) Configuration.warnDeprecatedConfigurationKey( - 'workerPoolMaxSize;', - null, - "Use 'worker' section to define the worker pool maximum size instead" - ); + 'workerPoolMaxSize', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead` + ) Configuration.warnDeprecatedConfigurationKey( - 'workerPoolStrategy;', - null, - "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 - : WorkerConstants.DEFAULT_WORKER_START_DELAY, - elementsPerWorker: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'chargingStationsPerWorker' - ) - ? Configuration.getConfig().chargingStationsPerWorker - : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, - elementStartDelay: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'elementStartDelay' - ) - ? Configuration.getConfig().elementStartDelay - : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'workerPoolMinSize' - ) - ? Configuration.getConfig().workerPoolMinSize - : WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'workerPoolMaxSize' + 'workerPoolStrategy', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'poolStrategy', + ConfigurationSection.worker, + 'Not publicly exposed to end users' + ) + Configuration.warnDeprecatedConfigurationKey( + 'elementStartDelay', + ConfigurationSection.worker, + "Use 'elementAddDelay' instead" + ) + if ( + Configuration.getConfigurationData()?.worker?.processType === + ('staticPool' as WorkerProcessType) + ) { + console.error( + `${chalk.green(logPrefix())} ${chalk.red( + `Deprecated configuration 'staticPool' value usage in worker section 'processType' field. Use '${WorkerProcessType.fixedPool}' value instead` + )}` ) - ? Configuration.getConfig().workerPoolMaxSize - : WorkerConstants.DEFAULT_POOL_MAX_SIZE, - poolStrategy: Configuration.getConfig().workerPoolStrategy, - }; - if (Configuration.objectHasOwnProperty(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 - : false; - } - - static getLogFormat(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') - ? Configuration.getConfig().logFormat - : 'simple'; - } - - static getLogRotate(): boolean { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') - ? Configuration.getConfig().logRotate - : true; - } - - static getLogMaxFiles(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') - ? Configuration.getConfig().logMaxFiles - : 7; - } - - static getLogLevel(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') - ? Configuration.getConfig().logLevel.toLowerCase() - : 'info'; - } - - static getLogFile(): string { - return Configuration.objectHasOwnProperty(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 getSupervisionUrls(): string | string[] { + // log section 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; - } - - static getSupervisionUrlDistribution(): SupervisionUrlDistribution { + 'logEnabled', + undefined, + `Use '${ConfigurationSection.log}' section to define the logging enablement instead` + ) Configuration.warnDeprecatedConfigurationKey( - 'distributeStationToTenantEqually', - null, - "Use 'supervisionUrlDistribution' instead" - ); + 'logFile', + undefined, + `Use '${ConfigurationSection.log}' section to define the log file instead` + ) Configuration.warnDeprecatedConfigurationKey( - 'distributeStationsToTenantsEqually', - null, - "Use 'supervisionUrlDistribution' instead" - ); - return Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'supervisionUrlDistribution' + 'logErrorFile', + undefined, + `Use '${ConfigurationSection.log}' section to define the log error file instead` ) - ? Configuration.getConfig().supervisionUrlDistribution - : SupervisionUrlDistribution.ROUND_ROBIN; - } - - private static logPrefix(): string { - return new Date().toLocaleString() + ' Simulator configuration |'; + 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(logPrefix())} ${chalk.red( + `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead` + )}` + ) + } } - private static warnDeprecatedConfigurationKey( + private static warnDeprecatedConfigurationKey ( key: string, - sectionName?: string, + configurationSection?: ConfigurationSection, logMsgToAppend = '' - ) { + ): void { if ( - sectionName && - !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && - !Configuration.isUndefined( - (Configuration.getConfig()[sectionName] as Record)[key] - ) + configurationSection != null && + Configuration.getConfigurationData()?.[configurationSection as keyof ConfigurationData] != + null && + ( + Configuration.getConfigurationData()?.[ + configurationSection as keyof ConfigurationData + ] as Record + )[key] != null ) { console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${ - logMsgToAppend && '. ' + logMsgToAppend - }}` - ); - } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) { + `${chalk.green(logPrefix())} ${chalk.red( + `Deprecated configuration key '${key}' usage in section '${configurationSection}'${ + logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' + }` + )}` + ) + } else if (Configuration.getConfigurationData()?.[key as keyof ConfigurationData] != null) { console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${ - logMsgToAppend && '. ' + logMsgToAppend - }}` - ); + `${chalk.green(logPrefix())} ${chalk.red( + `Deprecated configuration key '${key}' usage${ + logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' + }` + )}` + ) } } - // Read the config file - private static getConfig(): ConfigurationData { - if (!Configuration.configuration) { + public static getConfigurationData (): ConfigurationData | undefined { + if (Configuration.configurationData == null) { try { - Configuration.configuration = JSON.parse( - fs.readFileSync(Configuration.configurationFile, 'utf8') - ) as ConfigurationData; + Configuration.configurationData = JSON.parse( + readFileSync(Configuration.configurationFile, 'utf8') + ) as ConfigurationData + if (Configuration.configurationFileWatcher == null) { + Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher() + } } catch (error) { - Configuration.handleFileException( - Configuration.logPrefix(), - FileType.Configuration, + handleFileException( Configuration.configurationFile, - error as NodeJS.ErrnoException - ); - } - if (!Configuration.configurationFileWatcher) { - Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); + FileType.Configuration, + error as NodeJS.ErrnoException, + logPrefix() + ) } } - return Configuration.configuration; + return Configuration.configurationData } - private static getConfigurationFileWatcher(): fs.FSWatcher { + private static getConfigurationFileWatcher (): FSWatcher | undefined { try { - return fs.watch(Configuration.configurationFile, (event, filename): void => { - if (filename && event === 'change') { - // Nullify to force configuration file reading - Configuration.configuration = null; - if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { - Configuration.configurationChangeCallback().catch((error) => { - throw typeof error === 'string' ? new Error(error) : error; - }); + return watch(Configuration.configurationFile, (event, filename): void => { + if ( + !Configuration.configurationFileReloading && + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + filename!.trim().length > 0 && + event === 'change' + ) { + Configuration.configurationFileReloading = true + const consoleWarnOnce = once(console.warn) + consoleWarnOnce( + `${chalk.green(logPrefix())} ${chalk.yellow( + `${FileType.Configuration} ${this.configurationFile} file have changed, reload` + )}` + ) + delete Configuration.configurationData + Configuration.configurationSectionCache.clear() + if (Configuration.configurationChangeCallback != null) { + Configuration.configurationChangeCallback() + .catch((error: unknown) => { + throw typeof error === 'string' ? new Error(error) : error + }) + .finally(() => { + Configuration.configurationFileReloading = false + }) + } else { + Configuration.configurationFileReloading = false } } - }); + }) } catch (error) { - Configuration.handleFileException( - Configuration.logPrefix(), - FileType.Configuration, + handleFileException( Configuration.configurationFile, - error as NodeJS.ErrnoException - ); - } - } - - 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(path.dirname(fileURLToPath(import.meta.url)), '../../'), - Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME - )}`; - case StorageType.SQLITE: - return `file://${path.join( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'), - SQLiteFileName - )}`; - 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; + FileType.Configuration, + error as NodeJS.ErrnoException, + logPrefix() + ) } } }