X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=5df7bdc5521debb1091388c38620497fa1eee96b;hb=8f8f87c4fd9a0863d0aeb4a9a8671d1a2b4308e0;hp=bad98a98f96f092aa45750787096d20580a22eaf;hpb=912136b163790f70f2d82600f6782ed93bc2ba9a;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index bad98a98..25a1475b 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,196 +1,608 @@ -import ConfigurationData, { StationTemplateURL, StorageConfiguration } from '../types/ConfigurationData'; - -import Constants from './Constants'; -import { StorageType } from '../types/Storage'; -import type { WorkerChoiceStrategy } from 'poolifier'; -import { WorkerProcessType } from '../types/Worker'; -import fs from 'fs'; -import path from 'path'; - -export default class Configuration { - private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json'); - private static configurationFileWatcher: fs.FSWatcher; - private static configuration: ConfigurationData | null = null; - private static configurationChangeCallback: () => Promise; - - static setConfigurationChangeCallback(cb: () => Promise): void { - Configuration.configurationChangeCallback = cb; - } - - static getLogStatisticsInterval(): number { - Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', 'Use \'logStatisticsInterval\' instead'); - // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60; - } - - static getPerformanceStorage(): StorageConfiguration { - let storageConfiguration: StorageConfiguration; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) { - storageConfiguration = - { - ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') ? { enabled: Configuration.getConfig().performanceStorage.enabled } : { enabled: false }, - ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'type') ? { type: Configuration.getConfig().performanceStorage.type } : { type: StorageType.JSON_FILE }, - ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'URI') ? { URI: Configuration.getConfig().performanceStorage.URI } : { URI: 'file:///performanceMeasurements.json' } - }; - } else { - storageConfiguration = - { - enabled: false, - type: StorageType.JSON_FILE, - URI: 'file:///performanceMeasurements.json' - }; - } - return storageConfiguration; - } - - static getAutoReconnectMaxRetries(): number { - Configuration.warnDeprecatedConfigurationKey('autoReconnectTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead'); - Configuration.warnDeprecatedConfigurationKey('connectionTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead'); - Configuration.warnDeprecatedConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead'); - // Read conf - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { - return Configuration.getConfig().autoReconnectMaxRetries; - } - } - - static getStationTemplateURLs(): StationTemplateURL[] { - Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => { - if (!Configuration.isUndefined(stationURL['numberOfStation'])) { - console.error(`${Configuration.logPrefix()} Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead`); - } - }); - // Read conf - return Configuration.getConfig().stationTemplateURLs; - } +import { type FSWatcher, readFileSync, watch } from 'node:fs' +import { dirname, join } from 'node:path' +import { env } from 'node:process' +import { fileURLToPath } from 'node:url' - static getWorkerProcess(): WorkerProcessType { - Configuration.warnDeprecatedConfigurationKey('useWorkerPool;', 'Use \'workerProcess\' to define the type of worker process to use instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig().workerProcess : WorkerProcessType.WORKER_SET; - } +import chalk from 'chalk' +import { mergeDeepRight, once } from 'rambda' - static getWorkerStartDelay(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig().workerStartDelay : Constants.WORKER_START_DELAY; - } +import { + ApplicationProtocol, + ApplicationProtocolVersion, + type ConfigurationData, + ConfigurationSection, + FileType, + type LogConfiguration, + type StationTemplateUrl, + type StorageConfiguration, + StorageType, + SupervisionUrlDistribution, + 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 - static getWorkerPoolMinSize(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE; + 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 } - static getWorkerPoolMaxSize(): number { - Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE; + public static getConfigurationSection( + sectionName: ConfigurationSection + ): T { + if (!Configuration.isConfigurationSectionCached(sectionName)) { + Configuration.cacheConfigurationSection(sectionName) + } + return Configuration.configurationSectionCache.get(sectionName) as T } - static getWorkerPoolStrategy(): WorkerChoiceStrategy { - return Configuration.getConfig().workerPoolStrategy; + public static getStationTemplateUrls (): StationTemplateUrl[] | undefined { + const checkDeprecatedConfigurationKeysOnce = once( + Configuration.checkDeprecatedConfigurationKeys.bind(Configuration) + ) + checkDeprecatedConfigurationKeysOnce() + return Configuration.getConfigurationData()?.stationTemplateUrls } - static getChargingStationsPerWorker(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER; + 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 getLogConsole(): boolean { - Configuration.warnDeprecatedConfigurationKey('consoleLog', 'Use \'logConsole\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; + public static getSupervisionUrlDistribution (): SupervisionUrlDistribution | undefined { + return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution') + ? Configuration.getConfigurationData()?.supervisionUrlDistribution + : SupervisionUrlDistribution.ROUND_ROBIN } - static getLogFormat(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple'; + 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! + ) } - static getLogRotate(): boolean { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true; + public static workerDynamicPoolInUse (): boolean { + return ( + Configuration.getConfigurationSection(ConfigurationSection.worker) + .processType === WorkerProcessType.dynamicPool + ) } - static getLogMaxFiles(): number { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7; + private static isConfigurationSectionCached (sectionName: ConfigurationSection): boolean { + return Configuration.configurationSectionCache.has(sectionName) } - static getLogLevel(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info'; + 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}'`) + } } - static getLogFile(): string { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log'; + private static buildUIServerSection (): UIServerConfiguration { + let uiServerConfiguration: UIServerConfiguration = { + enabled: false, + type: ApplicationProtocol.WS, + version: ApplicationProtocolVersion.VERSION_11, + options: { + host: Constants.DEFAULT_UI_SERVER_HOST, + port: Constants.DEFAULT_UI_SERVER_PORT + } + } + if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) { + uiServerConfiguration = mergeDeepRight( + uiServerConfiguration, + // 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 } - static getLogErrorFile(): string { - Configuration.warnDeprecatedConfigurationKey('errorFile', 'Use \'logErrorFile\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; + 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.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 } - static getSupervisionURLs(): string[] { - // Read conf - return Configuration.getConfig().supervisionURLs; + 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 logConfiguration } - static getDistributeStationsToTenantsEqually(): boolean { - Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead'); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true; + 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 logPrefix(): string { - return new Date().toLocaleString() + ' Simulator configuration |'; + private static checkDeprecatedConfigurationKeys (): void { + // 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" + ) + 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` + )}` + ) + } + } + ) + // 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, + `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'workerProcess', + undefined, + `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'workerStartDelay', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker start delay instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'chargingStationsPerWorker', + undefined, + `Use '${ConfigurationSection.worker}' section to define the number of element(s) per worker instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'elementAddDelay', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker's element add delay instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolMinSize', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolSize', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead` + ) + Configuration.warnDeprecatedConfigurationKey( + 'workerPoolMaxSize', + undefined, + `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead` + ) + Configuration.warnDeprecatedConfigurationKey( + '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` + )}` + ) + } + // 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(logPrefix())} ${chalk.red( + `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead` + )}` + ) + } } - private static warnDeprecatedConfigurationKey(key: string, sectionName?: string, logMsgToAppend = '') { - // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access - if (sectionName && !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && !Configuration.isUndefined(Configuration.getConfig()[sectionName][key])) { - console.error(`${Configuration.logPrefix()} Deprecated configuration key '${key}' usage in section '${sectionName}'${logMsgToAppend && '. ' + logMsgToAppend}`); - } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) { - console.error(`${Configuration.logPrefix()} Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}`); + private static warnDeprecatedConfigurationKey ( + key: string, + configurationSection?: ConfigurationSection, + logMsgToAppend = '' + ): void { + if ( + configurationSection != null && + Configuration.getConfigurationData()?.[configurationSection as keyof ConfigurationData] != + null && + ( + Configuration.getConfigurationData()?.[ + configurationSection as keyof ConfigurationData + ] as Record + )[key] != null + ) { + console.error( + `${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(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.configurationFilePath, '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(), 'Configuration', Configuration.configurationFilePath, error); - } - if (!Configuration.configurationFileWatcher) { - Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); + handleFileException( + Configuration.configurationFile, + FileType.Configuration, + error as NodeJS.ErrnoException, + logPrefix() + ) } } - return Configuration.configuration; + return Configuration.configurationData } - private static getConfigurationFileWatcher(): fs.FSWatcher { + private static getConfigurationFileWatcher (): FSWatcher | undefined { try { - // eslint-disable-next-line @typescript-eslint/no-misused-promises - return fs.watch(Configuration.configurationFilePath).on('change', async (): Promise => { - // Nullify to force configuration file reading - Configuration.configuration = null; - if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { - await Configuration.configurationChangeCallback(); + return 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(), 'Configuration', Configuration.configurationFilePath, error); - } - } - - private static objectHasOwnProperty(object: any, property: string): boolean { - return Object.prototype.hasOwnProperty.call(object, property) as boolean; - } - - private static isUndefined(obj: any): boolean { - return typeof obj === 'undefined'; - } - - private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException): void { - const prefix = logPrefix.length !== 0 ? logPrefix + ' ' : ''; - if (error.code === 'ENOENT') { - console.error(prefix + fileType + ' file ' + filePath + ' not found: ', error); - } else if (error.code === 'EEXIST') { - console.error(prefix + fileType + ' file ' + filePath + ' already exists: ', error); - } else if (error.code === 'EACCES') { - console.error(prefix + fileType + ' file ' + filePath + ' access denied: ', error); - } else { - console.error(prefix + fileType + ' file ' + filePath + ' error: ', error); + handleFileException( + Configuration.configurationFile, + FileType.Configuration, + error as NodeJS.ErrnoException, + logPrefix() + ) } - throw error; } }