-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
import chalk from 'chalk';
+import merge from 'just-merge';
import { WorkerChoiceStrategies } from 'poolifier';
+import Constants from './Constants';
import {
type ConfigurationData,
type StationTemplateUrl,
import { ApplicationProtocol } from '../types/UIProtocol';
import { WorkerProcessType } from '../types/Worker';
import WorkerConstants from '../worker/WorkerConstants';
-import Constants from './Constants';
export default class Configuration {
private static configurationFile = path.join(
'config.json'
);
- private static configurationFileWatcher: fs.FSWatcher;
+ private static configurationFileWatcher: fs.FSWatcher | undefined;
private static configuration: ConfigurationData | null = null;
private static configurationChangeCallback: () => Promise<void>;
Configuration.configurationChangeCallback = cb;
}
- static getLogStatisticsInterval(): number {
+ static getLogStatisticsInterval(): number | undefined {
Configuration.warnDeprecatedConfigurationKey(
'statisticsDisplayInterval',
- null,
+ undefined,
"Use 'logStatisticsInterval' instead"
);
// Read conf
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval')
- ? Configuration.getConfig().logStatisticsInterval
+ ? Configuration.getConfig()?.logStatisticsInterval
: Constants.DEFAULT_LOG_STATISTICS_INTERVAL;
}
},
};
if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) {
- uiServerConfiguration = Configuration.deepMerge(
- uiServerConfiguration,
- Configuration.getConfig().uiServer
- );
+ uiServerConfiguration = merge(uiServerConfiguration, Configuration.getConfig()?.uiServer);
}
if (Configuration.isCFEnvironment() === true) {
- delete uiServerConfiguration.options.host;
+ delete uiServerConfiguration.options?.host;
uiServerConfiguration.options.port = parseInt(process.env.PORT);
}
return uiServerConfiguration;
if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
storageConfiguration = {
...storageConfiguration,
- ...Configuration.getConfig().performanceStorage,
+ ...Configuration.getConfig()?.performanceStorage,
};
}
return storageConfiguration;
}
- static getAutoReconnectMaxRetries(): number {
+ static getAutoReconnectMaxRetries(): number | undefined {
Configuration.warnDeprecatedConfigurationKey(
'autoReconnectTimeout',
- null,
+ undefined,
"Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
);
Configuration.warnDeprecatedConfigurationKey(
'connectionTimeout',
- null,
+ undefined,
"Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
);
Configuration.warnDeprecatedConfigurationKey(
'autoReconnectMaxRetries',
- null,
+ undefined,
'Use it in charging station template instead'
);
// Read conf
if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
- return Configuration.getConfig().autoReconnectMaxRetries;
+ return Configuration.getConfig()?.autoReconnectMaxRetries;
}
}
- static getStationTemplateUrls(): StationTemplateUrl[] {
+ static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
Configuration.warnDeprecatedConfigurationKey(
'stationTemplateURLs',
- null,
+ undefined,
"Use 'stationTemplateUrls' instead"
);
!Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) &&
(Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()[
'stationTemplateURLs'
- ] as StationTemplateUrl[]);
+ ] as unknown as StationTemplateUrl[]);
Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => {
if (!Configuration.isUndefined(stationUrl['numberOfStation'])) {
console.error(
}
});
// Read conf
- return Configuration.getConfig().stationTemplateUrls;
+ return Configuration.getConfig()?.stationTemplateUrls;
}
static getWorker(): WorkerConfiguration {
Configuration.warnDeprecatedConfigurationKey(
'useWorkerPool',
- null,
+ undefined,
"Use 'worker' section to define the type of worker process model instead"
);
Configuration.warnDeprecatedConfigurationKey(
'workerProcess',
- null,
+ undefined,
"Use 'worker' section to define the type of worker process model instead"
);
Configuration.warnDeprecatedConfigurationKey(
'workerStartDelay',
- null,
+ undefined,
"Use 'worker' section to define the worker start delay instead"
);
Configuration.warnDeprecatedConfigurationKey(
'chargingStationsPerWorker',
- null,
+ undefined,
"Use 'worker' section to define the number of element(s) per worker instead"
);
Configuration.warnDeprecatedConfigurationKey(
'elementStartDelay',
- null,
+ undefined,
"Use 'worker' section to define the worker's element start delay instead"
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolMinSize',
- null,
+ undefined,
"Use 'worker' section to define the worker pool minimum size instead"
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolSize;',
- null,
+ undefined,
"Use 'worker' section to define the worker pool maximum size instead"
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolMaxSize;',
- null,
+ undefined,
"Use 'worker' section to define the worker pool maximum size instead"
);
Configuration.warnDeprecatedConfigurationKey(
'workerPoolStrategy;',
- null,
+ undefined,
"Use 'worker' section to define the worker pool strategy instead"
);
let workerConfiguration: WorkerConfiguration = {
processType: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess')
- ? Configuration.getConfig().workerProcess
+ ? Configuration.getConfig()?.workerProcess
: WorkerProcessType.WORKER_SET,
startDelay: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay')
- ? Configuration.getConfig().workerStartDelay
+ ? Configuration.getConfig()?.workerStartDelay
: WorkerConstants.DEFAULT_WORKER_START_DELAY,
elementsPerWorker: Configuration.objectHasOwnProperty(
Configuration.getConfig(),
'chargingStationsPerWorker'
)
- ? Configuration.getConfig().chargingStationsPerWorker
+ ? Configuration.getConfig()?.chargingStationsPerWorker
: WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER,
elementStartDelay: Configuration.objectHasOwnProperty(
Configuration.getConfig(),
'elementStartDelay'
)
- ? Configuration.getConfig().elementStartDelay
+ ? Configuration.getConfig()?.elementStartDelay
: WorkerConstants.DEFAULT_ELEMENT_START_DELAY,
poolMinSize: Configuration.objectHasOwnProperty(
Configuration.getConfig(),
'workerPoolMinSize'
)
- ? Configuration.getConfig().workerPoolMinSize
+ ? Configuration.getConfig()?.workerPoolMinSize
: WorkerConstants.DEFAULT_POOL_MIN_SIZE,
poolMaxSize: Configuration.objectHasOwnProperty(
Configuration.getConfig(),
'workerPoolMaxSize'
)
- ? Configuration.getConfig().workerPoolMaxSize
+ ? Configuration.getConfig()?.workerPoolMaxSize
: WorkerConstants.DEFAULT_POOL_MAX_SIZE,
poolStrategy:
- Configuration.getConfig().workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
+ Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN,
};
if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'worker')) {
- workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig().worker };
+ workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker };
}
return workerConfiguration;
}
- static getLogConsole(): boolean {
- Configuration.warnDeprecatedConfigurationKey('consoleLog', null, "Use 'logConsole' instead");
+ static getLogConsole(): boolean | undefined {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'consoleLog',
+ undefined,
+ "Use 'logConsole' instead"
+ );
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole')
- ? Configuration.getConfig().logConsole
+ ? Configuration.getConfig()?.logConsole
: false;
}
- static getLogFormat(): string {
+ static getLogFormat(): string | undefined {
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat')
- ? Configuration.getConfig().logFormat
+ ? Configuration.getConfig()?.logFormat
: 'simple';
}
- static getLogRotate(): boolean {
+ static getLogRotate(): boolean | undefined {
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate')
- ? Configuration.getConfig().logRotate
+ ? Configuration.getConfig()?.logRotate
: true;
}
- static getLogMaxFiles(): number {
- return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles')
- ? Configuration.getConfig().logMaxFiles
- : 7;
+ static getLogMaxFiles(): number | string | false | undefined {
+ return (
+ Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') &&
+ Configuration.getConfig()?.logMaxFiles
+ );
}
- static getLogLevel(): string {
+ static getLogMaxSize(): number | string | false | undefined {
+ return (
+ Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') &&
+ Configuration.getConfig()?.logMaxSize
+ );
+ }
+
+ static getLogLevel(): string | undefined {
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel')
- ? Configuration.getConfig().logLevel.toLowerCase()
+ ? Configuration.getConfig()?.logLevel?.toLowerCase()
: 'info';
}
- static getLogFile(): string {
+ static getLogFile(): string | undefined {
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile')
- ? Configuration.getConfig().logFile
+ ? Configuration.getConfig()?.logFile
: 'combined.log';
}
- static getLogErrorFile(): string {
- Configuration.warnDeprecatedConfigurationKey('errorFile', null, "Use 'logErrorFile' instead");
+ static getLogErrorFile(): string | undefined {
+ Configuration.warnDeprecatedConfigurationKey(
+ 'errorFile',
+ undefined,
+ "Use 'logErrorFile' instead"
+ );
return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile')
- ? Configuration.getConfig().logErrorFile
+ ? Configuration.getConfig()?.logErrorFile
: 'error.log';
}
- static getSupervisionUrls(): string | string[] {
+ static getSupervisionUrls(): string | string[] | undefined {
Configuration.warnDeprecatedConfigurationKey(
'supervisionURLs',
- null,
+ undefined,
"Use 'supervisionUrls' instead"
);
!Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) &&
- (Configuration.getConfig().supervisionUrls = Configuration.getConfig()[
- 'supervisionURLs'
- ] as string[]);
+ (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as
+ | string
+ | string[]);
// Read conf
- return Configuration.getConfig().supervisionUrls;
+ return Configuration.getConfig()?.supervisionUrls;
}
- static getSupervisionUrlDistribution(): SupervisionUrlDistribution {
+ static getSupervisionUrlDistribution(): SupervisionUrlDistribution | undefined {
Configuration.warnDeprecatedConfigurationKey(
'distributeStationToTenantEqually',
- null,
+ undefined,
"Use 'supervisionUrlDistribution' instead"
);
Configuration.warnDeprecatedConfigurationKey(
'distributeStationsToTenantsEqually',
- null,
+ undefined,
"Use 'supervisionUrlDistribution' instead"
);
return Configuration.objectHasOwnProperty(
Configuration.getConfig(),
'supervisionUrlDistribution'
)
- ? Configuration.getConfig().supervisionUrlDistribution
+ ? Configuration.getConfig()?.supervisionUrlDistribution
: SupervisionUrlDistribution.ROUND_ROBIN;
}
- private static logPrefix(): string {
- return new Date().toLocaleString() + ' Simulator configuration |';
- }
+ private static logPrefix = (): string => {
+ return `${new Date().toLocaleString()} Simulator configuration |`;
+ };
private static warnDeprecatedConfigurationKey(
key: string,
) {
console.error(
chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${
- logMsgToAppend && '. ' + logMsgToAppend
+ logMsgToAppend.trim().length !== 0 && `. ${logMsgToAppend}`
}}`
);
} else if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
console.error(
chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${
- logMsgToAppend && '. ' + logMsgToAppend
+ logMsgToAppend.trim().length !== 0 && `. ${logMsgToAppend}`
}}`
);
}
}
// Read the config file
- private static getConfig(): ConfigurationData {
+ private static getConfig(): ConfigurationData | null {
if (!Configuration.configuration) {
try {
Configuration.configuration = JSON.parse(
) as ConfigurationData;
} catch (error) {
Configuration.handleFileException(
- Configuration.logPrefix(),
- FileType.Configuration,
Configuration.configurationFile,
- error as NodeJS.ErrnoException
+ FileType.Configuration,
+ error as NodeJS.ErrnoException,
+ Configuration.logPrefix()
);
}
if (!Configuration.configurationFileWatcher) {
return Configuration.configuration;
}
- private static getConfigurationFileWatcher(): fs.FSWatcher {
+ private static getConfigurationFileWatcher(): fs.FSWatcher | undefined {
try {
return fs.watch(Configuration.configurationFile, (event, filename): void => {
- if (filename && event === 'change') {
+ if (filename.trim().length !== 0 && event === 'change') {
// Nullify to force configuration file reading
Configuration.configuration = null;
if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) {
});
} catch (error) {
Configuration.handleFileException(
- Configuration.logPrefix(),
- FileType.Configuration,
Configuration.configurationFile,
- error as NodeJS.ErrnoException
+ FileType.Configuration,
+ error as NodeJS.ErrnoException,
+ Configuration.logPrefix()
);
}
}
}
private static getDefaultPerformanceStorageUri(storageType: StorageType) {
- const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`;
switch (storageType) {
case StorageType.JSON_FILE:
return `file://${path.join(
case StorageType.SQLITE:
return `file://${path.join(
path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../'),
- SQLiteFileName
+ `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`
)}`;
default:
throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`);
}
}
- private static isObject(item): boolean {
- return item && typeof item === 'object' && Array.isArray(item) === false;
- }
-
private static objectHasOwnProperty(object: unknown, property: string): boolean {
return Object.prototype.hasOwnProperty.call(object, property) as boolean;
}
private static isUndefined(obj: unknown): boolean {
- return typeof obj === 'undefined';
- }
-
- private static deepMerge(target: object, ...sources: object[]): object {
- if (!sources.length) {
- return target;
- }
- const source = sources.shift();
-
- if (Configuration.isObject(target) && Configuration.isObject(source)) {
- for (const key in source) {
- if (Configuration.isObject(source[key])) {
- if (!target[key]) {
- Object.assign(target, { [key]: {} });
- }
- // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
- Configuration.deepMerge(target[key], source[key]);
- } else {
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
- Object.assign(target, { [key]: source[key] });
- }
- }
- }
- return Configuration.deepMerge(target, ...sources);
+ return obj === undefined;
}
private static handleFileException(
- logPrefix: string,
- fileType: FileType,
filePath: string,
+ fileType: FileType,
error: NodeJS.ErrnoException,
+ logPrefix: string,
params: HandleErrorParams<EmptyObject> = { throwError: true }
): void {
- const prefix = logPrefix.length !== 0 ? logPrefix + ' ' : '';
- if (error.code === 'ENOENT') {
- console.error(
- chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '),
- error
- );
- } else if (error.code === 'EEXIST') {
- console.error(
- chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '),
- error
- );
- } else if (error.code === 'EACCES') {
- console.error(
- chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '),
- error
- );
- } else {
- console.error(
- chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '),
- error
- );
+ const prefix = logPrefix.trim().length !== 0 ? `${logPrefix} ` : '';
+ let logMsg: string;
+ switch (error.code) {
+ case 'ENOENT':
+ logMsg = `${fileType} file ${filePath} not found: `;
+ break;
+ case 'EEXIST':
+ logMsg = `${fileType} file ${filePath} already exists: `;
+ break;
+ case 'EACCES':
+ logMsg = `${fileType} file ${filePath} access denied: `;
+ break;
+ default:
+ logMsg = `${fileType} file ${filePath} error: `;
}
+ console.error(`${chalk.green(prefix)}${chalk.red(logMsg)}`, error);
if (params?.throwError) {
throw error;
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff