X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=b54f3900988477d6e0ef77113323fc6c1bd8092a;hb=25baaaf241b827786fd7c11a77c9a0f3431608d0;hp=e4215f94c973e3be09c6283d9773e489067105d7;hpb=7b5dbe910fc30484324da90ee209ab7002bc5071;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index e4215f94..b54f3900 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -12,6 +12,7 @@ import { ApplicationProtocol, type ConfigurationData, FileType, + type LogConfiguration, type StationTemplateUrl, type StorageConfiguration, StorageType, @@ -40,22 +41,12 @@ export class Configuration { Configuration.configurationChangeCallback = cb; } - public static getLogStatisticsInterval(): number | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'statisticsDisplayInterval', - undefined, - "Use 'logStatisticsInterval' instead" - ); - // Read conf - return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') - ? Configuration.getConfig()?.logStatisticsInterval - : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; - } - public static getUIServer(): UIServerConfiguration { if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) { console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead}` + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead" + )}` ); } let uiServerConfiguration: UIServerConfiguration = { @@ -137,9 +128,9 @@ export class Configuration { (stationTemplateUrl: StationTemplateUrl) => { if (!Utils.isUndefined(stationTemplateUrl['numberOfStation'])) { console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${ - stationTemplateUrl.file - }' in 'stationTemplateUrls'. Use 'numberOfStations' instead}` + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead` + )}` ); } } @@ -148,6 +139,106 @@ export class Configuration { return Configuration.getConfig()?.stationTemplateUrls; } + public static getLog(): LogConfiguration { + Configuration.warnDeprecatedConfigurationKey( + 'logEnabled', + undefined, + "Use 'log' section to define the logging enablement instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logFile', + undefined, + "Use 'log' section to define the log file instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logErrorFile', + undefined, + "Use 'log' section to define the log error file instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logConsole', + undefined, + "Use 'log' section to define the console logging enablement instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logStatisticsInterval', + undefined, + "Use 'log' section to define the log statistics interval instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logLevel', + undefined, + "Use 'log' section to define the log level instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logFormat', + undefined, + "Use 'log' section to define the log format instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logRotate', + undefined, + "Use 'log' section to define the log rotation enablement instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logMaxFiles', + undefined, + "Use 'log' section to define the log maximum files instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logMaxSize', + undefined, + "Use 'log' section to define the log maximum size instead" + ); + 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 = { + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logEnabled') && { + enabled: Configuration.getConfig()?.logEnabled, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFile') && { + file: Configuration.getConfig()?.logFile, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') && { + errorFile: Configuration.getConfig()?.logErrorFile, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') && { + statisticsInterval: Configuration.getConfig()?.logStatisticsInterval, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') && { + level: Configuration.getConfig()?.logLevel, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') && { + console: Configuration.getConfig()?.logConsole, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') && { + format: Configuration.getConfig()?.logFormat, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') && { + rotate: Configuration.getConfig()?.logRotate, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && { + maxFiles: Configuration.getConfig()?.logMaxFiles, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxSize') && { + maxSize: Configuration.getConfig()?.logMaxSize, + }), + }; + const logConfiguration: LogConfiguration = { + ...defaultLogConfiguration, + ...deprecatedLogConfiguration, + ...(Utils.hasOwnProp(Configuration.getConfig(), 'log') && Configuration.getConfig()?.log), + }; + return logConfiguration; + } + public static getWorker(): WorkerConfiguration { Configuration.warnDeprecatedConfigurationKey( 'useWorkerPool', @@ -194,31 +285,45 @@ export class Configuration { undefined, "Use 'worker' section to define the worker pool strategy instead" ); - let workerConfiguration: WorkerConfiguration = { - processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') - ? Configuration.getConfig()?.workerProcess - : WorkerProcessType.workerSet, - startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') - ? Configuration.getConfig()?.workerStartDelay - : WorkerConstants.DEFAULT_WORKER_START_DELAY, - elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') - ? Configuration.getConfig()?.chargingStationsPerWorker - : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, - elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') - ? Configuration.getConfig()?.elementStartDelay - : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') - ? Configuration.getConfig()?.workerPoolMinSize - : WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') - ? Configuration.getConfig()?.workerPoolMaxSize - : WorkerConstants.DEFAULT_POOL_MAX_SIZE, - poolStrategy: - Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, + const defaultWorkerConfiguration: WorkerConfiguration = { + processType: WorkerProcessType.workerSet, + startDelay: WorkerConstants.DEFAULT_WORKER_START_DELAY, + elementsPerWorker: WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, + elementStartDelay: WorkerConstants.DEFAULT_ELEMENT_START_DELAY, + poolMinSize: WorkerConstants.DEFAULT_POOL_MIN_SIZE, + poolMaxSize: WorkerConstants.DEFAULT_POOL_MAX_SIZE, + poolStrategy: WorkerChoiceStrategies.ROUND_ROBIN, + }; + const deprecatedWorkerConfiguration: WorkerConfiguration = { + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') && { + processType: Configuration.getConfig()?.workerProcess, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') && { + startDelay: Configuration.getConfig()?.workerStartDelay, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') && { + elementsPerWorker: Configuration.getConfig()?.chargingStationsPerWorker, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') && { + elementStartDelay: Configuration.getConfig()?.elementStartDelay, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') && { + poolMinSize: Configuration.getConfig()?.workerPoolMinSize, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') && { + poolMaxSize: Configuration.getConfig()?.workerPoolMaxSize, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolStrategy') && { + poolStrategy: + Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, + }), + }; + const workerConfiguration: WorkerConfiguration = { + ...defaultWorkerConfiguration, + ...deprecatedWorkerConfiguration, + ...(Utils.hasOwnProp(Configuration.getConfig(), 'worker') && + Configuration.getConfig()?.worker), }; - if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) { - workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; - } return workerConfiguration; } @@ -232,66 +337,6 @@ export class Configuration { return Configuration.getWorker().processType === WorkerProcessType.dynamicPool; } - public static getLogConsole(): boolean | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'consoleLog', - undefined, - "Use 'logConsole' instead" - ); - return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') - ? Configuration.getConfig()?.logConsole - : false; - } - - public static getLogFormat(): string | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') - ? Configuration.getConfig()?.logFormat - : 'simple'; - } - - public static getLogRotate(): boolean | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') - ? Configuration.getConfig()?.logRotate - : true; - } - - public static getLogMaxFiles(): number | string | false | undefined { - return ( - Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && - Configuration.getConfig()?.logMaxFiles - ); - } - - public static getLogMaxSize(): number | string | false | undefined { - return ( - Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && - Configuration.getConfig()?.logMaxSize - ); - } - - public static getLogLevel(): string | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') - ? Configuration.getConfig()?.logLevel?.toLowerCase() - : 'info'; - } - - public static getLogFile(): string | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logFile') - ? Configuration.getConfig()?.logFile - : 'combined.log'; - } - - public static getLogErrorFile(): string | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'errorFile', - undefined, - "Use 'logErrorFile' instead" - ); - return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') - ? Configuration.getConfig()?.logErrorFile - : 'error.log'; - } - public static getSupervisionUrls(): string | string[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'supervisionURLs', @@ -337,15 +382,19 @@ export class Configuration { !Utils.isUndefined((Configuration.getConfig()[sectionName] as Record)[key]) ) { console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${ - logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' - }}` + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + `Deprecated configuration key '${key}' usage in section '${sectionName}'${ + logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' + }` + )}` ); } else if (!Utils.isUndefined(Configuration.getConfig()[key])) { console.error( - chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${ - logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' - }}` + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + `Deprecated configuration key '${key}' usage${ + logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' + }` + )}` ); } }