src/utils/Configuration.ts

   1 import ConfigurationData, { StationTemplateURL, StorageConfiguration } from '../types/ConfigurationData';
   2
   3 import Constants from './Constants';
   4 import { StorageType } from '../types/Storage';
   5 import type { WorkerChoiceStrategy } from 'poolifier';
   6 import { WorkerProcessType } from '../types/Worker';
   7 import chalk from 'chalk';
   8 import fs from 'fs';
   9 import path from 'path';
  10
  11 export default class Configuration {
  12   private static configurationFilePath = path.join(path.resolve(__dirname, '../'), 'assets', 'config.json');
  13   private static configurationFileWatcher: fs.FSWatcher;
  14   private static configuration: ConfigurationData | null = null;
  15   private static configurationChangeCallback: () => Promise<void>;
  16
  17   static setConfigurationChangeCallback(cb: () => Promise<void>): void {
  18     Configuration.configurationChangeCallback = cb;
  19   }
  20
  21   static getLogStatisticsInterval(): number {
  22     Configuration.warnDeprecatedConfigurationKey('statisticsDisplayInterval', null, 'Use \'logStatisticsInterval\' instead');
  23     // Read conf
  24     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logStatisticsInterval') ? Configuration.getConfig().logStatisticsInterval : 60;
  25   }
  26
  27   static getPerformanceStorage(): StorageConfiguration {
  28     const defaultJSONFilePathURI = `file://${path.join(path.resolve(__dirname, '../../'), Constants.DEFAULT_PERFORMANCE_RECORDS_FILENAME)}`;
  29     const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`;
  30     const defaultSQLiteFilePathURI = `file://${path.join(path.resolve(__dirname, '../../'), SQLiteFileName)}`;
  31     let storageConfiguration: StorageConfiguration;
  32     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
  33       storageConfiguration =
  34       {
  35         ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'enabled') ? { enabled: Configuration.getConfig().performanceStorage.enabled } : { enabled: false },
  36         ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'type') ? { type: Configuration.getConfig().performanceStorage.type } : { type: StorageType.JSON_FILE },
  37         ...Configuration.objectHasOwnProperty(Configuration.getConfig().performanceStorage, 'URI')
  38           ? { URI: Configuration.getConfig().performanceStorage.URI }
  39           : { URI: (Configuration.getConfig().performanceStorage.type === StorageType.JSON_FILE) ? defaultJSONFilePathURI : defaultSQLiteFilePathURI }
  40       };
  41     } else {
  42       storageConfiguration =
  43       {
  44         enabled: false,
  45         type: StorageType.JSON_FILE,
  46         URI: defaultJSONFilePathURI
  47       };
  48     }
  49     return storageConfiguration;
  50   }
  51
  52   static getAutoReconnectMaxRetries(): number {
  53     Configuration.warnDeprecatedConfigurationKey('autoReconnectTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
  54     Configuration.warnDeprecatedConfigurationKey('connectionTimeout', null, 'Use \'ConnectionTimeOut\' OCPP parameter in charging station template instead');
  55     Configuration.warnDeprecatedConfigurationKey('autoReconnectMaxRetries', null, 'Use it in charging station template instead');
  56     // Read conf
  57     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
  58       return Configuration.getConfig().autoReconnectMaxRetries;
  59     }
  60   }
  61
  62   static getStationTemplateURLs(): StationTemplateURL[] {
  63     Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => {
  64       if (!Configuration.isUndefined(stationURL['numberOfStation'])) {
  65         console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead}`);
  66       }
  67     });
  68     // Read conf
  69     return Configuration.getConfig().stationTemplateURLs;
  70   }
  71
  72   static getWorkerProcess(): WorkerProcessType {
  73     Configuration.warnDeprecatedConfigurationKey('useWorkerPool;', null, 'Use \'workerProcess\' to define the type of worker process to use instead');
  74     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig().workerProcess : WorkerProcessType.WORKER_SET;
  75   }
  76
  77   static getWorkerStartDelay(): number {
  78     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerStartDelay') ? Configuration.getConfig().workerStartDelay : Constants.WORKER_START_DELAY;
  79   }
  80
  81   static getWorkerPoolMinSize(): number {
  82     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : Constants.DEFAULT_WORKER_POOL_MIN_SIZE;
  83   }
  84
  85   static getWorkerPoolMaxSize(): number {
  86     Configuration.warnDeprecatedConfigurationKey('workerPoolSize;', null, 'Use \'workerPoolMaxSize\' instead');
  87     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
  88   }
  89
  90   static getWorkerPoolStrategy(): WorkerChoiceStrategy {
  91     return Configuration.getConfig().workerPoolStrategy;
  92   }
  93
  94   static getChargingStationsPerWorker(): number {
  95     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER;
  96   }
  97
  98   static getLogConsole(): boolean {
  99     Configuration.warnDeprecatedConfigurationKey('consoleLog', null, 'Use \'logConsole\' instead');
 100     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
 101   }
 102
 103   static getLogFormat(): string {
 104     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple';
 105   }
 106
 107   static getLogRotate(): boolean {
 108     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true;
 109   }
 110
 111   static getLogMaxFiles(): number {
 112     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7;
 113   }
 114
 115   static getLogLevel(): string {
 116     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info';
 117   }
 118
 119   static getLogFile(): string {
 120     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log';
 121   }
 122
 123   static getLogErrorFile(): string {
 124     Configuration.warnDeprecatedConfigurationKey('errorFile', null, 'Use \'logErrorFile\' instead');
 125     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
 126   }
 127
 128   static getSupervisionURLs(): string[] {
 129     // Read conf
 130     return Configuration.getConfig().supervisionURLs;
 131   }
 132
 133   static getDistributeStationsToTenantsEqually(): boolean {
 134     Configuration.warnDeprecatedConfigurationKey('distributeStationToTenantEqually', null, 'Use \'distributeStationsToTenantsEqually\' instead');
 135     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true;
 136   }
 137
 138   private static logPrefix(): string {
 139     return new Date().toLocaleString() + ' Simulator configuration |';
 140   }
 141
 142   private static warnDeprecatedConfigurationKey(key: string, sectionName?: string, logMsgToAppend = '') {
 143     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 144     if (sectionName && !Configuration.isUndefined(Configuration.getConfig()[sectionName]) && !Configuration.isUndefined(Configuration.getConfig()[sectionName][key])) {
 145       console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage in section '${sectionName}'${logMsgToAppend && '. ' + logMsgToAppend}}`);
 146     } else if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
 147       console.error(chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}}`);
 148     }
 149   }
 150
 151   // Read the config file
 152   private static getConfig(): ConfigurationData {
 153     if (!Configuration.configuration) {
 154       try {
 155         Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData;
 156       } catch (error) {
 157         Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error);
 158       }
 159       if (!Configuration.configurationFileWatcher) {
 160         Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
 161       }
 162     }
 163     return Configuration.configuration;
 164   }
 165
 166   private static getConfigurationFileWatcher(): fs.FSWatcher {
 167     try {
 168       // eslint-disable-next-line @typescript-eslint/no-misused-promises
 169       return fs.watch(Configuration.configurationFilePath).on('change', async (): Promise<void> => {
 170         // Nullify to force configuration file reading
 171         Configuration.configuration = null;
 172         if (!Configuration.isUndefined(Configuration.configurationChangeCallback)) {
 173           await Configuration.configurationChangeCallback();
 174         }
 175       });
 176     } catch (error) {
 177       Configuration.handleFileException(Configuration.logPrefix(), 'Configuration', Configuration.configurationFilePath, error);
 178     }
 179   }
 180
 181   private static objectHasOwnProperty(object: any, property: string): boolean {
 182     return Object.prototype.hasOwnProperty.call(object, property) as boolean;
 183   }
 184
 185   private static isUndefined(obj: any): boolean {
 186     return typeof obj === 'undefined';
 187   }
 188
 189   private static handleFileException(logPrefix: string, fileType: string, filePath: string, error: NodeJS.ErrnoException): void {
 190     const prefix = logPrefix.length !== 0 ? logPrefix + ' ' : '';
 191     if (error.code === 'ENOENT') {
 192       console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' not found: '), error);
 193     } else if (error.code === 'EEXIST') {
 194       console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' already exists: '), error);
 195     } else if (error.code === 'EACCES') {
 196       console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' access denied: '), error);
 197     } else {
 198       console.error(chalk.green(prefix) + chalk.red(fileType + ' file ' + filePath + ' error: '), error);
 199     }
 200     throw error;
 201   }
 202 }