X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futils%2FConfiguration.ts;h=0ed294c016385bc9d3993d6f55bde0cd52593e36;hb=7edba9a79cf60b1d1113ec89f310788194ddb97a;hp=b1926e16dad7425d3cd7ea8a257163c41a4a7e14;hpb=27e40a3b65c82807a3bf15a0e56b6f24fceb89f8;p=e-mobility-charging-stations-simulator.git diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index b1926e16..0ed294c0 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -1,29 +1,27 @@ -import fs from 'fs'; -import path from 'path'; -import { fileURLToPath } from 'url'; +import fs from 'node:fs'; +import path from 'node:path'; +import { fileURLToPath } from 'node:url'; 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 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)), '../'), 'assets', @@ -49,13 +47,13 @@ export default class Configuration { "Use 'logStatisticsInterval' instead" ); // Read conf - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') + return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig()?.logStatisticsInterval : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; } static getUIServer(): UIServerConfiguration { - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) { console.error( chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead}` ); @@ -68,10 +66,13 @@ export default class Configuration { port: Constants.DEFAULT_UI_SERVER_PORT, }, }; - if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) { - uiServerConfiguration = merge(uiServerConfiguration, 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); } @@ -85,10 +86,16 @@ export default class Configuration { 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; @@ -111,7 +118,7 @@ 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; } } @@ -122,19 +129,21 @@ export default class Configuration { 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()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${ + stationTemplateUrl.file + }' in 'stationTemplateUrls'. Use 'numberOfStations' instead}` + ); + } } - }); + ); // Read conf return Configuration.getConfig()?.stationTemplateUrls; } @@ -186,40 +195,28 @@ export default class Configuration { "Use 'worker' section to define the worker pool strategy instead" ); let workerConfiguration: WorkerConfiguration = { - processType: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') + processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig()?.workerProcess - : WorkerProcessType.WORKER_SET, - startDelay: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') + : WorkerProcessType.workerSet, + startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig()?.workerStartDelay : WorkerConstants.DEFAULT_WORKER_START_DELAY, - elementsPerWorker: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'chargingStationsPerWorker' - ) + elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig()?.chargingStationsPerWorker : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, - elementStartDelay: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'elementStartDelay' - ) + elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') ? Configuration.getConfig()?.elementStartDelay : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: Configuration.objectHasOwnProperty( - Configuration.getConfig(), - 'workerPoolMinSize' - ) + poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig()?.workerPoolMinSize : WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: Configuration.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 (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'worker')) { + if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) { workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; } return workerConfiguration; @@ -231,45 +228,45 @@ export default class Configuration { undefined, "Use 'logConsole' instead" ); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') + return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig()?.logConsole : false; } static getLogFormat(): string | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') + return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig()?.logFormat : 'simple'; } static getLogRotate(): boolean | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') + return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig()?.logRotate : true; } static getLogMaxFiles(): number | string | false | undefined { return ( - Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') && + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && Configuration.getConfig()?.logMaxFiles ); } static getLogMaxSize(): number | string | false | undefined { return ( - Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') && + Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && Configuration.getConfig()?.logMaxSize ); } static getLogLevel(): string | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') + return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig()?.logLevel?.toLowerCase() : 'info'; } static getLogFile(): string | undefined { - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') + return Utils.hasOwnProp(Configuration.getConfig(), 'logFile') ? Configuration.getConfig()?.logFile : 'combined.log'; } @@ -280,7 +277,7 @@ export default class Configuration { undefined, "Use 'logErrorFile' instead" ); - return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') + return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig()?.logErrorFile : 'error.log'; } @@ -291,7 +288,7 @@ export default class Configuration { undefined, "Use 'supervisionUrls' instead" ); - !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) && + !Utils.isUndefined(Configuration.getConfig()['supervisionURLs']) && (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as | string | string[]); @@ -310,17 +307,14 @@ 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; } - private static logPrefix(): string { + private static logPrefix = (): string => { return `${new Date().toLocaleString()} Simulator configuration |`; - } + }; private static warnDeprecatedConfigurationKey( key: string, @@ -329,20 +323,18 @@ 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}` + 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}` + logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : '' }}` ); } @@ -357,10 +349,10 @@ export default class Configuration { ) as ConfigurationData; } catch (error) { Configuration.handleFileException( - Configuration.logPrefix(), - FileType.Configuration, Configuration.configurationFile, - error as NodeJS.ErrnoException + FileType.Configuration, + error as NodeJS.ErrnoException, + Configuration.logPrefix() ); } if (!Configuration.configurationFileWatcher) { @@ -373,10 +365,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; }); @@ -385,68 +377,57 @@ export default class Configuration { }); } catch (error) { Configuration.handleFileException( - Configuration.logPrefix(), - FileType.Configuration, Configuration.configurationFile, - error as NodeJS.ErrnoException + FileType.Configuration, + error as NodeJS.ErrnoException, + Configuration.logPrefix() ); } } - 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( - logPrefix: string, + file: string, fileType: FileType, - filePath: string, error: NodeJS.ErrnoException, - 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; 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.warn(`${chalk.green(prefix)}${chalk.yellow(`${logMsg} `)}`, 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 + )}`; + } }