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