1 import ConfigurationData
, { StationTemplateURL
} from
'../types/ConfigurationData';
3 import Constants from
'./Constants';
4 import type { WorkerChoiceStrategy
} from
'poolifier';
5 import { WorkerProcessType
} from
'../types/Worker';
7 import path from
'path';
9 export default class Configuration
{
10 private static configurationFilePath
= path
.join(path
.resolve(__dirname
, '../'), 'assets', 'config.json');
11 private static configurationFileWatcher
: fs
.FSWatcher
;
12 private static configuration
: ConfigurationData
| null = null;
13 private static configurationChangeCallback
: () => Promise
<void>;
15 static setConfigurationChangeCallback(cb
: () => Promise
<void>): void {
16 Configuration
.configurationChangeCallback
= cb
;
19 static getStatisticsDisplayInterval(): number {
21 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'statisticsDisplayInterval') ? Configuration
.getConfig().statisticsDisplayInterval
: 60;
24 static getAutoReconnectMaxRetries(): number {
25 Configuration
.deprecateConfigurationKey('autoReconnectTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
26 Configuration
.deprecateConfigurationKey('connectionTimeout', 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
27 Configuration
.deprecateConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead');
29 if (Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'autoReconnectMaxRetries')) {
30 return Configuration
.getConfig().autoReconnectMaxRetries
;
34 static getStationTemplateURLs(): StationTemplateURL
[] {
35 Configuration
.getConfig().stationTemplateURLs
.forEach((stationURL
: StationTemplateURL
) => {
36 if (!Configuration
.isUndefined(stationURL
['numberOfStation'])) {
37 console
.error(`${Configuration.logPrefix()} Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead`);
41 return Configuration
.getConfig().stationTemplateURLs
;
44 static getWorkerProcess(): WorkerProcessType
{
45 Configuration
.deprecateConfigurationKey('useWorkerPool;', 'Use \'workerProcess\' to define the type of worker process to use instead');
46 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'workerProcess') ? Configuration
.getConfig().workerProcess
: WorkerProcessType
.WORKER_SET
;
49 static getWorkerStartDelay(): number {
50 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'workerStartDelay') ? Configuration
.getConfig().workerStartDelay
: Constants
.WORKER_START_DELAY
;
53 static getWorkerPoolMinSize(): number {
54 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'workerPoolMinSize') ? Configuration
.getConfig().workerPoolMinSize
: Constants
.DEFAULT_WORKER_POOL_MIN_SIZE
;
57 static getWorkerPoolMaxSize(): number {
58 Configuration
.deprecateConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead');
59 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'workerPoolMaxSize') ? Configuration
.getConfig().workerPoolMaxSize
: Constants
.DEFAULT_WORKER_POOL_MAX_SIZE
;
62 static getWorkerPoolStrategy(): WorkerChoiceStrategy
{
63 return Configuration
.getConfig().workerPoolStrategy
;
66 static getChargingStationsPerWorker(): number {
67 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'chargingStationsPerWorker') ? Configuration
.getConfig().chargingStationsPerWorker
: Constants
.DEFAULT_CHARGING_STATIONS_PER_WORKER
;
70 static getLogConsole(): boolean {
71 Configuration
.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead');
72 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logConsole') ? Configuration
.getConfig().logConsole
: false;
75 static getLogFormat(): string {
76 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logFormat') ? Configuration
.getConfig().logFormat
: 'simple';
79 static getLogRotate(): boolean {
80 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logRotate') ? Configuration
.getConfig().logRotate
: true;
83 static getLogMaxFiles(): number {
84 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logMaxFiles') ? Configuration
.getConfig().logMaxFiles
: 7;
87 static getLogLevel(): string {
88 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logLevel') ? Configuration
.getConfig().logLevel
: 'info';
91 static getLogFile(): string {
92 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logFile') ? Configuration
.getConfig().logFile
: 'combined.log';
95 static getLogErrorFile(): string {
96 Configuration
.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead');
97 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'logErrorFile') ? Configuration
.getConfig().logErrorFile
: 'error.log';
100 static getSupervisionURLs(): string[] {
102 return Configuration
.getConfig().supervisionURLs
;
105 static getDistributeStationsToTenantsEqually(): boolean {
106 Configuration
.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead');
107 return Configuration
.objectHasOwnProperty(Configuration
.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration
.getConfig().distributeStationsToTenantsEqually
: true;
110 private static logPrefix(): string {
111 return new Date().toLocaleString() + ' Simulator configuration |';
114 private static deprecateConfigurationKey(key
: string, logMsgToAppend
= '') {
115 if (!Configuration
.isUndefined(Configuration
.getConfig()[key
])) {
116 console
.error(`${Configuration.logPrefix()} Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}`);
120 // Read the config file
121 private static getConfig(): ConfigurationData
{
122 if (!Configuration
.configuration
) {
124 Configuration
.configuration
= JSON
.parse(fs
.readFileSync(Configuration
.configurationFilePath
, 'utf8')) as ConfigurationData
;
126 Configuration
.handleFileException(Configuration
.logPrefix(), 'Configuration', Configuration
.configurationFilePath
, error
);
128 if (!Configuration
.configurationFileWatcher
) {
129 Configuration
.configurationFileWatcher
= Configuration
.getConfigurationFileWatcher();
132 return Configuration
.configuration
;
135 private static getConfigurationFileWatcher(): fs
.FSWatcher
{
137 // eslint-disable-next-line @typescript-eslint/no-misused-promises
138 return fs
.watch(Configuration
.configurationFilePath
).on('change', async (): Promise
<void> => {
139 // Nullify to force configuration file reading
140 Configuration
.configuration
= null;
141 if (!Configuration
.isUndefined(Configuration
.configurationChangeCallback
)) {
142 await Configuration
.configurationChangeCallback();
146 Configuration
.handleFileException(Configuration
.logPrefix(), 'Configuration', Configuration
.configurationFilePath
, error
);
150 private static objectHasOwnProperty(object
: any, property
: string): boolean {
151 return Object.prototype
.hasOwnProperty
.call(object
, property
) as boolean;
154 private static isUndefined(obj
: any): boolean {
155 return typeof obj
=== 'undefined';
158 private static handleFileException(logPrefix
: string, fileType
: string, filePath
: string, error
: NodeJS
.ErrnoException
): void {
159 const prefix
= logPrefix
.length
!== 0 ? logPrefix
+ ' ' : '';
160 if (error
.code
=== 'ENOENT') {
161 console
.error(prefix
+ fileType
+ ' file ' + filePath
+ ' not found: ', error
);
163 console
.error(prefix
+ fileType
+ ' file ' + filePath
+ ' opening error: ', error
);