-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,
+ logPrefix,
+ once,
+} from './Utils';
import {
ApplicationProtocol,
type ConfigurationData,
+ ConfigurationSection,
FileType,
+ type LogConfiguration,
type StationTemplateUrl,
type StorageConfiguration,
StorageType,
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)),
+ public static configurationChangeCallback: () => Promise<void>;
+
+ 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 configurationData?: ConfigurationData;
+ private static configurationFileWatcher?: FSWatcher;
+ private static configurationSectionCache = new Map<
+ ConfigurationSection,
+ ConfigurationSectionType
+ >([
+ [ConfigurationSection.log, Configuration.buildLogSection()],
+ [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()],
+ [ConfigurationSection.worker, Configuration.buildWorkerSection()],
+ [ConfigurationSection.uiServer, Configuration.buildUIServerSection()],
+ ]);
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 getLogStatisticsInterval(): number | undefined {
- Configuration.warnDeprecatedConfigurationKey(
- 'statisticsDisplayInterval',
- undefined,
- "Use 'logStatisticsInterval' instead"
+ public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+ const checkDeprecatedConfigurationKeysOnce = once(
+ Configuration.checkDeprecatedConfigurationKeys.bind(Configuration),
+ Configuration,
);
- // Read conf
- return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval')
- ? Configuration.getConfig()?.logStatisticsInterval
- : Constants.DEFAULT_LOG_STATISTICS_INTERVAL;
+ checkDeprecatedConfigurationKeysOnce();
+ return Configuration.getConfigurationData()?.stationTemplateUrls;
}
- public static getUIServer(): UIServerConfiguration {
- if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) {
- console.error(
- `${chalk.green(Configuration.logPrefix())} ${chalk.red(
- "Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead"
- )}`
- );
+ public static getSupervisionUrls(): string | string[] | undefined {
+ if (
+ !isUndefined(
+ Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData],
+ )
+ ) {
+ 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(
+ Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+ .processType!,
+ );
+ }
+
+ public static workerDynamicPoolInUse(): boolean {
+ return (
+ Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+ .processType === WorkerProcessType.dynamicPool
+ );
+ }
+
+ private static logPrefix = (): string => {
+ return logPrefix(' Simulator configuration |');
+ };
+
+ 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,
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 {
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 {
+ 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',
+ 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"
+ "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'
+ 'Use it in charging station template instead',
);
- // Read conf
- if (Utils.hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
- return Configuration.getConfig()?.autoReconnectMaxRetries;
- }
- }
-
- public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
+ // station template url(s)
Configuration.warnDeprecatedConfigurationKey(
'stationTemplateURLs',
undefined,
- "Use 'stationTemplateUrls' instead"
+ "Use 'stationTemplateUrls' instead",
);
- !Utils.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
- (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
- 'stationTemplateURLs'
- ] as StationTemplateUrl[]);
- Configuration.getConfig().stationTemplateUrls.forEach(
+ !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 (!Utils.isUndefined(stationTemplateUrl['numberOfStation'])) {
+ 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`
- )}`
+ `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`,
+ )}`,
);
}
- }
+ },
);
- // Read conf
- return Configuration.getConfig()?.stationTemplateUrls;
- }
-
- public static getWorker(): WorkerConfiguration {
+ // 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 '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;',
+ '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;',
+ '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;',
+ 'workerPoolStrategy',
undefined,
- "Use 'worker' section to define the worker pool strategy instead"
- );
- let workerConfiguration: WorkerConfiguration = {
- processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess')
- ? Configuration.getConfig()?.workerProcess
- : WorkerProcessType.workerSet,
- startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay')
- ? Configuration.getConfig()?.workerStartDelay
- : WorkerConstants.DEFAULT_WORKER_START_DELAY,
- elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker')
- ? Configuration.getConfig()?.chargingStationsPerWorker
- : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER,
- elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay')
- ? Configuration.getConfig()?.elementStartDelay
- : WorkerConstants.DEFAULT_ELEMENT_START_DELAY,
- poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize')
- ? Configuration.getConfig()?.workerPoolMinSize
- : WorkerConstants.DEFAULT_POOL_MIN_SIZE,
- poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize')
- ? Configuration.getConfig()?.workerPoolMaxSize
- : WorkerConstants.DEFAULT_POOL_MAX_SIZE,
- poolStrategy:
- Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
- };
- if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) {
- workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker };
+ `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`,
+ );
+ Configuration.warnDeprecatedConfigurationKey(
+ 'poolStrategy',
+ ConfigurationSection.worker,
+ 'Not publicly exposed to end users',
+ );
+ if (
+ Configuration.getConfigurationData()?.worker?.processType ===
+ ('staticPool' as WorkerProcessType)
+ ) {
+ console.error(
+ `${chalk.green(Configuration.logPrefix())} ${chalk.red(
+ `Deprecated configuration 'staticPool' value usage in worker section 'processType' field. Use '${WorkerProcessType.fixedPool}' value instead`,
+ )}`,
+ );
}
- return workerConfiguration;
- }
-
- public static workerPoolInUse(): boolean {
- return [WorkerProcessType.dynamicPool, WorkerProcessType.staticPool].includes(
- Configuration.getWorker().processType
+ // log section
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logEnabled',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the logging enablement instead`,
);
- }
-
- public static workerDynamicPoolInUse(): boolean {
- return Configuration.getWorker().processType === WorkerProcessType.dynamicPool;
- }
-
- public static getLogEnabled(): boolean | undefined {
- return Utils.hasOwnProp(Configuration.getConfig(), 'logEnabled')
- ? Configuration.getConfig()?.logEnabled
- : true;
- }
-
- public static getLogConsole(): boolean | undefined {
Configuration.warnDeprecatedConfigurationKey(
- 'consoleLog',
+ 'logFile',
undefined,
- "Use 'logConsole' instead"
+ `Use '${ConfigurationSection.log}' section to define the log file instead`,
);
- return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole')
- ? Configuration.getConfig()?.logConsole
- : false;
- }
-
- public static getLogFormat(): string | undefined {
- return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat')
- ? Configuration.getConfig()?.logFormat
- : 'simple';
- }
-
- public static getLogRotate(): boolean | undefined {
- return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate')
- ? Configuration.getConfig()?.logRotate
- : true;
- }
-
- public static getLogMaxFiles(): number | string | false | undefined {
- return (
- Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') &&
- Configuration.getConfig()?.logMaxFiles
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logErrorFile',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the log error file instead`,
);
- }
-
- public static getLogMaxSize(): number | string | false | undefined {
- return (
- Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') &&
- Configuration.getConfig()?.logMaxSize
+ Configuration.warnDeprecatedConfigurationKey(
+ 'logConsole',
+ undefined,
+ `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`,
);
- }
-
- public static getLogLevel(): string | undefined {
- return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel')
- ? Configuration.getConfig()?.logLevel?.toLowerCase()
- : 'info';
- }
-
- public static getLogFile(): string | undefined {
- return Utils.hasOwnProp(Configuration.getConfig(), 'logFile')
- ? Configuration.getConfig()?.logFile
- : 'combined.log';
- }
-
- public static getLogErrorFile(): string | undefined {
Configuration.warnDeprecatedConfigurationKey(
- 'errorFile',
+ 'logStatisticsInterval',
undefined,
- "Use 'logErrorFile' instead"
+ `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`,
);
- return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile')
- ? Configuration.getConfig()?.logErrorFile
- : 'error.log';
- }
-
- public static getSupervisionUrls(): string | string[] | undefined {
Configuration.warnDeprecatedConfigurationKey(
- 'supervisionURLs',
+ 'logLevel',
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 {
+ `Use '${ConfigurationSection.log}' section to define the log level instead`,
+ );
Configuration.warnDeprecatedConfigurationKey(
- 'distributeStationToTenantEqually',
+ 'logFormat',
undefined,
- "Use 'supervisionUrlDistribution' instead"
+ `Use '${ConfigurationSection.log}' section to define the log format instead`,
);
Configuration.warnDeprecatedConfigurationKey(
- 'distributeStationsToTenantsEqually',
+ 'logRotate',
undefined,
- "Use 'supervisionUrlDistribution' instead"
+ `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`,
);
- return Utils.hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution')
- ? Configuration.getConfig()?.supervisionUrlDistribution
- : SupervisionUrlDistribution.ROUND_ROBIN;
+ 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(Configuration.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(
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)) {
+ 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
+ logPfx: string,
): void {
- const prefix = Utils.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;
}
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}'`);
+ throw new Error(`Unsupported 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)}`;
}
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff