-import { type FSWatcher, readFileSync, watch } from 'node:fs';
-import { dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { type FSWatcher, readFileSync, watch } from 'node:fs'
+import { dirname, join } from 'node:path'
+import { env } from 'node:process'
+import { fileURLToPath } from 'node:url'
-import chalk from 'chalk';
-import merge from 'just-merge';
-import { WorkerChoiceStrategies } from 'poolifier';
+import chalk from 'chalk'
+import { mergeDeepRight, once } from 'rambda'
-import { Constants } from './Constants';
-import { hasOwnProp, isCFEnvironment, isNotEmptyString, isUndefined } from './Utils';
import {
ApplicationProtocol,
+ ApplicationProtocolVersion,
type ConfigurationData,
+ ConfigurationSection,
FileType,
type LogConfiguration,
type StationTemplateUrl,
StorageType,
SupervisionUrlDistribution,
type UIServerConfiguration,
- type WorkerConfiguration,
-} from '../types';
-import { WorkerConstants, WorkerProcessType } from '../worker';
+ 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 {
- private static configurationFile = join(
+ public static configurationChangeCallback?: () => Promise<void>
+
+ private static readonly configurationFile = join(
dirname(fileURLToPath(import.meta.url)),
'assets',
- 'config.json',
- );
+ 'config.json'
+ )
- private static configurationFileWatcher: FSWatcher | undefined;
- private static configuration: ConfigurationData | null = null;
- private static configurationChangeCallback: () => Promise<void>;
+ 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() {
+ private constructor () {
// This is intentional
}
- public static setConfigurationChangeCallback(cb: () => Promise<void>): void {
- Configuration.configurationChangeCallback = cb;
+ public static getConfigurationSection<T extends ConfigurationSectionType>(
+ sectionName: ConfigurationSection
+ ): T {
+ if (!Configuration.isConfigurationSectionCached(sectionName)) {
+ Configuration.cacheConfigurationSection(sectionName)
+ }
+ return Configuration.configurationSectionCache.get(sectionName) as T
}
- public static getUIServer(): UIServerConfiguration {
- if (hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) {
- console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
- "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead",
- )}`,
- );
+ public static getStationTemplateUrls (): StationTemplateUrl[] | undefined {
+ const checkDeprecatedConfigurationKeysOnce = once(
+ Configuration.checkDeprecatedConfigurationKeys.bind(Configuration)
+ )
+ checkDeprecatedConfigurationKeysOnce()
+ return Configuration.getConfigurationData()?.stationTemplateUrls
+ }
+
+ 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
+ }
+
+ public static getSupervisionUrlDistribution (): SupervisionUrlDistribution | undefined {
+ return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution')
+ ? Configuration.getConfigurationData()?.supervisionUrlDistribution
+ : SupervisionUrlDistribution.ROUND_ROBIN
+ }
+
+ public static workerPoolInUse (): boolean {
+ return [WorkerProcessType.dynamicPool, WorkerProcessType.fixedPool].includes(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+ .processType!
+ )
+ }
+
+ public static workerDynamicPoolInUse (): boolean {
+ return (
+ Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+ .processType === WorkerProcessType.dynamicPool
+ )
+ }
+
+ private static isConfigurationSectionCached (sectionName: ConfigurationSection): boolean {
+ return Configuration.configurationSectionCache.has(sectionName)
+ }
+
+ 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}'`)
+ }
+ }
+
+ 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.getConfig(), 'uiServer')) {
- uiServerConfiguration = merge<UIServerConfiguration>(
+ port: Constants.DEFAULT_UI_SERVER_PORT
+ }
+ }
+ if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) {
+ uiServerConfiguration = mergeDeepRight(
uiServerConfiguration,
- Configuration.getConfig()?.uiServer,
- );
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ Configuration.getConfigurationData()!.uiServer!
+ )
}
- if (isCFEnvironment() === true) {
- delete uiServerConfiguration.options?.host;
- uiServerConfiguration.options.port = parseInt(process.env.PORT);
+ if (isCFEnvironment()) {
+ delete uiServerConfiguration.options?.host
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ uiServerConfiguration.options!.port = parseInt(env.PORT!)
}
- return uiServerConfiguration;
+ return uiServerConfiguration
}
- 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 (hasOwnProp(Configuration.getConfig(), 'performanceStorage')) {
+ 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.getConfig()?.performanceStorage,
- ...(Configuration.getConfig()?.performanceStorage?.type === StorageType.JSON_FILE &&
- Configuration.getConfig()?.performanceStorage?.uri && {
- uri: Configuration.buildPerformanceUriFilePath(
- new URL(Configuration.getConfig()?.performanceStorage?.uri).pathname,
- ),
- }),
- };
+ ...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;
+ return storageConfiguration
}
- public static getAutoReconnectMaxRetries(): number | undefined {
+ 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
+ }
+
+ 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 checkDeprecatedConfigurationKeys (): void {
+ // connection timeout
Configuration.warnDeprecatedConfigurationKey(
'autoReconnectTimeout',
undefined,
- "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead",
- );
+ "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
+ )
Configuration.warnDeprecatedConfigurationKey(
'connectionTimeout',
undefined,
- "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead",
- );
+ "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
+ )
+ // connection retries
Configuration.warnDeprecatedConfigurationKey(
'autoReconnectMaxRetries',
undefined,
- 'Use it in charging station template instead',
- );
- // Read conf
- if (hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
- return Configuration.getConfig()?.autoReconnectMaxRetries;
- }
- }
-
- public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+ 'Use it in charging station template instead'
+ )
+ // station template url(s)
Configuration.warnDeprecatedConfigurationKey(
'stationTemplateURLs',
undefined,
- "Use 'stationTemplateUrls' instead",
- );
- !isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
- (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
- 'stationTemplateURLs'
- ] as StationTemplateUrl[]);
- Configuration.getConfig().stationTemplateUrls.forEach(
+ "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) => {
- if (!isUndefined(stationTemplateUrl['numberOfStation'])) {
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+ if (stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl] != null) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
- `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
- )}`,
- );
+ `${chalk.green(logPrefix())} ${chalk.red(
+ `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`
+ )}`
+ )
}
- },
- );
- // Read conf
- return Configuration.getConfig()?.stationTemplateUrls;
- }
-
- public static getLog(): LogConfiguration {
+ }
+ )
+ // supervision url(s)
Configuration.warnDeprecatedConfigurationKey(
- 'logEnabled',
+ 'supervisionURLs',
undefined,
- "Use 'log' section to define the logging enablement instead",
- );
+ "Use 'supervisionUrls' instead"
+ )
+ // supervision urls distribution
Configuration.warnDeprecatedConfigurationKey(
- 'logFile',
+ 'distributeStationToTenantEqually',
undefined,
- "Use 'log' section to define the log file instead",
- );
+ "Use 'supervisionUrlDistribution' instead"
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logErrorFile',
+ 'distributeStationsToTenantsEqually',
undefined,
- "Use 'log' section to define the log error file instead",
- );
+ "Use 'supervisionUrlDistribution' instead"
+ )
+ // worker section
Configuration.warnDeprecatedConfigurationKey(
- 'logConsole',
+ 'useWorkerPool',
undefined,
- "Use 'log' section to define the console logging enablement instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logStatisticsInterval',
+ 'workerProcess',
undefined,
- "Use 'log' section to define the log statistics interval instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logLevel',
+ 'workerStartDelay',
undefined,
- "Use 'log' section to define the log level instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the worker start delay instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logFormat',
+ 'chargingStationsPerWorker',
undefined,
- "Use 'log' section to define the log format instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the number of element(s) per worker instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logRotate',
+ 'elementAddDelay',
undefined,
- "Use 'log' section to define the log rotation enablement instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the worker's element add delay instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logMaxFiles',
+ 'workerPoolMinSize',
undefined,
- "Use 'log' section to define the log maximum files instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'logMaxSize',
+ 'workerPoolSize',
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 = {
- ...(hasOwnProp(Configuration.getConfig(), 'logEnabled') && {
- enabled: Configuration.getConfig()?.logEnabled,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logFile') && {
- file: Configuration.getConfig()?.logFile,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logErrorFile') && {
- errorFile: Configuration.getConfig()?.logErrorFile,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') && {
- statisticsInterval: Configuration.getConfig()?.logStatisticsInterval,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logLevel') && {
- level: Configuration.getConfig()?.logLevel,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logConsole') && {
- console: Configuration.getConfig()?.logConsole,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logFormat') && {
- format: Configuration.getConfig()?.logFormat,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logRotate') && {
- rotate: Configuration.getConfig()?.logRotate,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && {
- maxFiles: Configuration.getConfig()?.logMaxFiles,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'logMaxSize') && {
- maxSize: Configuration.getConfig()?.logMaxSize,
- }),
- };
- const logConfiguration: LogConfiguration = {
- ...defaultLogConfiguration,
- ...deprecatedLogConfiguration,
- ...(hasOwnProp(Configuration.getConfig(), 'log') && Configuration.getConfig()?.log),
- };
- return logConfiguration;
- }
-
- public static getWorker(): WorkerConfiguration {
+ `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'useWorkerPool',
+ 'workerPoolMaxSize',
undefined,
- "Use 'worker' section to define the type of worker process model instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'workerProcess',
+ 'workerPoolStrategy',
undefined,
- "Use 'worker' section to define the type of worker process model instead",
- );
+ `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'workerStartDelay',
+ '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 'worker' section to define the worker start delay instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the logging enablement instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'chargingStationsPerWorker',
+ 'logFile',
undefined,
- "Use 'worker' section to define the number of element(s) per worker instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the log file instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'elementStartDelay',
+ 'logErrorFile',
undefined,
- "Use 'worker' section to define the worker's element start delay instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the log error file instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolMinSize',
+ 'logConsole',
undefined,
- "Use 'worker' section to define the worker pool minimum size instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolSize;',
+ 'logStatisticsInterval',
undefined,
- "Use 'worker' section to define the worker pool maximum size instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolMaxSize;',
+ 'logLevel',
undefined,
- "Use 'worker' section to define the worker pool maximum size instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the log level instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolStrategy;',
+ 'logFormat',
undefined,
- "Use 'worker' section to define the worker pool strategy instead",
- );
- const defaultWorkerConfiguration: WorkerConfiguration = {
- processType: WorkerProcessType.workerSet,
- startDelay: WorkerConstants.DEFAULT_WORKER_START_DELAY,
- elementsPerWorker: 'auto',
- 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 = {
- ...(hasOwnProp(Configuration.getConfig(), 'workerProcess') && {
- processType: Configuration.getConfig()?.workerProcess,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'workerStartDelay') && {
- startDelay: Configuration.getConfig()?.workerStartDelay,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') && {
- elementsPerWorker: Configuration.getConfig()?.chargingStationsPerWorker,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'elementStartDelay') && {
- elementStartDelay: Configuration.getConfig()?.elementStartDelay,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') && {
- poolMinSize: Configuration.getConfig()?.workerPoolMinSize,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') && {
- poolMaxSize: Configuration.getConfig()?.workerPoolMaxSize,
- }),
- ...(hasOwnProp(Configuration.getConfig(), 'workerPoolStrategy') && {
- poolStrategy:
- Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
- }),
- };
- const workerConfiguration: WorkerConfiguration = {
- ...defaultWorkerConfiguration,
- ...deprecatedWorkerConfiguration,
- ...(hasOwnProp(Configuration.getConfig(), 'worker') && Configuration.getConfig()?.worker),
- };
- return workerConfiguration;
- }
-
- 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 getSupervisionUrls(): string | string[] | undefined {
+ `Use '${ConfigurationSection.log}' section to define the log format instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'supervisionURLs',
+ 'logRotate',
undefined,
- "Use 'supervisionUrls' instead",
- );
- !isUndefined(Configuration.getConfig()['supervisionURLs']) &&
- (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as
- | string
- | string[]);
- // Read conf
- return Configuration.getConfig()?.supervisionUrls;
- }
-
- public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
+ `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'distributeStationToTenantEqually',
+ 'logMaxFiles',
undefined,
- "Use 'supervisionUrlDistribution' instead",
- );
+ `Use '${ConfigurationSection.log}' section to define the log maximum files instead`
+ )
Configuration.warnDeprecatedConfigurationKey(
- 'distributeStationsToTenantsEqually',
+ 'logMaxSize',
undefined,
- "Use 'supervisionUrlDistribution' instead",
- );
- return hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution')
- ? Configuration.getConfig()?.supervisionUrlDistribution
- : SupervisionUrlDistribution.ROUND_ROBIN;
+ `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 logPrefix = (): string => {
- return `${new Date().toLocaleString()} Simulator configuration |`;
- };
-
- private static warnDeprecatedConfigurationKey(
+ private static warnDeprecatedConfigurationKey (
key: string,
- sectionName?: string,
- logMsgToAppend = '',
- ) {
+ configurationSection?: ConfigurationSection,
+ logMsgToAppend = ''
+ ): void {
if (
- sectionName &&
- !isUndefined(Configuration.getConfig()[sectionName]) &&
- !isUndefined((Configuration.getConfig()[sectionName] as Record<string, unknown>)[key])
+ configurationSection != null &&
+ Configuration.getConfigurationData()?.[configurationSection as keyof ConfigurationData] !=
+ null &&
+ (
+ Configuration.getConfigurationData()?.[
+ configurationSection as keyof ConfigurationData
+ ] as Record<string, unknown>
+ )[key] != null
) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
- `Deprecated configuration key '${key}' usage in section '${sectionName}'${
+ `${chalk.green(logPrefix())} ${chalk.red(
+ `Deprecated configuration key '${key}' usage in section '${configurationSection}'${
logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
- }`,
- )}`,
- );
- } else if (!isUndefined(Configuration.getConfig()[key])) {
+ }`
+ )}`
+ )
+ } else if (Configuration.getConfigurationData()?.[key as keyof ConfigurationData] != null) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(logPrefix())} ${chalk.red(
`Deprecated configuration key '${key}' usage${
logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
- }`,
- )}`,
- );
+ }`
+ )}`
+ )
}
}
- // Read the config file
- private static getConfig(): ConfigurationData | null {
- if (!Configuration.configuration) {
+ public static getConfigurationData (): ConfigurationData | undefined {
+ if (Configuration.configurationData == null) {
try {
- Configuration.configuration = JSON.parse(
- readFileSync(Configuration.configurationFile, '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(
+ handleFileException(
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix(),
- );
- }
- if (!Configuration.configurationFileWatcher) {
- Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
+ logPrefix()
+ )
}
}
- return Configuration.configuration;
+ return Configuration.configurationData
}
- private static getConfigurationFileWatcher(): FSWatcher | undefined {
+ private static getConfigurationFileWatcher (): FSWatcher | undefined {
try {
return watch(Configuration.configurationFile, (event, filename): void => {
- if (filename?.trim().length > 0 && event === 'change') {
- // Nullify to force configuration file reading
- Configuration.configuration = null;
- if (!isUndefined(Configuration.configurationChangeCallback)) {
- Configuration.configurationChangeCallback().catch((error) => {
- throw typeof error === 'string' ? new Error(error) : error;
- });
+ 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(
+ handleFileException(
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix(),
- );
- }
- }
-
- private static handleFileException(
- file: string,
- fileType: FileType,
- error: NodeJS.ErrnoException,
- logPrefix: string,
- ): void {
- const prefix = 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 Configuration.buildPerformanceUriFilePath(
- `${Constants.DEFAULT_PERFORMANCE_DIRECTORY}/${Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME}`,
- );
- case StorageType.SQLITE:
- return Configuration.buildPerformanceUriFilePath(
- `${Constants.DEFAULT_PERFORMANCE_DIRECTORY}/${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`,
- );
- default:
- throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`);
+ logPrefix()
+ )
}
}
-
- private static buildPerformanceUriFilePath(file: string) {
- return `file://${join(resolve(dirname(fileURLToPath(import.meta.url)), '../'), file)}`;
- }
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff