import { type FSWatcher, readFileSync, watch } from 'node:fs';
import { dirname, join, resolve } from 'node:path';
+import { env } from 'node:process';
import { fileURLToPath } from 'node:url';
import chalk from 'chalk';
import merge from 'just-merge';
import { Constants } from './Constants';
-import { hasOwnProp, isCFEnvironment, isNotEmptyString, isUndefined } from './Utils';
+import {
+ hasOwnProp,
+ isCFEnvironment,
+ isNotEmptyString,
+ isUndefined,
+ logPrefix,
+ once,
+} from './Utils';
import {
ApplicationProtocol,
type ConfigurationData,
| WorkerConfiguration
| UIServerConfiguration;
+// Avoid ESM race condition at class initialization
+const configurationLogPrefix = (): string => {
+ return logPrefix(' Simulator configuration |');
+};
+
export class Configuration {
+ public static configurationChangeCallback: () => Promise<void>;
+
private static configurationFile = join(
dirname(fileURLToPath(import.meta.url)),
'assets',
'config.json',
);
- private static configurationFileWatcher?: FSWatcher;
+ private static configurationFileReloading = false;
private static configurationData?: ConfigurationData;
+ private static configurationFileWatcher?: FSWatcher;
private static configurationSectionCache = new Map<
ConfigurationSection,
ConfigurationSectionType
[ConfigurationSection.uiServer, Configuration.buildUIServerSection()],
]);
- private static configurationChangeCallback?: () => Promise<void>;
-
private constructor() {
// This is intentional
}
- public static setConfigurationChangeCallback(cb: () => Promise<void>): void {
- Configuration.configurationChangeCallback = cb;
- }
-
public static getConfigurationSection<T extends ConfigurationSectionType>(
sectionName: ConfigurationSection,
): T {
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`,
- )}`,
- );
- }
- },
+ const checkDeprecatedConfigurationKeysOnce = once(
+ Configuration.checkDeprecatedConfigurationKeys.bind(Configuration),
+ Configuration,
);
+ checkDeprecatedConfigurationKeysOnce();
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' as keyof ConfigurationData],
)
) {
Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![
- // eslint-disable-next-line @typescript-eslint/dot-notation
'supervisionURLs' as keyof ConfigurationData
] as string | string[];
}
}
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(
+ return [WorkerProcessType.dynamicPool, WorkerProcessType.fixedPool].includes(
Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
.processType!,
);
}
private static buildUIServerSection(): UIServerConfiguration {
- if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
- console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
- `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
- )}`,
- );
- }
let uiServerConfiguration: UIServerConfiguration = {
enabled: false,
type: ApplicationProtocol.WS,
}
if (isCFEnvironment() === true) {
delete uiServerConfiguration.options?.host;
- uiServerConfiguration.options!.port = parseInt(process.env.PORT!);
+ uiServerConfiguration.options!.port = parseInt(env.PORT!);
}
return uiServerConfiguration;
}
private static buildPerformanceStorageSection(): StorageConfiguration {
- Configuration.warnDeprecatedConfigurationKey(
- 'URI',
- ConfigurationSection.performanceStorage,
- "Use 'uri' instead",
- );
let storageConfiguration: StorageConfiguration = {
enabled: false,
type: StorageType.JSON_FILE,
}
private static buildLogSection(): LogConfiguration {
- Configuration.warnDeprecatedConfigurationKey(
- 'logEnabled',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the logging enablement instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logFile',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log file instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logErrorFile',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log error file instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logConsole',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logStatisticsInterval',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logLevel',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log level instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logFormat',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log format instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logRotate',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logMaxFiles',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log maximum files instead`,
- );
- Configuration.warnDeprecatedConfigurationKey(
- 'logMaxSize',
- undefined,
- `Use '${ConfigurationSection.log}' section to define the log maximum size instead`,
- );
const defaultLogConfiguration: LogConfiguration = {
enabled: true,
file: 'logs/combined.log',
}
private static buildWorkerSection(): WorkerConfiguration {
+ const defaultWorkerConfiguration: WorkerConfiguration = {
+ processType: WorkerProcessType.workerSet,
+ startDelay: DEFAULT_WORKER_START_DELAY,
+ elementsPerWorker: 'auto',
+ elementStartDelay: DEFAULT_ELEMENT_START_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(), 'elementStartDelay') && {
+ elementStartDelay: Configuration.getConfigurationData()?.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),
+ };
+ if (!Object.values(WorkerProcessType).includes(workerConfiguration.processType!)) {
+ throw new SyntaxError(
+ `Invalid worker process type '${workerConfiguration.processType}' defined in configuration`,
+ );
+ }
+ return workerConfiguration;
+ }
+
+ private static checkDeprecatedConfigurationKeys() {
+ // connection timeout
+ 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",
+ );
+ // connection retries
+ Configuration.warnDeprecatedConfigurationKey(
+ 'autoReconnectMaxRetries',
+ undefined,
+ 'Use it in charging station template instead',
+ );
+ // station template url(s)
+ Configuration.warnDeprecatedConfigurationKey(
+ 'stationTemplateURLs',
+ undefined,
+ "Use 'stationTemplateUrls' instead",
+ );
+ !isUndefined(
+ Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData],
+ ) &&
+ (Configuration.getConfigurationData()!.stationTemplateUrls =
+ Configuration.getConfigurationData()![
+ 'stationTemplateURLs' as keyof ConfigurationData
+ ] as StationTemplateUrl[]);
+ Configuration.getConfigurationData()?.stationTemplateUrls.forEach(
+ (stationTemplateUrl: StationTemplateUrl) => {
+ if (!isUndefined(stationTemplateUrl?.['numberOfStation' as keyof StationTemplateUrl])) {
+ console.error(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
+ `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
+ )}`,
+ );
+ }
+ },
+ );
+ // supervision url(s)
+ Configuration.warnDeprecatedConfigurationKey(
+ 'supervisionURLs',
+ undefined,
+ "Use 'supervisionUrls' instead",
+ );
+ // supervision urls distribution
+ Configuration.warnDeprecatedConfigurationKey(
+ 'distributeStationToTenantEqually',
+ undefined,
+ "Use 'supervisionUrlDistribution' instead",
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'distributeStationsToTenantsEqually',
+ undefined,
+ "Use 'supervisionUrlDistribution' instead",
+ );
+ // worker section
Configuration.warnDeprecatedConfigurationKey(
'useWorkerPool',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolSize;',
+ 'workerPoolSize',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolMaxSize;',
+ 'workerPoolMaxSize',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'workerPoolStrategy;',
+ 'workerPoolStrategy',
undefined,
`Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`,
);
- const defaultWorkerConfiguration: WorkerConfiguration = {
- processType: WorkerProcessType.workerSet,
- 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 = {
- ...(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(), 'elementStartDelay') && {
- elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay,
- }),
- ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
- poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize,
- }),
- ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
- poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize,
- }),
- };
Configuration.warnDeprecatedConfigurationKey(
'poolStrategy',
ConfigurationSection.worker,
'Not publicly exposed to end users',
);
- const workerConfiguration: WorkerConfiguration = {
- ...defaultWorkerConfiguration,
- ...deprecatedWorkerConfiguration,
- ...(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`,
+ if (
+ Configuration.getConfigurationData()?.worker?.processType ===
+ ('staticPool' as WorkerProcessType)
+ ) {
+ console.error(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
+ `Deprecated configuration 'staticPool' value usage in worker section 'processType' field. Use '${WorkerProcessType.fixedPool}' value instead`,
+ )}`,
+ );
+ }
+ // log section
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logEnabled',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the logging enablement instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logFile',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log file instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logErrorFile',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log error file instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logConsole',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logStatisticsInterval',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logLevel',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log level instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logFormat',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log format instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logRotate',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logMaxFiles',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log maximum files instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logMaxSize',
+ undefined,
+ `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(configurationLogPrefix())} ${chalk.red(
+ `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
+ )}`,
);
}
- return workerConfiguration;
}
- private static logPrefix = (): string => {
- return `${new Date().toLocaleString()} Simulator configuration |`;
- };
-
private static warnDeprecatedConfigurationKey(
key: string,
sectionName?: string,
) {
if (
sectionName &&
- !isUndefined(Configuration.getConfigurationData()![sectionName as keyof ConfigurationData]) &&
+ !isUndefined(
+ Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData],
+ ) &&
!isUndefined(
(
- Configuration.getConfigurationData()![sectionName as keyof ConfigurationData] as Record<
+ Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] as Record<
string,
unknown
>
- )[key],
+ )?.[key],
)
) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
`Deprecated configuration key '${key}' usage in section '${sectionName}'${
logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
}`,
)}`,
);
} else if (
- !isUndefined(Configuration.getConfigurationData()![key as keyof ConfigurationData])
+ !isUndefined(Configuration.getConfigurationData()?.[key as keyof ConfigurationData])
) {
console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `${chalk.green(configurationLogPrefix())} ${chalk.red(
`Deprecated configuration key '${key}' usage${
logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
}`,
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix(),
+ configurationLogPrefix(),
);
}
}
private static getConfigurationFileWatcher(): FSWatcher | undefined {
try {
return watch(Configuration.configurationFile, (event, filename): void => {
- if (filename!.trim()!.length > 0 && event === 'change') {
+ if (
+ !Configuration.configurationFileReloading &&
+ filename!.trim()!.length > 0 &&
+ event === 'change'
+ ) {
+ Configuration.configurationFileReloading = true;
+ const consoleWarnOnce = once(console.warn, this);
+ consoleWarnOnce(
+ `${chalk.green(configurationLogPrefix())} ${chalk.yellow(
+ `${FileType.Configuration} ${this.configurationFile} file have changed, reload`,
+ )}`,
+ );
delete Configuration.configurationData;
Configuration.configurationSectionCache.clear();
if (!isUndefined(Configuration.configurationChangeCallback)) {
- Configuration.configurationChangeCallback!().catch((error) => {
- throw typeof error === 'string' ? new Error(error) : error;
- });
+ Configuration.configurationChangeCallback()
+ .catch((error) => {
+ throw typeof error === 'string' ? new Error(error) : error;
+ })
+ .finally(() => {
+ Configuration.configurationFileReloading = false;
+ });
+ } else {
+ Configuration.configurationFileReloading = false;
}
}
});
Configuration.configurationFile,
FileType.Configuration,
error as NodeJS.ErrnoException,
- Configuration.logPrefix(),
+ configurationLogPrefix(),
);
}
}
file: string,
fileType: FileType,
error: NodeJS.ErrnoException,
- logPrefix: string,
+ logPfx: string,
): void {
- const prefix = isNotEmptyString(logPrefix) ? `${logPrefix} ` : '';
+ const prefix = isNotEmptyString(logPfx) ? `${logPfx} ` : '';
let logMsg: string;
switch (error.code) {
case 'ENOENT':
- logMsg = `${fileType} file ${file} not found:`;
+ logMsg = `${fileType} file ${file} not found: `;
break;
case 'EEXIST':
- logMsg = `${fileType} file ${file} already exists:`;
+ logMsg = `${fileType} file ${file} already exists: `;
break;
case 'EACCES':
- logMsg = `${fileType} file ${file} access denied:`;
+ logMsg = `${fileType} file ${file} access denied: `;
break;
case 'EPERM':
- logMsg = `${fileType} file ${file} permission denied:`;
+ logMsg = `${fileType} file ${file} permission denied: `;
break;
default:
- logMsg = `${fileType} file ${file} error:`;
+ logMsg = `${fileType} file ${file} error: `;
}
- console.error(`${chalk.green(prefix)}${chalk.red(`${logMsg} `)}`, error);
+ console.error(`${chalk.green(prefix)}${chalk.red(logMsg)}`, error);
throw error;
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff