X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=e4215f94c973e3be09c6283d9773e489067105d7;hb=6082281f1beebdf0126417b694c134ea4753442c;hp=6f1705a69b813082cd62e2850153a357374d1337;hpb=dada83ec9f4fb9426070147b43615d494ae86fcc;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 6f1705a6..e4215f94 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -6,7 +6,8 @@ import chalk from 'chalk'; import merge from 'just-merge'; import { WorkerChoiceStrategies } from 'poolifier'; -import { Constants, FileUtils, Utils } from './internal'; +import { Constants } from './Constants'; +import { Utils } from './Utils'; import { ApplicationProtocol, type ConfigurationData, @@ -22,7 +23,7 @@ import { WorkerConstants, WorkerProcessType } from '../worker'; export class Configuration { private static configurationFile = path.join( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), + path.dirname(fileURLToPath(import.meta.url)), 'assets', 'config.json' ); @@ -35,24 +36,24 @@ export class Configuration { // This is intentional } - static setConfigurationChangeCallback(cb: () => Promise): void { + public static setConfigurationChangeCallback(cb: () => Promise): void { Configuration.configurationChangeCallback = cb; } - static getLogStatisticsInterval(): number | undefined { + public static getLogStatisticsInterval(): number | undefined { Configuration.warnDeprecatedConfigurationKey( 'statisticsDisplayInterval', undefined, "Use 'logStatisticsInterval' instead" ); // Read conf - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') + return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig()?.logStatisticsInterval : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; } - static getUIServer(): UIServerConfiguration { - if (Utils.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) { + 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}` ); @@ -65,7 +66,7 @@ export class Configuration { port: Constants.DEFAULT_UI_SERVER_PORT, }, }; - if (Utils.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) { uiServerConfiguration = merge( uiServerConfiguration, Configuration.getConfig()?.uiServer @@ -78,23 +79,29 @@ export class Configuration { return uiServerConfiguration; } - static getPerformanceStorage(): StorageConfiguration { + public 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 (Utils.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'performanceStorage')) { storageConfiguration = { ...storageConfiguration, ...Configuration.getConfig()?.performanceStorage, + ...(Configuration.getConfig()?.performanceStorage?.type === StorageType.JSON_FILE && + Configuration.getConfig()?.performanceStorage?.uri && { + uri: Configuration.buildPerformanceUriFilePath( + new URL(Configuration.getConfig()?.performanceStorage?.uri).pathname + ), + }), }; } return storageConfiguration; } - static getAutoReconnectMaxRetries(): number | undefined { + public static getAutoReconnectMaxRetries(): number | undefined { Configuration.warnDeprecatedConfigurationKey( 'autoReconnectTimeout', undefined, @@ -111,12 +118,12 @@ export class Configuration { 'Use it in charging station template instead' ); // Read conf - if (Utils.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) { return Configuration.getConfig()?.autoReconnectMaxRetries; } } - static getStationTemplateUrls(): StationTemplateUrl[] | undefined { + public static getStationTemplateUrls(): StationTemplateUrl[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'stationTemplateURLs', undefined, @@ -125,21 +132,23 @@ export class Configuration { !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[ 'stationTemplateURLs' - ] as unknown as StationTemplateUrl[]); - Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => { - if (!Utils.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}` - ); + ] as StationTemplateUrl[]); + Configuration.getConfig().stationTemplateUrls.forEach( + (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}` + ); + } } - }); + ); // Read conf return Configuration.getConfig()?.stationTemplateUrls; } - static getWorker(): WorkerConfiguration { + public static getWorker(): WorkerConfiguration { Configuration.warnDeprecatedConfigurationKey( 'useWorkerPool', undefined, @@ -186,97 +195,104 @@ export class Configuration { "Use 'worker' section to define the worker pool strategy instead" ); let workerConfiguration: WorkerConfiguration = { - processType: Utils.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') + processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig()?.workerProcess - : WorkerProcessType.WORKER_SET, - startDelay: Utils.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') + : WorkerProcessType.workerSet, + startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig()?.workerStartDelay : WorkerConstants.DEFAULT_WORKER_START_DELAY, - elementsPerWorker: Utils.objectHasOwnProperty( - Configuration.getConfig(), - 'chargingStationsPerWorker' - ) + elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig()?.chargingStationsPerWorker : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, - elementStartDelay: Utils.objectHasOwnProperty(Configuration.getConfig(), 'elementStartDelay') + elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') ? Configuration.getConfig()?.elementStartDelay : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: Utils.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') + poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig()?.workerPoolMinSize : WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: Utils.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') + poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig()?.workerPoolMaxSize : WorkerConstants.DEFAULT_POOL_MAX_SIZE, poolStrategy: Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, }; - if (Utils.objectHasOwnProperty(Configuration.getConfig(), 'worker')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) { workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; } return workerConfiguration; } - static getLogConsole(): boolean | undefined { + 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 getLogConsole(): boolean | undefined { Configuration.warnDeprecatedConfigurationKey( 'consoleLog', undefined, "Use 'logConsole' instead" ); - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') + return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig()?.logConsole : false; } - static getLogFormat(): string | undefined { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') + public static getLogFormat(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig()?.logFormat : 'simple'; } - static getLogRotate(): boolean | undefined { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') + public static getLogRotate(): boolean | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig()?.logRotate : true; } - static getLogMaxFiles(): number | string | false | undefined { + public static getLogMaxFiles(): number | string | false | undefined { return ( - Utils.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') && + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && Configuration.getConfig()?.logMaxFiles ); } - static getLogMaxSize(): number | string | false | undefined { + public static getLogMaxSize(): number | string | false | undefined { return ( - Utils.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') && + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && Configuration.getConfig()?.logMaxSize ); } - static getLogLevel(): string | undefined { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') + public static getLogLevel(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig()?.logLevel?.toLowerCase() : 'info'; } - static getLogFile(): string | undefined { - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logFile') + public static getLogFile(): string | undefined { + return Utils.hasOwnProp(Configuration.getConfig(), 'logFile') ? Configuration.getConfig()?.logFile : 'combined.log'; } - static getLogErrorFile(): string | undefined { + public static getLogErrorFile(): string | undefined { Configuration.warnDeprecatedConfigurationKey( 'errorFile', undefined, "Use 'logErrorFile' instead" ); - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') + return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig()?.logErrorFile : 'error.log'; } - static getSupervisionUrls(): string | string[] | undefined { + public static getSupervisionUrls(): string | string[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'supervisionURLs', undefined, @@ -290,7 +306,7 @@ export class Configuration { return Configuration.getConfig()?.supervisionUrls; } - static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { + public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { Configuration.warnDeprecatedConfigurationKey( 'distributeStationToTenantEqually', undefined, @@ -301,7 +317,7 @@ export class Configuration { undefined, "Use 'supervisionUrlDistribution' instead" ); - return Utils.objectHasOwnProperty(Configuration.getConfig(), 'supervisionUrlDistribution') + return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution') ? Configuration.getConfig()?.supervisionUrlDistribution : SupervisionUrlDistribution.ROUND_ROBIN; } @@ -322,13 +338,13 @@ export class Configuration { ) { console.error( chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${ - logMsgToAppend.trim().length > 0 && `. ${logMsgToAppend}` + 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}` + logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' }}` ); } @@ -342,12 +358,11 @@ export class Configuration { fs.readFileSync(Configuration.configurationFile, 'utf8') ) as ConfigurationData; } catch (error) { - FileUtils.handleFileException( + Configuration.handleFileException( Configuration.configurationFile, FileType.Configuration, error as NodeJS.ErrnoException, - Configuration.logPrefix(), - { consoleOut: true } + Configuration.logPrefix() ); } if (!Configuration.configurationFileWatcher) { @@ -371,30 +386,62 @@ export class Configuration { } }); } catch (error) { - FileUtils.handleFileException( + Configuration.handleFileException( Configuration.configurationFile, FileType.Configuration, error as NodeJS.ErrnoException, - Configuration.logPrefix(), - { consoleOut: true } + Configuration.logPrefix() ); } } + private static handleFileException( + file: string, + fileType: FileType, + error: NodeJS.ErrnoException, + logPrefix: string + ): void { + const prefix = Utils.isNotEmptyString(logPrefix) ? `${logPrefix} ` : ''; + let logMsg: string; + switch (error.code) { + case 'ENOENT': + logMsg = `${fileType} file ${file} not found:`; + break; + case 'EEXIST': + logMsg = `${fileType} file ${file} already exists:`; + break; + case 'EACCES': + logMsg = `${fileType} file ${file} access denied:`; + break; + case 'EPERM': + logMsg = `${fileType} file ${file} permission denied:`; + break; + default: + logMsg = `${fileType} file ${file} error:`; + } + console.error(`${chalk.green(prefix)}${chalk.red(`${logMsg} `)}`, error); + throw error; + } + private static getDefaultPerformanceStorageUri(storageType: StorageType) { switch (storageType) { case StorageType.JSON_FILE: - return `file://${path.join( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'), + return Configuration.buildPerformanceUriFilePath( Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME - )}`; + ); case StorageType.SQLITE: - return `file://${path.join( - path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'), + return Configuration.buildPerformanceUriFilePath( `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db` - )}`; + ); default: throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); } } + + private static buildPerformanceUriFilePath(file: string) { + return `file://${path.join( + path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), + file + )}`; + } }