X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=b54f3900988477d6e0ef77113323fc6c1bd8092a;hb=25baaaf241b827786fd7c11a77c9a0f3431608d0;hp=2cba674d3dd523589e087c7143753588bf26efb3;hpb=598c886d552bbefae7d2c539da6f104c243e3c7f;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index 2cba674d..b54f3900 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -6,26 +6,25 @@ import chalk from 'chalk'; import merge from 'just-merge'; import { WorkerChoiceStrategies } from 'poolifier'; -import Constants from './Constants'; +import { Constants } from './Constants'; +import { Utils } from './Utils'; import { + ApplicationProtocol, type ConfigurationData, + FileType, + type LogConfiguration, type StationTemplateUrl, type StorageConfiguration, + StorageType, SupervisionUrlDistribution, type UIServerConfiguration, type WorkerConfiguration, -} from '../types/ConfigurationData'; -import type { EmptyObject } from '../types/EmptyObject'; -import type { 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'; +} from '../types'; +import { WorkerConstants, WorkerProcessType } from '../worker'; -export default class Configuration { +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' ); @@ -38,26 +37,16 @@ export default class Configuration { // This is intentional } - static setConfigurationChangeCallback(cb: () => Promise): void { + public static setConfigurationChangeCallback(cb: () => Promise): void { Configuration.configurationChangeCallback = cb; } - static getLogStatisticsInterval(): number | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'statisticsDisplayInterval', - undefined, - "Use 'logStatisticsInterval' instead" - ); - // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') - ? Configuration.getConfig()?.logStatisticsInterval - : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; - } - - static getUIServer(): UIServerConfiguration { - if (Configuration.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}` + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead" + )}` ); } let uiServerConfiguration: UIServerConfiguration = { @@ -68,36 +57,42 @@ export default class Configuration { port: Constants.DEFAULT_UI_SERVER_PORT, }, }; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) { uiServerConfiguration = merge( uiServerConfiguration, Configuration.getConfig()?.uiServer ); } - if (Configuration.isCFEnvironment() === true) { + if (Utils.isCFEnvironment() === true) { delete uiServerConfiguration.options?.host; uiServerConfiguration.options.port = parseInt(process.env.PORT); } 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 (Configuration.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, @@ -114,35 +109,137 @@ export default class Configuration { 'Use it in charging station template instead' ); // Read conf - if (Configuration.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, "Use 'stationTemplateUrls' instead" ); - !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && + !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[ 'stationTemplateURLs' - ] as unknown 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}` - ); + ] as StationTemplateUrl[]); + Configuration.getConfig().stationTemplateUrls.forEach( + (stationTemplateUrl: StationTemplateUrl) => { + if (!Utils.isUndefined(stationTemplateUrl['numberOfStation'])) { + console.error( + `${chalk.green(Configuration.logPrefix())} ${chalk.red( + `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead` + )}` + ); + } } - }); + ); // Read conf return Configuration.getConfig()?.stationTemplateUrls; } - static getWorker(): WorkerConfiguration { + 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', undefined, @@ -188,113 +285,65 @@ export default class Configuration { undefined, "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' - ) - ? 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 (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'worker')) { - workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; - } return workerConfiguration; } - static getLogConsole(): boolean | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'consoleLog', - undefined, - "Use 'logConsole' instead" - ); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') - ? Configuration.getConfig()?.logConsole - : false; - } - - static getLogFormat(): string | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') - ? Configuration.getConfig()?.logFormat - : 'simple'; - } - - static getLogRotate(): boolean | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') - ? Configuration.getConfig()?.logRotate - : true; - } - - static getLogMaxFiles(): number | string | false | undefined { - return ( - Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') && - Configuration.getConfig()?.logMaxFiles + public static workerPoolInUse(): boolean { + return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes( + Configuration.getWorker().processType ); } - static getLogMaxSize(): number | string | false | undefined { - return ( - Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') && - Configuration.getConfig()?.logMaxSize - ); - } - - static getLogLevel(): string | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') - ? Configuration.getConfig()?.logLevel?.toLowerCase() - : 'info'; + public static workerDynamicPoolInUse(): boolean { + return Configuration.getWorker().processType === WorkerProcessType.dynamicPool; } - static getLogFile(): string | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') - ? Configuration.getConfig()?.logFile - : 'combined.log'; - } - - static getLogErrorFile(): string | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'errorFile', - undefined, - "Use 'logErrorFile' instead" - ); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') - ? Configuration.getConfig()?.logErrorFile - : 'error.log'; - } - - static getSupervisionUrls(): string | string[] | undefined { + public static getSupervisionUrls(): string | string[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'supervisionURLs', undefined, "Use 'supervisionUrls' instead" ); - !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) && + !Utils.isUndefined(Configuration.getConfig()['supervisionURLs']) && (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as | string | string[]); @@ -302,7 +351,7 @@ export default class Configuration { return Configuration.getConfig()?.supervisionUrls; } - static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { + public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined { Configuration.warnDeprecatedConfigurationKey( 'distributeStationToTenantEqually', undefined, @@ -313,10 +362,7 @@ export default class Configuration { undefined, "Use 'supervisionUrlDistribution' instead" ); - return Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'supervisionUrlDistribution' - ) + return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution') ? Configuration.getConfig()?.supervisionUrlDistribution : SupervisionUrlDistribution.ROUND_ROBIN; } @@ -332,21 +378,23 @@ export default class Configuration { ) { if ( sectionName && - !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && - !Configuration.isUndefined( - (Configuration.getConfig()[sectionName] as Record)[key] - ) + !Utils.isUndefined(Configuration.getConfig()[sectionName]) && + !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 (!Configuration.isUndefined(Configuration.getConfig()[key])) { + } 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}` : '' + }` + )}` ); } } @@ -376,10 +424,10 @@ export default class Configuration { private static getConfigurationFileWatcher(): fs.FSWatcher | undefined { try { return fs.watch(Configuration.configurationFile, (event, filename): void => { - if (filename?.trim().length !== 0 && event === 'change') { + if (filename?.trim().length > 0 && event === 'change') { // Nullify to force configuration file reading Configuration.configuration = null; - if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { + if (!Utils.isUndefined(Configuration.configurationChangeCallback)) { Configuration.configurationChangeCallback().catch((error) => { throw typeof error === 'string' ? new Error(error) : error; }); @@ -396,60 +444,53 @@ export default class Configuration { } } - private static isCFEnvironment(): boolean { - return process.env.VCAP_APPLICATION !== undefined; - } - - private static getDefaultPerformanceStorageUri(storageType: StorageType) { - 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)), '../../'), - `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db` - )}`; - default: - throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); - } - } - - private static objectHasOwnProperty(object: unknown, property: string): boolean { - return Object.prototype.hasOwnProperty.call(object, property) as boolean; - } - - private static isUndefined(obj: unknown): boolean { - return obj === undefined; - } - private static handleFileException( - filePath: string, + file: string, fileType: FileType, error: NodeJS.ErrnoException, - logPrefix: string, - params: HandleErrorParams = { throwError: true } + logPrefix: string ): void { - const prefix = logPrefix?.trim().length !== 0 ? `${logPrefix} ` : ''; + const prefix = Utils.isNotEmptyString(logPrefix) ? `${logPrefix} ` : ''; let logMsg: string; switch (error.code) { case 'ENOENT': - logMsg = `${fileType} file ${filePath} not found: `; + logMsg = `${fileType} file ${file} not found:`; break; case 'EEXIST': - logMsg = `${fileType} file ${filePath} already exists: `; + logMsg = `${fileType} file ${file} already exists:`; break; case 'EACCES': - logMsg = `${fileType} file ${filePath} access denied: `; + logMsg = `${fileType} file ${file} access denied:`; + break; + case 'EPERM': + logMsg = `${fileType} file ${file} permission denied:`; break; default: - logMsg = `${fileType} file ${filePath} error: `; + logMsg = `${fileType} file ${file} error:`; } - console.error(`${chalk.green(prefix)}${chalk.red(logMsg)}`, error); - if (params?.throwError) { - throw error; + console.error(`${chalk.green(prefix)}${chalk.red(`${logMsg} `)}`, error); + throw error; + } + + private static getDefaultPerformanceStorageUri(storageType: StorageType) { + switch (storageType) { + case StorageType.JSON_FILE: + return Configuration.buildPerformanceUriFilePath( + Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME + ); + case StorageType.SQLITE: + 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 + )}`; + } }