src/utils/Configuration.ts

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