feat: add performance statistics to UI protocol
[e-mobility-charging-stations-simulator.git] / src / utils / Configuration.ts
1 import { type FSWatcher, readFileSync, watch } from 'node:fs'
2 import { dirname, join } from 'node:path'
3 import { env } from 'node:process'
4 import { fileURLToPath } from 'node:url'
5
6 import chalk from 'chalk'
7 import merge from 'just-merge'
8
9 import {
10 buildPerformanceUriFilePath,
11 checkWorkerElementsPerWorker,
12 checkWorkerProcessType,
13 getDefaultPerformanceStorageUri,
14 handleFileException,
15 logPrefix
16 } from './ConfigurationUtils.js'
17 import { Constants } from './Constants.js'
18 import { hasOwnProp, isCFEnvironment, once } from './Utils.js'
19 import {
20 ApplicationProtocol,
21 type ConfigurationData,
22 ConfigurationSection,
23 FileType,
24 type LogConfiguration,
25 type StationTemplateUrl,
26 type StorageConfiguration,
27 StorageType,
28 SupervisionUrlDistribution,
29 type UIServerConfiguration,
30 type WorkerConfiguration
31 } from '../types/index.js'
32 import {
33 DEFAULT_ELEMENT_START_DELAY,
34 DEFAULT_POOL_MAX_SIZE,
35 DEFAULT_POOL_MIN_SIZE,
36 DEFAULT_WORKER_START_DELAY,
37 WorkerProcessType
38 } from '../worker/index.js'
39
40 type ConfigurationSectionType =
41 | LogConfiguration
42 | StorageConfiguration
43 | WorkerConfiguration
44 | UIServerConfiguration
45
46 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
47 export class Configuration {
48 public static configurationChangeCallback?: () => Promise<void>
49
50 private static readonly configurationFile = join(
51 dirname(fileURLToPath(import.meta.url)),
52 'assets',
53 'config.json'
54 )
55
56 private static configurationFileReloading = false
57 private static configurationData?: ConfigurationData
58 private static configurationFileWatcher?: FSWatcher
59 private static readonly configurationSectionCache = new Map<
60 ConfigurationSection,
61 ConfigurationSectionType
62 >([
63 [ConfigurationSection.log, Configuration.buildLogSection()],
64 [ConfigurationSection.performanceStorage, Configuration.buildPerformanceStorageSection()],
65 [ConfigurationSection.worker, Configuration.buildWorkerSection()],
66 [ConfigurationSection.uiServer, Configuration.buildUIServerSection()]
67 ])
68
69 private constructor () {
70 // This is intentional
71 }
72
73 public static getConfigurationSection<T extends ConfigurationSectionType>(
74 sectionName: ConfigurationSection
75 ): T {
76 if (!Configuration.isConfigurationSectionCached(sectionName)) {
77 Configuration.cacheConfigurationSection(sectionName)
78 }
79 return Configuration.configurationSectionCache.get(sectionName) as T
80 }
81
82 public static getStationTemplateUrls (): StationTemplateUrl[] | undefined {
83 const checkDeprecatedConfigurationKeysOnce = once(
84 Configuration.checkDeprecatedConfigurationKeys.bind(Configuration),
85 Configuration
86 )
87 checkDeprecatedConfigurationKeysOnce()
88 return Configuration.getConfigurationData()?.stationTemplateUrls
89 }
90
91 public static getSupervisionUrls (): string | string[] | undefined {
92 if (
93 Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData] !==
94 undefined
95 ) {
96 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
97 Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![
98 'supervisionURLs' as keyof ConfigurationData
99 ] as string | string[]
100 }
101 return Configuration.getConfigurationData()?.supervisionUrls
102 }
103
104 public static getSupervisionUrlDistribution (): SupervisionUrlDistribution | undefined {
105 return hasOwnProp(Configuration.getConfigurationData(), 'supervisionUrlDistribution')
106 ? Configuration.getConfigurationData()?.supervisionUrlDistribution
107 : SupervisionUrlDistribution.ROUND_ROBIN
108 }
109
110 public static workerPoolInUse (): boolean {
111 return [WorkerProcessType.dynamicPool, WorkerProcessType.fixedPool].includes(
112 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
113 Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
114 .processType!
115 )
116 }
117
118 public static workerDynamicPoolInUse (): boolean {
119 return (
120 Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
121 .processType === WorkerProcessType.dynamicPool
122 )
123 }
124
125 private static isConfigurationSectionCached (sectionName: ConfigurationSection): boolean {
126 return Configuration.configurationSectionCache.has(sectionName)
127 }
128
129 private static cacheConfigurationSection (sectionName: ConfigurationSection): void {
130 switch (sectionName) {
131 case ConfigurationSection.log:
132 Configuration.configurationSectionCache.set(sectionName, Configuration.buildLogSection())
133 break
134 case ConfigurationSection.performanceStorage:
135 Configuration.configurationSectionCache.set(
136 sectionName,
137 Configuration.buildPerformanceStorageSection()
138 )
139 break
140 case ConfigurationSection.worker:
141 Configuration.configurationSectionCache.set(sectionName, Configuration.buildWorkerSection())
142 break
143 case ConfigurationSection.uiServer:
144 Configuration.configurationSectionCache.set(
145 sectionName,
146 Configuration.buildUIServerSection()
147 )
148 break
149 default:
150 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
151 throw new Error(`Unknown configuration section '${sectionName}'`)
152 }
153 }
154
155 private static buildUIServerSection (): UIServerConfiguration {
156 let uiServerConfiguration: UIServerConfiguration = {
157 enabled: false,
158 type: ApplicationProtocol.WS,
159 options: {
160 host: Constants.DEFAULT_UI_SERVER_HOST,
161 port: Constants.DEFAULT_UI_SERVER_PORT
162 }
163 }
164 if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) {
165 uiServerConfiguration = merge<UIServerConfiguration>(
166 uiServerConfiguration,
167 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
168 Configuration.getConfigurationData()!.uiServer!
169 )
170 }
171 if (isCFEnvironment()) {
172 delete uiServerConfiguration.options?.host
173 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
174 uiServerConfiguration.options!.port = parseInt(env.PORT!)
175 }
176 return uiServerConfiguration
177 }
178
179 private static buildPerformanceStorageSection (): StorageConfiguration {
180 let storageConfiguration: StorageConfiguration
181 switch (Configuration.getConfigurationData()?.performanceStorage?.type) {
182 case StorageType.SQLITE:
183 storageConfiguration = {
184 enabled: false,
185 type: StorageType.SQLITE,
186 uri: getDefaultPerformanceStorageUri(StorageType.SQLITE)
187 }
188 break
189 case StorageType.JSON_FILE:
190 storageConfiguration = {
191 enabled: false,
192 type: StorageType.JSON_FILE,
193 uri: getDefaultPerformanceStorageUri(StorageType.JSON_FILE)
194 }
195 break
196 case StorageType.NONE:
197 default:
198 storageConfiguration = {
199 enabled: true,
200 type: StorageType.NONE
201 }
202 break
203 }
204 if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.performanceStorage)) {
205 storageConfiguration = {
206 ...storageConfiguration,
207 ...Configuration.getConfigurationData()?.performanceStorage,
208 ...((Configuration.getConfigurationData()?.performanceStorage?.type ===
209 StorageType.JSON_FILE ||
210 Configuration.getConfigurationData()?.performanceStorage?.type === StorageType.SQLITE) &&
211 Configuration.getConfigurationData()?.performanceStorage?.uri != null && {
212 uri: buildPerformanceUriFilePath(
213 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
214 new URL(Configuration.getConfigurationData()!.performanceStorage!.uri!).pathname
215 )
216 })
217 }
218 }
219 return storageConfiguration
220 }
221
222 private static buildLogSection (): LogConfiguration {
223 const defaultLogConfiguration: LogConfiguration = {
224 enabled: true,
225 file: 'logs/combined.log',
226 errorFile: 'logs/error.log',
227 statisticsInterval: Constants.DEFAULT_LOG_STATISTICS_INTERVAL,
228 level: 'info',
229 format: 'simple',
230 rotate: true
231 }
232 const deprecatedLogConfiguration: LogConfiguration = {
233 ...(hasOwnProp(Configuration.getConfigurationData(), 'logEnabled') && {
234 enabled: Configuration.getConfigurationData()?.logEnabled
235 }),
236 ...(hasOwnProp(Configuration.getConfigurationData(), 'logFile') && {
237 file: Configuration.getConfigurationData()?.logFile
238 }),
239 ...(hasOwnProp(Configuration.getConfigurationData(), 'logErrorFile') && {
240 errorFile: Configuration.getConfigurationData()?.logErrorFile
241 }),
242 ...(hasOwnProp(Configuration.getConfigurationData(), 'logStatisticsInterval') && {
243 statisticsInterval: Configuration.getConfigurationData()?.logStatisticsInterval
244 }),
245 ...(hasOwnProp(Configuration.getConfigurationData(), 'logLevel') && {
246 level: Configuration.getConfigurationData()?.logLevel
247 }),
248 ...(hasOwnProp(Configuration.getConfigurationData(), 'logConsole') && {
249 console: Configuration.getConfigurationData()?.logConsole
250 }),
251 ...(hasOwnProp(Configuration.getConfigurationData(), 'logFormat') && {
252 format: Configuration.getConfigurationData()?.logFormat
253 }),
254 ...(hasOwnProp(Configuration.getConfigurationData(), 'logRotate') && {
255 rotate: Configuration.getConfigurationData()?.logRotate
256 }),
257 ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxFiles') && {
258 maxFiles: Configuration.getConfigurationData()?.logMaxFiles
259 }),
260 ...(hasOwnProp(Configuration.getConfigurationData(), 'logMaxSize') && {
261 maxSize: Configuration.getConfigurationData()?.logMaxSize
262 })
263 }
264 const logConfiguration: LogConfiguration = {
265 ...defaultLogConfiguration,
266 ...deprecatedLogConfiguration,
267 ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.log) &&
268 Configuration.getConfigurationData()?.log)
269 }
270 return logConfiguration
271 }
272
273 private static buildWorkerSection (): WorkerConfiguration {
274 const defaultWorkerConfiguration: WorkerConfiguration = {
275 processType: WorkerProcessType.workerSet,
276 startDelay: DEFAULT_WORKER_START_DELAY,
277 elementsPerWorker: 'auto',
278 elementStartDelay: DEFAULT_ELEMENT_START_DELAY,
279 poolMinSize: DEFAULT_POOL_MIN_SIZE,
280 poolMaxSize: DEFAULT_POOL_MAX_SIZE
281 }
282 const deprecatedWorkerConfiguration: WorkerConfiguration = {
283 ...(hasOwnProp(Configuration.getConfigurationData(), 'workerProcess') && {
284 processType: Configuration.getConfigurationData()?.workerProcess
285 }),
286 ...(hasOwnProp(Configuration.getConfigurationData(), 'workerStartDelay') && {
287 startDelay: Configuration.getConfigurationData()?.workerStartDelay
288 }),
289 ...(hasOwnProp(Configuration.getConfigurationData(), 'chargingStationsPerWorker') && {
290 elementsPerWorker: Configuration.getConfigurationData()?.chargingStationsPerWorker
291 }),
292 ...(hasOwnProp(Configuration.getConfigurationData(), 'elementStartDelay') && {
293 elementStartDelay: Configuration.getConfigurationData()?.elementStartDelay
294 }),
295 ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMinSize') && {
296 poolMinSize: Configuration.getConfigurationData()?.workerPoolMinSize
297 }),
298 ...(hasOwnProp(Configuration.getConfigurationData(), 'workerPoolMaxSize') && {
299 poolMaxSize: Configuration.getConfigurationData()?.workerPoolMaxSize
300 })
301 }
302 hasOwnProp(Configuration.getConfigurationData(), 'workerPoolStrategy') &&
303 delete Configuration.getConfigurationData()?.workerPoolStrategy
304 const workerConfiguration: WorkerConfiguration = {
305 ...defaultWorkerConfiguration,
306 ...deprecatedWorkerConfiguration,
307 ...(hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.worker) &&
308 Configuration.getConfigurationData()?.worker)
309 }
310 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
311 checkWorkerProcessType(workerConfiguration.processType!)
312 checkWorkerElementsPerWorker(workerConfiguration.elementsPerWorker)
313 return workerConfiguration
314 }
315
316 private static checkDeprecatedConfigurationKeys (): void {
317 // connection timeout
318 Configuration.warnDeprecatedConfigurationKey(
319 'autoReconnectTimeout',
320 undefined,
321 "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
322 )
323 Configuration.warnDeprecatedConfigurationKey(
324 'connectionTimeout',
325 undefined,
326 "Use 'ConnectionTimeOut' OCPP parameter in charging station template instead"
327 )
328 // connection retries
329 Configuration.warnDeprecatedConfigurationKey(
330 'autoReconnectMaxRetries',
331 undefined,
332 'Use it in charging station template instead'
333 )
334 // station template url(s)
335 Configuration.warnDeprecatedConfigurationKey(
336 'stationTemplateURLs',
337 undefined,
338 "Use 'stationTemplateUrls' instead"
339 )
340 Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData] !==
341 undefined &&
342 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
343 (Configuration.getConfigurationData()!.stationTemplateUrls =
344 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
345 Configuration.getConfigurationData()![
346 'stationTemplateURLs' as keyof ConfigurationData
347 ] as StationTemplateUrl[])
348 Configuration.getConfigurationData()?.stationTemplateUrls.forEach(
349 (stationTemplateUrl: StationTemplateUrl) => {
350 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
351 if (stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl] !== undefined) {
352 console.error(
353 `${chalk.green(logPrefix())} ${chalk.red(
354 `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`
355 )}`
356 )
357 }
358 }
359 )
360 // supervision url(s)
361 Configuration.warnDeprecatedConfigurationKey(
362 'supervisionURLs',
363 undefined,
364 "Use 'supervisionUrls' instead"
365 )
366 // supervision urls distribution
367 Configuration.warnDeprecatedConfigurationKey(
368 'distributeStationToTenantEqually',
369 undefined,
370 "Use 'supervisionUrlDistribution' instead"
371 )
372 Configuration.warnDeprecatedConfigurationKey(
373 'distributeStationsToTenantsEqually',
374 undefined,
375 "Use 'supervisionUrlDistribution' instead"
376 )
377 // worker section
378 Configuration.warnDeprecatedConfigurationKey(
379 'useWorkerPool',
380 undefined,
381 `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`
382 )
383 Configuration.warnDeprecatedConfigurationKey(
384 'workerProcess',
385 undefined,
386 `Use '${ConfigurationSection.worker}' section to define the type of worker process model instead`
387 )
388 Configuration.warnDeprecatedConfigurationKey(
389 'workerStartDelay',
390 undefined,
391 `Use '${ConfigurationSection.worker}' section to define the worker start delay instead`
392 )
393 Configuration.warnDeprecatedConfigurationKey(
394 'chargingStationsPerWorker',
395 undefined,
396 `Use '${ConfigurationSection.worker}' section to define the number of element(s) per worker instead`
397 )
398 Configuration.warnDeprecatedConfigurationKey(
399 'elementStartDelay',
400 undefined,
401 `Use '${ConfigurationSection.worker}' section to define the worker's element start delay instead`
402 )
403 Configuration.warnDeprecatedConfigurationKey(
404 'workerPoolMinSize',
405 undefined,
406 `Use '${ConfigurationSection.worker}' section to define the worker pool minimum size instead`
407 )
408 Configuration.warnDeprecatedConfigurationKey(
409 'workerPoolSize',
410 undefined,
411 `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`
412 )
413 Configuration.warnDeprecatedConfigurationKey(
414 'workerPoolMaxSize',
415 undefined,
416 `Use '${ConfigurationSection.worker}' section to define the worker pool maximum size instead`
417 )
418 Configuration.warnDeprecatedConfigurationKey(
419 'workerPoolStrategy',
420 undefined,
421 `Use '${ConfigurationSection.worker}' section to define the worker pool strategy instead`
422 )
423 Configuration.warnDeprecatedConfigurationKey(
424 'poolStrategy',
425 ConfigurationSection.worker,
426 'Not publicly exposed to end users'
427 )
428 if (
429 Configuration.getConfigurationData()?.worker?.processType ===
430 ('staticPool' as WorkerProcessType)
431 ) {
432 console.error(
433 `${chalk.green(logPrefix())} ${chalk.red(
434 `Deprecated configuration 'staticPool' value usage in worker section 'processType' field. Use '${WorkerProcessType.fixedPool}' value instead`
435 )}`
436 )
437 }
438 // log section
439 Configuration.warnDeprecatedConfigurationKey(
440 'logEnabled',
441 undefined,
442 `Use '${ConfigurationSection.log}' section to define the logging enablement instead`
443 )
444 Configuration.warnDeprecatedConfigurationKey(
445 'logFile',
446 undefined,
447 `Use '${ConfigurationSection.log}' section to define the log file instead`
448 )
449 Configuration.warnDeprecatedConfigurationKey(
450 'logErrorFile',
451 undefined,
452 `Use '${ConfigurationSection.log}' section to define the log error file instead`
453 )
454 Configuration.warnDeprecatedConfigurationKey(
455 'logConsole',
456 undefined,
457 `Use '${ConfigurationSection.log}' section to define the console logging enablement instead`
458 )
459 Configuration.warnDeprecatedConfigurationKey(
460 'logStatisticsInterval',
461 undefined,
462 `Use '${ConfigurationSection.log}' section to define the log statistics interval instead`
463 )
464 Configuration.warnDeprecatedConfigurationKey(
465 'logLevel',
466 undefined,
467 `Use '${ConfigurationSection.log}' section to define the log level instead`
468 )
469 Configuration.warnDeprecatedConfigurationKey(
470 'logFormat',
471 undefined,
472 `Use '${ConfigurationSection.log}' section to define the log format instead`
473 )
474 Configuration.warnDeprecatedConfigurationKey(
475 'logRotate',
476 undefined,
477 `Use '${ConfigurationSection.log}' section to define the log rotation enablement instead`
478 )
479 Configuration.warnDeprecatedConfigurationKey(
480 'logMaxFiles',
481 undefined,
482 `Use '${ConfigurationSection.log}' section to define the log maximum files instead`
483 )
484 Configuration.warnDeprecatedConfigurationKey(
485 'logMaxSize',
486 undefined,
487 `Use '${ConfigurationSection.log}' section to define the log maximum size instead`
488 )
489 // performanceStorage section
490 Configuration.warnDeprecatedConfigurationKey(
491 'URI',
492 ConfigurationSection.performanceStorage,
493 "Use 'uri' instead"
494 )
495 // uiServer section
496 if (hasOwnProp(Configuration.getConfigurationData(), 'uiWebSocketServer')) {
497 console.error(
498 `${chalk.green(logPrefix())} ${chalk.red(
499 `Deprecated configuration section 'uiWebSocketServer' usage. Use '${ConfigurationSection.uiServer}' instead`
500 )}`
501 )
502 }
503 }
504
505 private static warnDeprecatedConfigurationKey (
506 key: string,
507 sectionName?: string,
508 logMsgToAppend = ''
509 ): void {
510 if (
511 sectionName != null &&
512 Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] !==
513 undefined &&
514 (
515 Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] as Record<
516 string,
517 unknown
518 >
519 )[key] !== undefined
520 ) {
521 console.error(
522 `${chalk.green(logPrefix())} ${chalk.red(
523 `Deprecated configuration key '${key}' usage in section '${sectionName}'${
524 logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
525 }`
526 )}`
527 )
528 } else if (
529 Configuration.getConfigurationData()?.[key as keyof ConfigurationData] !== undefined
530 ) {
531 console.error(
532 `${chalk.green(logPrefix())} ${chalk.red(
533 `Deprecated configuration key '${key}' usage${
534 logMsgToAppend.trim().length > 0 ? `. ${logMsgToAppend}` : ''
535 }`
536 )}`
537 )
538 }
539 }
540
541 private static getConfigurationData (): ConfigurationData | undefined {
542 if (Configuration.configurationData == null) {
543 try {
544 Configuration.configurationData = JSON.parse(
545 readFileSync(Configuration.configurationFile, 'utf8')
546 ) as ConfigurationData
547 if (Configuration.configurationFileWatcher == null) {
548 Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher()
549 }
550 } catch (error) {
551 handleFileException(
552 Configuration.configurationFile,
553 FileType.Configuration,
554 error as NodeJS.ErrnoException,
555 logPrefix()
556 )
557 }
558 }
559 return Configuration.configurationData
560 }
561
562 private static getConfigurationFileWatcher (): FSWatcher | undefined {
563 try {
564 return watch(Configuration.configurationFile, (event, filename): void => {
565 if (
566 !Configuration.configurationFileReloading &&
567 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
568 filename!.trim().length > 0 &&
569 event === 'change'
570 ) {
571 Configuration.configurationFileReloading = true
572 const consoleWarnOnce = once(console.warn, this)
573 consoleWarnOnce(
574 `${chalk.green(logPrefix())} ${chalk.yellow(
575 `${FileType.Configuration} ${this.configurationFile} file have changed, reload`
576 )}`
577 )
578 delete Configuration.configurationData
579 Configuration.configurationSectionCache.clear()
580 if (Configuration.configurationChangeCallback !== undefined) {
581 Configuration.configurationChangeCallback()
582 .catch(error => {
583 throw typeof error === 'string' ? new Error(error) : error
584 })
585 .finally(() => {
586 Configuration.configurationFileReloading = false
587 })
588 } else {
589 Configuration.configurationFileReloading = false
590 }
591 }
592 })
593 } catch (error) {
594 handleFileException(
595 Configuration.configurationFile,
596 FileType.Configuration,
597 error as NodeJS.ErrnoException,
598 logPrefix()
599 )
600 }
601 }
602 }