-import fs from 'node:fs';
-import path from 'node:path';
+import { type FSWatcher, readFileSync, watch } from 'node:fs';
+import { dirname, join, resolve } 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 { Utils } from './Utils';
+import { hasOwnProp, isCFEnvironment, isNotEmptyString, isUndefined } from './Utils';
import {
ApplicationProtocol,
type ConfigurationData,
+ ConfigurationSection,
FileType,
type LogConfiguration,
type StationTemplateUrl,
type UIServerConfiguration,
type WorkerConfiguration,
} from '../types';
-import { WorkerConstants, WorkerProcessType } from '../worker';
+import {
+ DEFAULT_ELEMENT_START_DELAY,
+ DEFAULT_POOL_MAX_SIZE,
+ DEFAULT_POOL_MIN_SIZE,
+ DEFAULT_WORKER_START_DELAY,
+ WorkerProcessType,
+} from '../worker';
+
+type ConfigurationSectionType =
+ | LogConfiguration
+ | StorageConfiguration
+ | WorkerConfiguration
+ | UIServerConfiguration;
export class Configuration {
- private static configurationFile = path.join(
- path.dirname(fileURLToPath(import.meta.url)),
+ private static configurationFile = join(
+ dirname(fileURLToPath(import.meta.url)),
'assets',
- 'config.json'
+ 'config.json',
);
- private static configurationFileWatcher: fs.FSWatcher | undefined;
- private static configuration: ConfigurationData | null = null;
- private static configurationChangeCallback: () => Promise<void>;
+ private static configurationFileWatcher?: FSWatcher;
+ private static configurationData?: ConfigurationData;
+ private static configurationSectionCache = new Map<
+ ConfigurationSection,
+ ConfigurationSectionType
+ >([
+ [ConfigurationSection.log, Configuration.buildLogSection()],
+ [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()],
+ [ConfigurationSection.worker, Configuration.buildWorkerSection()],
+ [ConfigurationSection.uiServer, Configuration.buildUIServerSection()],
+ ]);
+
+ private static configurationChangeCallback?: () => Promise<void>;
private constructor() {
// This is intentional
Configuration.configurationChangeCallback = cb;
}
- public static getUIServer(): UIServerConfiguration {
- if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) {
+ 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 getAutoReconnectMaxRetries(): number | undefined {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'autoReconnectTimeout',
+ undefined,
+ "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead",
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'connectionTimeout',
+ undefined,
+ "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead",
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'autoReconnectMaxRetries',
+ undefined,
+ 'Use it in charging station template instead',
+ );
+ if (hasOwnProp(Configuration.getConfigurationData(), 'autoReconnectMaxRetries')) {
+ return Configuration.getConfigurationData()?.autoReconnectMaxRetries;
+ }
+ }
+
+ public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'stationTemplateURLs',
+ undefined,
+ "Use 'stationTemplateUrls' instead",
+ );
+ // eslint-disable-next-line @typescript-eslint/dot-notation
+ !isUndefined(
+ Configuration.getConfigurationData()!['stationTemplateURLs' as keyof ConfigurationData],
+ ) &&
+ (Configuration.getConfigurationData()!.stationTemplateUrls =
+ Configuration.getConfigurationData()![
+ // eslint-disable-next-line @typescript-eslint/dot-notation
+ 'stationTemplateURLs' as keyof ConfigurationData
+ ] as StationTemplateUrl[]);
+ Configuration.getConfigurationData()!.stationTemplateUrls.forEach(
+ (stationTemplateUrl: StationTemplateUrl) => {
+ // eslint-disable-next-line @typescript-eslint/dot-notation
+ if (!isUndefined(stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl])) {
+ console.error(
+ `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
+ )}`,
+ );
+ }
+ },
+ );
+ return Configuration.getConfigurationData()?.stationTemplateUrls;
+ }
+
+ public static getSupervisionUrls(): string | string[] | undefined {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'supervisionURLs',
+ undefined,
+ "Use 'supervisionUrls' instead",
+ );
+ // eslint-disable-next-line @typescript-eslint/dot-notation
+ if (
+ !isUndefined(
+ Configuration.getConfigurationData()!['supervisionURLs' as keyof ConfigurationData],
+ )
+ ) {
+ Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![
+ // eslint-disable-next-line @typescript-eslint/dot-notation
+ 'supervisionURLs' as keyof ConfigurationData
+ ] as string | string[];
+ }
+ return Configuration.getConfigurationData()?.supervisionUrls;
+ }
+
+ public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'distributeStationToTenantEqually',
+ undefined,
+ "Use 'supervisionUrlDistribution' instead",
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'distributeStationsToTenantsEqually',
+ undefined,
+ "Use 'supervisionUrlDistribution' instead",
+ );
+ return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution')
+ ? Configuration.getConfigurationData()?.supervisionUrlDistribution
+ : SupervisionUrlDistribution.ROUND_ROBIN;
+ }
+
+ public static workerPoolInUse(): boolean {
+ return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes(
+ Configuration.buildWorkerSection().processType!,
+ );
+ }
+
+ public static workerDynamicPoolInUse(): boolean {
+ return Configuration.buildWorkerSection().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 {
+ if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
console.error(
`${chalk.green(Configuration.logPrefix())} ${chalk.red(
- "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead"
- )}`
+ `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
+ )}`,
);
}
let uiServerConfiguration: UIServerConfiguration = {
port: Constants.DEFAULT_UI_SERVER_PORT,
},
};
- if (Utils.hasOwnProp(Configuration.getConfig(), 'uiServer')) {
+ if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) {
uiServerConfiguration = merge<UIServerConfiguration>(
uiServerConfiguration,
- Configuration.getConfig()?.uiServer
+ Configuration.getConfigurationData()!.uiServer!,
);
}
- if (Utils.isCFEnvironment() === true) {
+ if (isCFEnvironment() === true) {
delete uiServerConfiguration.options?.host;
- uiServerConfiguration.options.port = parseInt(process.env.PORT);
+ uiServerConfiguration.options!.port = parseInt(process.env.PORT!);
}
return uiServerConfiguration;
}
- public static getPerformanceStorage(): StorageConfiguration {
- Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', "Use 'uri' instead");
+ private static buildPerformanceStorageSection(): StorageConfiguration {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'URI',
+ ConfigurationSection.performanceStorage,
+ "Use 'uri' instead",
+ );
let storageConfiguration: StorageConfiguration = {
enabled: false,
type: StorageType.JSON_FILE,
- uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE),
+ uri: Configuration.getDefaultPerformanceStorageUri(StorageType.JSON_FILE),
};
- if (Utils.hasOwnProp(Configuration.getConfig(), 'performanceStorage')) {
+ if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.performanceStorage)) {
storageConfiguration = {
...storageConfiguration,
- ...Configuration.getConfig()?.performanceStorage,
- ...(Configuration.getConfig()?.performanceStorage?.type === StorageType.JSON_FILE &&
- Configuration.getConfig()?.performanceStorage?.uri && {
+ ...Configuration.getConfigurationData()?.performanceStorage,
+ ...(Configuration.getConfigurationData()?.performanceStorage?.type ===
+ StorageType.JSON_FILE &&
+ Configuration.getConfigurationData()?.performanceStorage?.uri && {
uri: Configuration.buildPerformanceUriFilePath(
- new URL(Configuration.getConfig()?.performanceStorage?.uri).pathname
+ new URL(Configuration.getConfigurationData()!.performanceStorage!.uri!).pathname,
),
}),
};
return storageConfiguration;
}
- public static getAutoReconnectMaxRetries(): number | undefined {
- Configuration.warnDeprecatedConfigurationKey(
- 'autoReconnectTimeout',
- undefined,
- "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'connectionTimeout',
- undefined,
- "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'autoReconnectMaxRetries',
- undefined,
- 'Use it in charging station template instead'
- );
- // Read conf
- if (Utils.hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
- return Configuration.getConfig()?.autoReconnectMaxRetries;
- }
- }
-
- public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
- Configuration.warnDeprecatedConfigurationKey(
- 'stationTemplateURLs',
- undefined,
- "Use 'stationTemplateUrls' instead"
- );
- !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
- (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
- 'stationTemplateURLs'
- ] 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;
- }
-
- public static getLog(): LogConfiguration {
+ private static buildLogSection(): LogConfiguration {
Configuration.warnDeprecatedConfigurationKey(
'logEnabled',
undefined,
- "Use 'log' section to define the logging enablement instead"
+ `Use '${ConfigurationSection.log}' section to define the logging enablement instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logFile',
undefined,
- "Use 'log' section to define the log file instead"
+ `Use '${ConfigurationSection.log}' section to define the log file instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logErrorFile',
undefined,
- "Use 'log' section to define the log error file instead"
+ `Use '${ConfigurationSection.log}' section to define the log error file instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logConsole',
undefined,
- "Use 'log' section to define the console logging enablement instead"
+ `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logStatisticsInterval',
undefined,
- "Use 'log' section to define the log statistics interval instead"
+ `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logLevel',
undefined,
- "Use 'log' section to define the log level instead"
+ `Use '${ConfigurationSection.log}' section to define the log level instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logFormat',
undefined,
- "Use 'log' section to define the log format instead"
+ `Use '${ConfigurationSection.log}' section to define the log format instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logRotate',
undefined,
- "Use 'log' section to define the log rotation enablement instead"
+ `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logMaxFiles',
undefined,
- "Use 'log' section to define the log maximum files instead"
+ `Use '${ConfigurationSection.log}' section to define the log maximum files instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'logMaxSize',
undefined,
- "Use 'log' section to define the log maximum size instead"
+ `Use '${ConfigurationSection.log}' section to define the log maximum size instead`,
);
const defaultLogConfiguration: LogConfiguration = {
enabled: true,
rotate: true,
};
const deprecatedLogConfiguration: LogConfiguration = {
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logEnabled') && {
- enabled: Configuration.getConfig()?.logEnabled,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logEnabled') && {
+ enabled: Configuration.getConfigurationData()?.logEnabled,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFile') && {
- file: Configuration.getConfig()?.logFile,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logFile') && {
+ file: Configuration.getConfigurationData()?.logFile,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') && {
- errorFile: Configuration.getConfig()?.logErrorFile,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logErrorFile') && {
+ errorFile: Configuration.getConfigurationData()?.logErrorFile,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') && {
- statisticsInterval: Configuration.getConfig()?.logStatisticsInterval,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logStatisticsInterval') && {
+ statisticsInterval: Configuration.getConfigurationData()?.logStatisticsInterval,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') && {
- level: Configuration.getConfig()?.logLevel,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logLevel') && {
+ level: Configuration.getConfigurationData()?.logLevel,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') && {
- console: Configuration.getConfig()?.logConsole,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logConsole') && {
+ console: Configuration.getConfigurationData()?.logConsole,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') && {
- format: Configuration.getConfig()?.logFormat,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logFormat') && {
+ format: Configuration.getConfigurationData()?.logFormat,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') && {
- rotate: Configuration.getConfig()?.logRotate,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logRotate') && {
+ rotate: Configuration.getConfigurationData()?.logRotate,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && {
- maxFiles: Configuration.getConfig()?.logMaxFiles,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxFiles') && {
+ maxFiles: Configuration.getConfigurationData()?.logMaxFiles,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxSize') && {
- maxSize: Configuration.getConfig()?.logMaxSize,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxSize') && {
+ maxSize: Configuration.getConfigurationData()?.logMaxSize,
}),
};
const logConfiguration: LogConfiguration = {
...defaultLogConfiguration,
...deprecatedLogConfiguration,
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'log') && Configuration.getConfig()?.log),
+ ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.log) &&
+ Configuration.getConfigurationData()?.log),
};
return logConfiguration;
}
- public static getWorker(): WorkerConfiguration {
+ private static buildWorkerSection(): WorkerConfiguration {
Configuration.warnDeprecatedConfigurationKey(
'useWorkerPool',
undefined,
- "Use 'worker' section to define the type of worker process model instead"
+ `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'workerProcess',
undefined,
- "Use 'worker' section to define the type of worker process model instead"
+ `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'workerStartDelay',
undefined,
- "Use 'worker' section to define the worker start delay instead"
+ `Use '${ConfigurationSection.worker}' section to define the worker start delay instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'chargingStationsPerWorker',
undefined,
- "Use 'worker' section to define the number of element(s) per worker instead"
+ `Use '${ConfigurationSection.worker}' section to define the number of element(s) per worker instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'elementStartDelay',
undefined,
- "Use 'worker' section to define the worker's element start delay instead"
+ `Use '${ConfigurationSection.worker}' section to define the worker's element start delay instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolMinSize',
undefined,
- "Use 'worker' section to define the worker pool minimum size instead"
+ `Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolSize;',
undefined,
- "Use 'worker' section to define the worker pool maximum size instead"
+ `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolMaxSize;',
undefined,
- "Use 'worker' section to define the worker pool maximum size instead"
+ `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolStrategy;',
undefined,
- "Use 'worker' section to define the worker pool strategy instead"
+ `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`,
);
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,
+ startDelay: DEFAULT_WORKER_START_DELAY,
+ elementsPerWorker: 'auto',
+ elementStartDelay: DEFAULT_ELEMENT_START_DELAY,
+ poolMinSize: DEFAULT_POOL_MIN_SIZE,
+ poolMaxSize: DEFAULT_POOL_MAX_SIZE,
};
+ hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') &&
+ delete Configuration.getConfigurationData()?.workerPoolStrategy;
const deprecatedWorkerConfiguration: WorkerConfiguration = {
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') && {
- processType: Configuration.getConfig()?.workerProcess,
- }),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') && {
- startDelay: Configuration.getConfig()?.workerStartDelay,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && {
+ processType: Configuration.getConfigurationData()?.workerProcess,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') && {
- elementsPerWorker: Configuration.getConfig()?.chargingStationsPerWorker,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && {
+ startDelay: Configuration.getConfigurationData()?.workerStartDelay,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') && {
- elementStartDelay: Configuration.getConfig()?.elementStartDelay,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && {
+ elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') && {
- poolMinSize: Configuration.getConfig()?.workerPoolMinSize,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && {
+ elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') && {
- poolMaxSize: Configuration.getConfig()?.workerPoolMaxSize,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
+ poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize,
}),
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolStrategy') && {
- poolStrategy:
- Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
+ poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize,
}),
};
+ Configuration.warnDeprecatedConfigurationKey(
+ 'poolStrategy',
+ ConfigurationSection.worker,
+ 'Not publicly exposed to end users',
+ );
const workerConfiguration: WorkerConfiguration = {
...defaultWorkerConfiguration,
...deprecatedWorkerConfiguration,
- ...(Utils.hasOwnProp(Configuration.getConfig(), 'worker') &&
- Configuration.getConfig()?.worker),
+ ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) &&
+ Configuration.getConfigurationData()?.worker),
};
+ if (!Object.values(WorkerProcessType).includes(workerConfiguration.processType!)) {
+ throw new SyntaxError(
+ `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`,
+ );
+ }
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 {
- Configuration.warnDeprecatedConfigurationKey(
- 'supervisionURLs',
- undefined,
- "Use 'supervisionUrls' instead"
- );
- !Utils.isUndefined(Configuration.getConfig()['supervisionURLs']) &&
- (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as
- | string
- | string[]);
- // Read conf
- return Configuration.getConfig()?.supervisionUrls;
- }
-
- public static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
- Configuration.warnDeprecatedConfigurationKey(
- 'distributeStationToTenantEqually',
- undefined,
- "Use 'supervisionUrlDistribution' instead"
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'distributeStationsToTenantsEqually',
- undefined,
- "Use 'supervisionUrlDistribution' instead"
- );
- return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution')
- ? Configuration.getConfig()?.supervisionUrlDistribution
- : SupervisionUrlDistribution.ROUND_ROBIN;
- }
-
private static logPrefix = (): string => {
return `${new Date().toLocaleString()} Simulator configuration |`;
};
private static warnDeprecatedConfigurationKey(
key: string,
sectionName?: string,
- logMsgToAppend = ''
+ logMsgToAppend = '',
) {
if (
sectionName &&
- !Utils.isUndefined(Configuration.getConfig()[sectionName]) &&
- !Utils.isUndefined((Configuration.getConfig()[sectionName] as Record<string, unknown>)[key])
+ !isUndefined(Configuration.getConfigurationData()![sectionName as keyof ConfigurationData]) &&
+ !isUndefined(
+ (
+ Configuration.getConfigurationData()![sectionName as keyof ConfigurationData] as Record<
+ string,
+ unknown
+ >
+ )[key],
+ )
) {
console.error(
`${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])) {
+ } else if (
+ !isUndefined(Configuration.getConfigurationData()![key as keyof ConfigurationData])
+ ) {
console.error(
`${chalk.green(Configuration.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) {
+ private static getConfigurationData(): ConfigurationData | undefined {
+ if (!Configuration.configurationData) {
try {
- Configuration.configuration = JSON.parse(
- fs.readFileSync(Configuration.configurationFile, 'utf8')
+ Configuration.configurationData = JSON.parse(
+ readFileSync(Configuration.configurationFile, 'utf8'),
) as ConfigurationData;
+ if (!Configuration.configurationFileWatcher) {
+ Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
+ }
} catch (error) {
Configuration.handleFileException(
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix()
+ Configuration.logPrefix(),
);
}
- if (!Configuration.configurationFileWatcher) {
- Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
- }
}
- return Configuration.configuration;
+ return Configuration.configurationData;
}
- private static getConfigurationFileWatcher(): fs.FSWatcher | undefined {
+ private static getConfigurationFileWatcher(): FSWatcher | undefined {
try {
- return fs.watch(Configuration.configurationFile, (event, filename): void => {
- if (filename?.trim().length > 0 && event === 'change') {
- // Nullify to force configuration file reading
- Configuration.configuration = null;
- if (!Utils.isUndefined(Configuration.configurationChangeCallback)) {
- Configuration.configurationChangeCallback().catch((error) => {
+ return watch(Configuration.configurationFile, (event, filename): void => {
+ if (filename!.trim()!.length > 0 && event === 'change') {
+ delete Configuration.configurationData;
+ Configuration.configurationSectionCache.clear();
+ if (!isUndefined(Configuration.configurationChangeCallback)) {
+ Configuration.configurationChangeCallback!().catch((error) => {
throw typeof error === 'string' ? new Error(error) : error;
});
}
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix()
+ Configuration.logPrefix(),
);
}
}
file: string,
fileType: FileType,
error: NodeJS.ErrnoException,
- logPrefix: string
+ logPrefix: string,
): void {
- const prefix = Utils.isNotEmptyString(logPrefix) ? `${logPrefix} ` : '';
+ const prefix = isNotEmptyString(logPrefix) ? `${logPrefix} ` : '';
let logMsg: string;
switch (error.code) {
case 'ENOENT':
switch (storageType) {
case StorageType.JSON_FILE:
return Configuration.buildPerformanceUriFilePath(
- Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME
+ `${Constants.DEFAULT_PERFORMANCE_DIRECTORY}/${Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME}`,
);
case StorageType.SQLITE:
return Configuration.buildPerformanceUriFilePath(
- `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`
+ `${Constants.DEFAULT_PERFORMANCE_DIRECTORY}/${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
- )}`;
+ return `file://${join(resolve(dirname(fileURLToPath(import.meta.url)), '../'), file)}`;
}
}