import {
ApplicationProtocol,
type ConfigurationData,
+ ConfigurationSection,
FileType,
type LogConfiguration,
type StationTemplateUrl,
} from '../types';
import { WorkerConstants, WorkerProcessType } from '../worker';
-enum ConfigurationSection {
- log = 'log',
- performanceStorage = 'storage',
- worker = 'worker',
- uiServer = 'uiServer',
-}
+type ConfigurationSectionType =
+ | LogConfiguration
+ | StorageConfiguration
+ | WorkerConfiguration
+ | UIServerConfiguration;
export class Configuration {
private static configurationFile = join(
'config.json',
);
- private static configurationFileWatcher: FSWatcher | undefined;
- private static configuration: ConfigurationData | null = null;
+ private static configurationFileWatcher?: FSWatcher;
+ private static configurationData?: ConfigurationData;
private static configurationSectionCache = new Map<
ConfigurationSection,
- LogConfiguration | StorageConfiguration | WorkerConfiguration | UIServerConfiguration
- >();
+ ConfigurationSectionType
+ >([
+ [ConfigurationSection.log, Configuration.buildLogSection()],
+ [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()],
+ [ConfigurationSection.worker, Configuration.buildWorkerSection()],
+ [ConfigurationSection.uiServer, Configuration.buildUIServerSection()],
+ ]);
private static configurationChangeCallback: () => Promise<void>;
Configuration.configurationChangeCallback = cb;
}
- public static getUIServer(): UIServerConfiguration {
- if (hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) {
+ public static getConfigurationSection<T extends ConfigurationSectionType>(
+ sectionName: ConfigurationSection,
+ ): T {
+ if (!Configuration.configurationSectionCache.has(sectionName)) {
+ 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}'`);
+ }
+ }
+ 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 buildUIServerSection(): UIServerConfiguration {
+ if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
console.error(
`${chalk.green(Configuration.logPrefix())} ${chalk.red(
`Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`,
port: Constants.DEFAULT_UI_SERVER_PORT,
},
};
- if (hasOwnProp(Configuration.getConfig(), ConfigurationSection.uiServer)) {
+ if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) {
uiServerConfiguration = merge<UIServerConfiguration>(
uiServerConfiguration,
- Configuration.getConfig()!.uiServer!,
+ Configuration.getConfigurationData()!.uiServer!,
);
}
if (isCFEnvironment() === true) {
delete uiServerConfiguration.options?.host;
uiServerConfiguration.options!.port = parseInt(process.env.PORT!);
}
- return Configuration.getConfigurationSection<UIServerConfiguration>(
- ConfigurationSection.uiServer,
- uiServerConfiguration,
- );
+ return uiServerConfiguration;
}
- public static getPerformanceStorage(): StorageConfiguration {
+ private static buildPerformanceStorageSection(): StorageConfiguration {
Configuration.warnDeprecatedConfigurationKey(
'URI',
ConfigurationSection.performanceStorage,
let storageConfiguration: StorageConfiguration = {
enabled: false,
type: StorageType.JSON_FILE,
- uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE),
+ uri: Configuration.getDefaultPerformanceStorageUri(StorageType.JSON_FILE),
};
- if (hasOwnProp(Configuration.getConfig(), ConfigurationSection.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 Configuration.getConfigurationSection<StorageConfiguration>(
- ConfigurationSection.performanceStorage,
- 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 (hasOwnProp(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
- return Configuration.getConfig()?.autoReconnectMaxRetries;
- }
+ return storageConfiguration;
}
- public static getStationTemplateUrls(): StationTemplateUrl[] | undefined {
- Configuration.warnDeprecatedConfigurationKey(
- 'stationTemplateURLs',
- undefined,
- "Use 'stationTemplateUrls' instead",
- );
- // eslint-disable-next-line @typescript-eslint/dot-notation
- !isUndefined(Configuration.getConfig()!['stationTemplateURLs']) &&
- (Configuration.getConfig()!.stationTemplateUrls = Configuration.getConfig()![
- // eslint-disable-next-line @typescript-eslint/dot-notation
- 'stationTemplateURLs'
- ] as StationTemplateUrl[]);
- Configuration.getConfig()!.stationTemplateUrls.forEach(
- (stationTemplateUrl: StationTemplateUrl) => {
- // eslint-disable-next-line @typescript-eslint/dot-notation
- if (!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,
rotate: true,
};
const deprecatedLogConfiguration: LogConfiguration = {
- ...(hasOwnProp(Configuration.getConfig(), 'logEnabled') && {
- enabled: Configuration.getConfig()?.logEnabled,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logEnabled') && {
+ enabled: Configuration.getConfigurationData()?.logEnabled,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logFile') && {
- file: Configuration.getConfig()?.logFile,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logFile') && {
+ file: Configuration.getConfigurationData()?.logFile,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logErrorFile') && {
- errorFile: Configuration.getConfig()?.logErrorFile,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logErrorFile') && {
+ errorFile: Configuration.getConfigurationData()?.logErrorFile,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') && {
- statisticsInterval: Configuration.getConfig()?.logStatisticsInterval,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logStatisticsInterval') && {
+ statisticsInterval: Configuration.getConfigurationData()?.logStatisticsInterval,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logLevel') && {
- level: Configuration.getConfig()?.logLevel,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logLevel') && {
+ level: Configuration.getConfigurationData()?.logLevel,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logConsole') && {
- console: Configuration.getConfig()?.logConsole,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logConsole') && {
+ console: Configuration.getConfigurationData()?.logConsole,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logFormat') && {
- format: Configuration.getConfig()?.logFormat,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logFormat') && {
+ format: Configuration.getConfigurationData()?.logFormat,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logRotate') && {
- rotate: Configuration.getConfig()?.logRotate,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logRotate') && {
+ rotate: Configuration.getConfigurationData()?.logRotate,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && {
- maxFiles: Configuration.getConfig()?.logMaxFiles,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxFiles') && {
+ maxFiles: Configuration.getConfigurationData()?.logMaxFiles,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'logMaxSize') && {
- maxSize: Configuration.getConfig()?.logMaxSize,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxSize') && {
+ maxSize: Configuration.getConfigurationData()?.logMaxSize,
}),
};
const logConfiguration: LogConfiguration = {
...defaultLogConfiguration,
...deprecatedLogConfiguration,
- ...(hasOwnProp(Configuration.getConfig(), ConfigurationSection.log) &&
- Configuration.getConfig()?.log),
+ ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.log) &&
+ Configuration.getConfigurationData()?.log),
};
- return Configuration.getConfigurationSection<LogConfiguration>(
- ConfigurationSection.log,
- logConfiguration,
- );
+ return logConfiguration;
}
- public static getWorker(): WorkerConfiguration {
+ private static buildWorkerSection(): WorkerConfiguration {
Configuration.warnDeprecatedConfigurationKey(
'useWorkerPool',
undefined,
poolMinSize: WorkerConstants.DEFAULT_POOL_MIN_SIZE,
poolMaxSize: WorkerConstants.DEFAULT_POOL_MAX_SIZE,
};
- hasOwnProp(Configuration.getConfig(), 'workerPoolStrategy') &&
- delete Configuration.getConfig()?.workerPoolStrategy;
+ hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') &&
+ delete Configuration.getConfigurationData()?.workerPoolStrategy;
const deprecatedWorkerConfiguration: WorkerConfiguration = {
- ...(hasOwnProp(Configuration.getConfig(), 'workerProcess') && {
- processType: Configuration.getConfig()?.workerProcess,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && {
+ processType: Configuration.getConfigurationData()?.workerProcess,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'workerStartDelay') && {
- startDelay: Configuration.getConfig()?.workerStartDelay,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && {
+ startDelay: Configuration.getConfigurationData()?.workerStartDelay,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') && {
- elementsPerWorker: Configuration.getConfig()?.chargingStationsPerWorker,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && {
+ elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'elementStartDelay') && {
- elementStartDelay: Configuration.getConfig()?.elementStartDelay,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && {
+ elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') && {
- poolMinSize: Configuration.getConfig()?.workerPoolMinSize,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
+ poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize,
}),
- ...(hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') && {
- poolMaxSize: Configuration.getConfig()?.workerPoolMaxSize,
+ ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
+ poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize,
}),
};
Configuration.warnDeprecatedConfigurationKey(
const workerConfiguration: WorkerConfiguration = {
...defaultWorkerConfiguration,
...deprecatedWorkerConfiguration,
- ...(hasOwnProp(Configuration.getConfig(), ConfigurationSection.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 Configuration.getConfigurationSection<WorkerConfiguration>(
- ConfigurationSection.worker,
- 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",
- );
- // eslint-disable-next-line @typescript-eslint/dot-notation
- if (!isUndefined(Configuration.getConfig()!['supervisionURLs'])) {
- // eslint-disable-next-line @typescript-eslint/dot-notation
- 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 hasOwnProp(Configuration.getConfig(), 'supervisionUrlDistribution')
- ? Configuration.getConfig()?.supervisionUrlDistribution
- : SupervisionUrlDistribution.ROUND_ROBIN;
+ return workerConfiguration;
}
private static logPrefix = (): string => {
) {
if (
sectionName &&
- !isUndefined(Configuration.getConfig()![sectionName]) &&
- !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(
}`,
)}`,
);
- } else if (!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${
}
}
- private static getConfigurationSection<T>(
- sectionName: ConfigurationSection,
- sectionConfiguration?: T,
- ): T {
- if (!Configuration.configurationSectionCache.has(sectionName) && sectionConfiguration) {
- Configuration.configurationSectionCache.set(sectionName, sectionConfiguration);
- }
- return Configuration.configurationSectionCache.get(sectionName) as T;
- }
-
- private static getConfig(): ConfigurationData | null {
- if (!Configuration.configuration) {
+ private static getConfigurationData(): ConfigurationData | undefined {
+ if (!Configuration.configurationData) {
try {
- Configuration.configuration = JSON.parse(
+ Configuration.configurationData = JSON.parse(
readFileSync(Configuration.configurationFile, 'utf8'),
) as ConfigurationData;
+ if (!Configuration.configurationFileWatcher) {
+ Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
+ }
} catch (error) {
Configuration.handleFileException(
Configuration.configurationFile,
Configuration.logPrefix(),
);
}
- if (!Configuration.configurationFileWatcher) {
- Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
- }
}
- return Configuration.configuration;
+ return Configuration.configurationData;
}
private static getConfigurationFileWatcher(): FSWatcher | undefined {
try {
return watch(Configuration.configurationFile, (event, filename): void => {
if (filename!.trim()!.length > 0 && event === 'change') {
- // Nullify to force configuration file reading
- Configuration.configuration = null;
+ delete Configuration.configurationData;
Configuration.configurationSectionCache.clear();
if (!isUndefined(Configuration.configurationChangeCallback)) {
Configuration.configurationChangeCallback().catch((error) => {
repositories / e-mobility-charging-stations-simulator.git / blobdiff