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