src/utils/Configuration.ts

   1 import ConfigurationData, { StationTemplateURL } from '../types/ConfigurationData';
   2
   3 import Bootstrap from '../charging-station/Bootstrap';
   4 import { WorkerProcessType } from '../types/Worker';
   5 import fs from 'fs';
   6
   7 export default class Configuration {
   8   private static configurationFilePath = './src/assets/config.json';
   9   private static configurationFileWatcher: fs.FSWatcher;
  10   private static configuration: ConfigurationData;
  11
  12   static getStatisticsDisplayInterval(): number {
  13     // Read conf
  14     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'statisticsDisplayInterval') ? Configuration.getConfig().statisticsDisplayInterval : 60;
  15   }
  16
  17   static getConnectionTimeout(): number {
  18     Configuration.deprecateConfigurationKey('autoReconnectTimeout', 'Use \'connectionTimeout\' in charging station instead');
  19     Configuration.deprecateConfigurationKey('connectionTimeout', 'Use it in charging station template instead');
  20     // Read conf
  21     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'connectionTimeout')) {
  22       return Configuration.getConfig().connectionTimeout;
  23     }
  24   }
  25
  26   static getAutoReconnectMaxRetries(): number {
  27     Configuration.deprecateConfigurationKey('autoReconnectMaxRetries', 'Use it in charging station template instead');
  28     // Read conf
  29     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'autoReconnectMaxRetries')) {
  30       return Configuration.getConfig().autoReconnectMaxRetries;
  31     }
  32   }
  33
  34   static getStationTemplateURLs(): StationTemplateURL[] {
  35     Configuration.getConfig().stationTemplateURLs.forEach((stationURL: StationTemplateURL) => {
  36       if (!Configuration.isUndefined(stationURL['numberOfStation'])) {
  37         console.error(`Deprecated configuration key 'numberOfStation' usage for template file '${stationURL.file}' in 'stationTemplateURLs'. Use 'numberOfStations' instead`);
  38       }
  39     });
  40     // Read conf
  41     return Configuration.getConfig().stationTemplateURLs;
  42   }
  43
  44   static getWorkerProcess(): WorkerProcessType {
  45     Configuration.deprecateConfigurationKey('useWorkerPool;', 'Use \'workerProcess\' to define the type of worker process to use instead');
  46     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess') ? Configuration.getConfig().workerProcess : WorkerProcessType.WORKER_SET;
  47   }
  48
  49   static getWorkerPoolMinSize(): number {
  50     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMinSize') ? Configuration.getConfig().workerPoolMinSize : 4;
  51   }
  52
  53   static getWorkerPoolMaxSize(): number {
  54     Configuration.deprecateConfigurationKey('workerPoolSize;', 'Use \'workerPoolMaxSize\' instead');
  55     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerPoolMaxSize') ? Configuration.getConfig().workerPoolMaxSize : 16;
  56   }
  57
  58   static getChargingStationsPerWorker(): number {
  59     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'chargingStationsPerWorker') ? Configuration.getConfig().chargingStationsPerWorker : 1;
  60   }
  61
  62   static getLogConsole(): boolean {
  63     Configuration.deprecateConfigurationKey('consoleLog', 'Use \'logConsole\' instead');
  64     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logConsole') ? Configuration.getConfig().logConsole : false;
  65   }
  66
  67   static getLogFormat(): string {
  68     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFormat') ? Configuration.getConfig().logFormat : 'simple';
  69   }
  70
  71   static getLogRotate(): boolean {
  72     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logRotate') ? Configuration.getConfig().logRotate : true;
  73   }
  74
  75   static getLogMaxFiles(): number {
  76     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logMaxFiles') ? Configuration.getConfig().logMaxFiles : 7;
  77   }
  78
  79   static getLogLevel(): string {
  80     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logLevel') ? Configuration.getConfig().logLevel : 'info';
  81   }
  82
  83   static getLogFile(): string {
  84     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logFile') ? Configuration.getConfig().logFile : 'combined.log';
  85   }
  86
  87   static getLogErrorFile(): string {
  88     Configuration.deprecateConfigurationKey('errorFile', 'Use \'logErrorFile\' instead');
  89     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'logErrorFile') ? Configuration.getConfig().logErrorFile : 'error.log';
  90   }
  91
  92   static getSupervisionURLs(): string[] {
  93     // Read conf
  94     return Configuration.getConfig().supervisionURLs;
  95   }
  96
  97   static getDistributeStationsToTenantsEqually(): boolean {
  98     Configuration.deprecateConfigurationKey('distributeStationToTenantEqually', 'Use \'distributeStationsToTenantsEqually\' instead');
  99     return Configuration.objectHasOwnProperty(Configuration.getConfig(), 'distributeStationsToTenantsEqually') ? Configuration.getConfig().distributeStationsToTenantsEqually : true;
 100   }
 101
 102   private static deprecateConfigurationKey(key: string, logMsgToAppend = '') {
 103     if (!Configuration.isUndefined(Configuration.getConfig()[key])) {
 104       console.error(`Deprecated configuration key '${key}' usage${logMsgToAppend && '. ' + logMsgToAppend}`);
 105     }
 106   }
 107
 108   // Read the config file
 109   private static getConfig(): ConfigurationData {
 110     if (!Configuration.configuration) {
 111       Configuration.configuration = JSON.parse(fs.readFileSync(Configuration.configurationFilePath, 'utf8')) as ConfigurationData;
 112       if (!Configuration.configurationFileWatcher) {
 113         Configuration.configurationFileWatcher = Configuration.getConfigurationFileWatcher();
 114       }
 115     }
 116     return Configuration.configuration;
 117   }
 118
 119   private static getConfigurationFileWatcher(): fs.FSWatcher {
 120     // eslint-disable-next-line @typescript-eslint/no-misused-promises
 121     return fs.watch(Configuration.configurationFilePath).on('change', async (e): Promise<void> => {
 122       // Nullify to force configuration file reading
 123       Configuration.configuration = null;
 124       await Bootstrap.getInstance().restart();
 125     });
 126   }
 127
 128   private static objectHasOwnProperty(object: any, property: string): boolean {
 129     return Object.prototype.hasOwnProperty.call(object, property) as boolean;
 130   }
 131
 132   private static isUndefined(obj: any): boolean {
 133     return typeof obj === 'undefined';
 134   }
 135 }