Commit | Line | Data |
---|---|---|
2dcfe98e | 1 | import ConfigurationData, { StationTemplateUrl, StorageConfiguration, SupervisionUrlDistribution, UIWebSocketServerConfiguration } from '../types/ConfigurationData'; |
e118beaa | 2 | |
322c9192 | 3 | import Constants from './Constants'; |
717c1e56 | 4 | import { EmptyObject } from '../types/EmptyObject'; |
e0a50bcd | 5 | import { HandleErrorParams } from '../types/Error'; |
6a49ad23 | 6 | import { ServerOptions } from 'ws'; |
72f041bd | 7 | import { StorageType } from '../types/Storage'; |
9efbac5b | 8 | import type { WorkerChoiceStrategy } from 'poolifier'; |
a4624c96 | 9 | import { WorkerProcessType } from '../types/Worker'; |
8eac9a09 | 10 | import chalk from 'chalk'; |
3f40bc9c | 11 | import fs from 'fs'; |
bf1866b2 | 12 | import path from 'path'; |
7dde0b73 | 13 | |
3f40bc9c | 14 | export default class Configuration { |
bf1866b2 | 15 | private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json'); |
ded13d97 | 16 | private static configurationFileWatcher: fs.FSWatcher; |
6e0964c8 | 17 | private static configuration: ConfigurationData | null = null; |
e57acf6a JB |
18 | private static configurationChangeCallback: () => Promise<void>; |
19 | ||
20 | static setConfigurationChangeCallback(cb: () => Promise<void>): void { | |
21 | Configuration.configurationChangeCallback = cb; | |
22 | } | |
7dde0b73 | 23 | |
72f041bd | 24 | static getLogStatisticsInterval(): number { |
e4362ed7 | 25 | Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', null, 'Use \'logStatisticsInterval\' instead'); |
7dde0b73 | 26 | // Read conf |
72f041bd JB |
27 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60; |
28 | } | |
29 | ||
6a49ad23 JB |
30 | static getUIWebSocketServer(): UIWebSocketServerConfiguration { |
31 | let options: ServerOptions = { | |
32 | host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST, | |
33 | port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT | |
34 | }; | |
35 | let uiWebSocketServerConfiguration: UIWebSocketServerConfiguration = { | |
36 | enabled: true, | |
37 | options | |
38 | }; | |
39 | if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiWebSocketServer')) { | |
40 | if (Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'options')) { | |
41 | options = { | |
1ba1e8fb | 42 | ...options, |
6a49ad23 JB |
43 | ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer.options, 'host') && { host: Configuration.getConfig().uiWebSocketServer.options.host }, |
44 | ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer.options, 'port') && { port: Configuration.getConfig().uiWebSocketServer.options.port } | |
45 | }; | |
46 | } | |
47 | uiWebSocketServerConfiguration = | |
48 | { | |
1ba1e8fb | 49 | ...uiWebSocketServerConfiguration, |
6a49ad23 JB |
50 | ...Configuration.objectHasOwnProperty(Configuration.getConfig().uiWebSocketServer, 'enabled') && { enabled: Configuration.getConfig().uiWebSocketServer.enabled }, |
51 | options | |
52 | }; | |
53 | } | |
54 | return uiWebSocketServerConfiguration; | |
55 | } | |
56 | ||
72f041bd | 57 | static getPerformanceStorage(): StorageConfiguration { |
1f5df42a | 58 | Configuration.warnDeprecatedConfigurationKey('URI', 'performanceStorage', 'Use \'uri\' instead'); |
6a49ad23 JB |
59 | let storageConfiguration: StorageConfiguration = { |
60 | enabled: false, | |
61 | type: StorageType.JSON_FILE, | |
1f5df42a | 62 | uri: this.getDefaultPerformanceStorageUri(StorageType.JSON_FILE) |
6a49ad23 | 63 | }; |
72f041bd JB |
64 | if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) { |
65 | storageConfiguration = | |
66 | { | |
1ba1e8fb JB |
67 | ...storageConfiguration, |
68 | ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') && { enabled: Configuration.getConfig().performanceStorage.enabled }, | |
69 | ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'type') && { type: Configuration.getConfig().performanceStorage.type }, | |
70 | ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'uri') && { uri: this.getDefaultPerformanceStorageUri(Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE) } | |
72f041bd | 71 | }; |
72f041bd JB |
72 | } |
73 | return storageConfiguration; | |
7dde0b73 JB |
74 | } |
75 | ||
9ccca265 | 76 | static getAutoReconnectMaxRetries(): number { |
e4362ed7 JB |
77 | Configuration.warnDeprecatedConfigurationKey('autoReconnectTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead'); |
78 | Configuration.warnDeprecatedConfigurationKey('connectionTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead'); | |
79 | Configuration.warnDeprecatedConfigurationKey('autoReconnectMaxRetries', null, 'Use it in charging station template instead'); | |
7dde0b73 | 80 | // Read conf |
963ee397 | 81 | if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) { |
3574dfd3 JB |
82 | return Configuration.getConfig().autoReconnectMaxRetries; |
83 | } | |
7dde0b73 JB |
84 | } |
85 | ||
1f5df42a JB |
86 | static getStationTemplateUrls(): StationTemplateUrl[] { |
87 | Configuration.warnDeprecatedConfigurationKey('stationTemplateURLs', null, 'Use \'stationTemplateUrls\' instead'); | |
88 | !Configuration.isUndefined(Configuration.getConfig()['stationTemplateURLs']) && (Configuration.getConfig().stationTemplateUrls = Configuration.getConfig()['stationTemplateURLs'] as StationTemplateUrl[]); | |
89 | Configuration.getConfig().stationTemplateUrls.forEach((stationUrl: StationTemplateUrl) => { | |
90 | if (!Configuration.isUndefined(stationUrl['numberOfStation'])) { | |
91 | console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${stationUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead}`); | |
eb3937cb JB |
92 | } |
93 | }); | |
7dde0b73 | 94 | // Read conf |
1f5df42a | 95 | return Configuration.getConfig().stationTemplateUrls; |
7dde0b73 JB |
96 | } |
97 | ||
a4624c96 | 98 | static getWorkerProcess(): WorkerProcessType { |
e4362ed7 | 99 | Configuration.warnDeprecatedConfigurationKey('useWorkerPool;', null, 'Use \'workerProcess\' to define the type of worker process to use instead'); |
a4624c96 JB |
100 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig().workerProcess : WorkerProcessType.WORKER_SET; |
101 | } | |
102 | ||
322c9192 JB |
103 | static getWorkerStartDelay(): number { |
104 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig().workerStartDelay : Constants.WORKER_START_DELAY; | |
105 | } | |
106 | ||
4bfd80fa JB |
107 | static getElementStartDelay(): number { |
108 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'elementStartDelay') ? Configuration.getConfig().elementStartDelay : Constants.ELEMENT_START_DELAY; | |
109 | } | |
110 | ||
a4624c96 | 111 | static getWorkerPoolMinSize(): number { |
1f0052b9 | 112 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE; |
7dde0b73 JB |
113 | } |
114 | ||
4fa59b8a | 115 | static getWorkerPoolMaxSize(): number { |
e4362ed7 | 116 | Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', null, 'Use \'workerPoolMaxSize\' instead'); |
1f0052b9 | 117 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE; |
7dde0b73 JB |
118 | } |
119 | ||
9efbac5b JB |
120 | static getWorkerPoolStrategy(): WorkerChoiceStrategy { |
121 | return Configuration.getConfig().workerPoolStrategy; | |
122 | } | |
123 | ||
3d2ff9e4 | 124 | static getChargingStationsPerWorker(): number { |
1f0052b9 | 125 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER; |
3d2ff9e4 J |
126 | } |
127 | ||
7ec46a9a | 128 | static getLogConsole(): boolean { |
e4362ed7 | 129 | Configuration.warnDeprecatedConfigurationKey('consoleLog', null, 'Use \'logConsole\' instead'); |
963ee397 | 130 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false; |
7dde0b73 JB |
131 | } |
132 | ||
a4a21709 | 133 | static getLogFormat(): string { |
963ee397 | 134 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple'; |
027b409a JB |
135 | } |
136 | ||
6bf6769e | 137 | static getLogRotate(): boolean { |
963ee397 | 138 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true; |
6bf6769e JB |
139 | } |
140 | ||
141 | static getLogMaxFiles(): number { | |
963ee397 | 142 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7; |
6bf6769e JB |
143 | } |
144 | ||
324fd4ee JB |
145 | static getLogLevel(): string { |
146 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel.toLowerCase() : 'info'; | |
2e6f5966 JB |
147 | } |
148 | ||
a4a21709 | 149 | static getLogFile(): string { |
963ee397 | 150 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log'; |
7dde0b73 JB |
151 | } |
152 | ||
7ec46a9a | 153 | static getLogErrorFile(): string { |
e4362ed7 | 154 | Configuration.warnDeprecatedConfigurationKey('errorFile', null, 'Use \'logErrorFile\' instead'); |
963ee397 | 155 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log'; |
7dde0b73 JB |
156 | } |
157 | ||
2dcfe98e | 158 | static getSupervisionUrls(): string | string[] { |
1f5df42a JB |
159 | Configuration.warnDeprecatedConfigurationKey('supervisionURLs', null, 'Use \'supervisionUrls\' instead'); |
160 | !Configuration.isUndefined(Configuration.getConfig()['supervisionURLs']) && (Configuration.getConfig().supervisionUrls = Configuration.getConfig()['supervisionURLs'] as string[]); | |
7dde0b73 | 161 | // Read conf |
1f5df42a | 162 | return Configuration.getConfig().supervisionUrls; |
7dde0b73 JB |
163 | } |
164 | ||
2dcfe98e JB |
165 | static getSupervisionUrlDistribution(): SupervisionUrlDistribution { |
166 | Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, 'Use \'supervisionUrlDistribution\' instead'); | |
167 | Configuration.warnDeprecatedConfigurationKey('distributeStationsToTenantsEqually', null, 'Use \'supervisionUrlDistribution\' instead'); | |
168 | return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'supervisionUrlDistribution') ? Configuration.getConfig().supervisionUrlDistribution : SupervisionUrlDistribution.ROUND_ROBIN; | |
7dde0b73 | 169 | } |
eb3937cb | 170 | |
23132a44 JB |
171 | private static logPrefix(): string { |
172 | return new Date().toLocaleString() + ' Simulator configuration |'; | |
173 | } | |
174 | ||
912136b1 JB |
175 | private static warnDeprecatedConfigurationKey(key: string, sectionName?: string, logMsgToAppend = '') { |
176 | // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access | |
177 | if (sectionName && !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && !Configuration.isUndefined(Configuration.getConfig()[sectionName][key])) { | |
e4362ed7 | 178 | console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${logMsgToAppend && '. ' + logMsgToAppend}}`); |
912136b1 | 179 | } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) { |
e4362ed7 | 180 | console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}}`); |
eb3937cb JB |
181 | } |
182 | } | |
183 | ||
184 | // Read the config file | |
185 | private static getConfig(): ConfigurationData { | |
186 | if (!Configuration.configuration) { | |
23132a44 JB |
187 | try { |
188 | Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData; | |
189 | } catch (error) { | |
190 | Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error); | |
191 | } | |
ded13d97 JB |
192 | if (!Configuration.configurationFileWatcher) { |
193 | Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher(); | |
194 | } | |
eb3937cb JB |
195 | } |
196 | return Configuration.configuration; | |
197 | } | |
963ee397 | 198 | |
ded13d97 | 199 | private static getConfigurationFileWatcher(): fs.FSWatcher { |
23132a44 | 200 | try { |
860a9c5a | 201 | return fs.watch(Configuration.configurationFilePath, (event, filename): void => { |
3ec10737 JB |
202 | if (filename && event === 'change') { |
203 | // Nullify to force configuration file reading | |
204 | Configuration.configuration = null; | |
205 | if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) { | |
dcaf96dc JB |
206 | Configuration.configurationChangeCallback().catch((error) => { |
207 | throw typeof error === 'string' ? new Error(error) : error; | |
208 | }); | |
3ec10737 | 209 | } |
23132a44 JB |
210 | } |
211 | }); | |
212 | } catch (error) { | |
860a9c5a | 213 | Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error as Error); |
23132a44 | 214 | } |
ded13d97 JB |
215 | } |
216 | ||
1f5df42a | 217 | private static getDefaultPerformanceStorageUri(storageType: StorageType) { |
d5603918 JB |
218 | const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`; |
219 | switch (storageType) { | |
220 | case StorageType.JSON_FILE: | |
221 | return `file://${path.join(path.resolve(__dirname, '../../'), Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME)}`; | |
222 | case StorageType.SQLITE: | |
223 | return `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`; | |
224 | default: | |
225 | throw new Error(`Performance storage URI is mandatory with storage type '${storageType}'`); | |
226 | } | |
227 | } | |
228 | ||
73d09045 | 229 | private static objectHasOwnProperty(object: unknown, property: string): boolean { |
23132a44 | 230 | return Object.prototype.hasOwnProperty.call(object, property) as boolean; |
963ee397 JB |
231 | } |
232 | ||
73d09045 | 233 | private static isUndefined(obj: unknown): boolean { |
963ee397 JB |
234 | return typeof obj === 'undefined'; |
235 | } | |
23132a44 | 236 | |
717c1e56 JB |
237 | private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException, |
238 | params: HandleErrorParams<EmptyObject> = { throwError: true }): void { | |
23132a44 JB |
239 | const prefix = logPrefix.length !== 0 ? logPrefix + ' ' : ''; |
240 | if (error.code === 'ENOENT') { | |
e4362ed7 | 241 | console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '), error); |
72f041bd | 242 | } else if (error.code === 'EEXIST') { |
e4362ed7 | 243 | console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '), error); |
72f041bd | 244 | } else if (error.code === 'EACCES') { |
e4362ed7 | 245 | console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '), error); |
23132a44 | 246 | } else { |
e4362ed7 | 247 | console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '), error); |
23132a44 | 248 | } |
e0a50bcd JB |
249 | if (params?.throwError) { |
250 | throw error; | |
251 | } | |
23132a44 | 252 | } |
7dde0b73 | 253 | } |