src/charging-station/Bootstrap.ts

   1 // Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
   2
   3 import path from 'path';
   4 import { fileURLToPath } from 'url';
   5 import { type Worker, isMainThread } from 'worker_threads';
   6
   7 import chalk from 'chalk';
   8
   9 import { version } from '../../package.json';
  10 import BaseError from '../exception/BaseError';
  11 import type { Storage } from '../performance/storage/Storage';
  12 import { StorageFactory } from '../performance/storage/StorageFactory';
  13 import {
  14   ChargingStationData,
  15   ChargingStationWorkerData,
  16   ChargingStationWorkerMessage,
  17   ChargingStationWorkerMessageData,
  18   ChargingStationWorkerMessageEvents,
  19 } from '../types/ChargingStationWorker';
  20 import type { StationTemplateUrl } from '../types/ConfigurationData';
  21 import type { Statistics } from '../types/Statistics';
  22 import Configuration from '../utils/Configuration';
  23 import logger from '../utils/Logger';
  24 import Utils from '../utils/Utils';
  25 import type WorkerAbstract from '../worker/WorkerAbstract';
  26 import WorkerFactory from '../worker/WorkerFactory';
  27 import { ChargingStationUtils } from './ChargingStationUtils';
  28 import type { AbstractUIServer } from './ui-server/AbstractUIServer';
  29 import UIServerFactory from './ui-server/UIServerFactory';
  30
  31 const moduleName = 'Bootstrap';
  32
  33 const missingChargingStationsConfigurationExitCode = 1;
  34 const noChargingStationTemplatesExitCode = 2;
  35
  36 export class Bootstrap {
  37   private static instance: Bootstrap | null = null;
  38   private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null;
  39   private readonly uiServer!: AbstractUIServer;
  40   private readonly storage!: Storage;
  41   private numberOfChargingStationTemplates!: number;
  42   private numberOfChargingStations!: number;
  43   private numberOfStartedChargingStations!: number;
  44   private readonly version: string = version;
  45   private started: boolean;
  46   private readonly workerScript: string;
  47
  48   private constructor() {
  49     this.started = false;
  50     this.workerImplementation = null;
  51     this.workerScript = path.join(
  52       path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
  53       'charging-station',
  54       'ChargingStationWorker' + path.extname(fileURLToPath(import.meta.url))
  55     );
  56     this.initialize();
  57     Configuration.getUIServer().enabled === true &&
  58       (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer()));
  59     Configuration.getPerformanceStorage().enabled === true &&
  60       (this.storage = StorageFactory.getStorage(
  61         Configuration.getPerformanceStorage().type,
  62         Configuration.getPerformanceStorage().uri,
  63         this.logPrefix()
  64       ));
  65     Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart());
  66   }
  67
  68   public static getInstance(): Bootstrap {
  69     if (Bootstrap.instance === null) {
  70       Bootstrap.instance = new Bootstrap();
  71     }
  72     return Bootstrap.instance;
  73   }
  74
  75   public async start(): Promise<void> {
  76     if (isMainThread && this.started === false) {
  77       try {
  78         // Enable unconditionally for now
  79         this.logUnhandledRejection();
  80         this.logUncaughtException();
  81         this.initialize();
  82         await this.storage?.open();
  83         await this.workerImplementation.start();
  84         this.uiServer?.start();
  85         const stationTemplateUrls = Configuration.getStationTemplateUrls();
  86         this.numberOfChargingStationTemplates = stationTemplateUrls.length;
  87         // Start ChargingStation object in worker thread
  88         if (!Utils.isEmptyArray(stationTemplateUrls)) {
  89           for (const stationTemplateUrl of stationTemplateUrls) {
  90             try {
  91               const nbStations = stationTemplateUrl.numberOfStations ?? 0;
  92               for (let index = 1; index <= nbStations; index++) {
  93                 await this.startChargingStation(index, stationTemplateUrl);
  94               }
  95             } catch (error) {
  96               console.error(
  97                 chalk.red(
  98                   'Error at starting charging station with template file ' +
  99                     stationTemplateUrl.file +
 100                     ': '
 101                 ),
 102                 error
 103               );
 104             }
 105           }
 106         } else {
 107           console.warn(
 108             chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
 109           );
 110           process.exit(missingChargingStationsConfigurationExitCode);
 111         }
 112         if (this.numberOfChargingStations === 0) {
 113           console.warn(
 114             chalk.yellow('No charging station template enabled in configuration, exiting')
 115           );
 116           process.exit(noChargingStationTemplatesExitCode);
 117         } else {
 118           console.info(
 119             chalk.green(
 120               `Charging stations simulator ${
 121                 this.version
 122               } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${
 123                 ChargingStationUtils.workerDynamicPoolInUse()
 124                   ? `${Configuration.getWorker().poolMinSize.toString()}/`
 125                   : ''
 126               }${this.workerImplementation.size}${
 127                 ChargingStationUtils.workerPoolInUse()
 128                   ? `/${Configuration.getWorker().poolMaxSize.toString()}`
 129                   : ''
 130               } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
 131                 this.workerImplementation.maxElementsPerWorker
 132                   ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)`
 133                   : ''
 134               }`
 135             )
 136           );
 137         }
 138         this.started = true;
 139       } catch (error) {
 140         console.error(chalk.red('Bootstrap start error: '), error);
 141       }
 142     } else {
 143       console.error(chalk.red('Cannot start an already started charging stations simulator'));
 144     }
 145   }
 146
 147   public async stop(): Promise<void> {
 148     if (isMainThread && this.started === true) {
 149       await this.workerImplementation.stop();
 150       this.workerImplementation = null;
 151       this.uiServer?.stop();
 152       await this.storage?.close();
 153       this.started = false;
 154     } else {
 155       console.error(chalk.red('Cannot stop a not started charging stations simulator'));
 156     }
 157   }
 158
 159   public async restart(): Promise<void> {
 160     await this.stop();
 161     this.initialize();
 162     await this.start();
 163   }
 164
 165   private initializeWorkerImplementation(): void {
 166     this.workerImplementation === null &&
 167       (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
 168         this.workerScript,
 169         Configuration.getWorker().processType,
 170         {
 171           workerStartDelay: Configuration.getWorker().startDelay,
 172           elementStartDelay: Configuration.getWorker().elementStartDelay,
 173           poolMaxSize: Configuration.getWorker().poolMaxSize,
 174           poolMinSize: Configuration.getWorker().poolMinSize,
 175           elementsPerWorker: Configuration.getWorker().elementsPerWorker,
 176           poolOptions: {
 177             workerChoiceStrategy: Configuration.getWorker().poolStrategy,
 178           },
 179           messageHandler: this.messageHandler.bind(this) as (
 180             this: Worker,
 181             msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
 182           ) => void,
 183         }
 184       ));
 185   }
 186
 187   private messageHandler(
 188     msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
 189   ): void {
 190     // logger.debug(
 191     //   `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify(
 192     //     msg,
 193     //     null,
 194     //     2
 195     //   )}`
 196     // );
 197     try {
 198       switch (msg.id) {
 199         case ChargingStationWorkerMessageEvents.STARTED:
 200           this.workerEventStarted(msg.data as ChargingStationData);
 201           break;
 202         case ChargingStationWorkerMessageEvents.STOPPED:
 203           this.workerEventStopped(msg.data as ChargingStationData);
 204           break;
 205         case ChargingStationWorkerMessageEvents.UPDATED:
 206           this.workerEventUpdated(msg.data as ChargingStationData);
 207           break;
 208         case ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS:
 209           this.workerEventPerformanceStatistics(msg.data as Statistics);
 210           break;
 211         default:
 212           throw new BaseError(
 213             `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}`
 214           );
 215       }
 216     } catch (error) {
 217       logger.error(
 218         `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${
 219           msg.id
 220         }' event:`,
 221         error
 222       );
 223     }
 224   }
 225
 226   private workerEventStarted = (data: ChargingStationData) => {
 227     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
 228     ++this.numberOfStartedChargingStations;
 229   };
 230
 231   private workerEventStopped = (data: ChargingStationData) => {
 232     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
 233     --this.numberOfStartedChargingStations;
 234   };
 235
 236   private workerEventUpdated = (data: ChargingStationData) => {
 237     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
 238   };
 239
 240   private workerEventPerformanceStatistics = (data: Statistics) => {
 241     this.storage.storePerformanceStatistics(data) as void;
 242   };
 243
 244   private initialize() {
 245     this.numberOfChargingStationTemplates = 0;
 246     this.numberOfChargingStations = 0;
 247     this.numberOfStartedChargingStations = 0;
 248     this.initializeWorkerImplementation();
 249   }
 250
 251   private logUncaughtException(): void {
 252     process.on('uncaughtException', (error: Error) => {
 253       console.error(chalk.red('Uncaught exception: '), error);
 254     });
 255   }
 256
 257   private logUnhandledRejection(): void {
 258     process.on('unhandledRejection', (reason: unknown) => {
 259       console.error(chalk.red('Unhandled rejection: '), reason);
 260     });
 261   }
 262
 263   private async startChargingStation(
 264     index: number,
 265     stationTemplateUrl: StationTemplateUrl
 266   ): Promise<void> {
 267     const workerData: ChargingStationWorkerData = {
 268       index,
 269       templateFile: path.join(
 270         path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
 271         'assets',
 272         'station-templates',
 273         stationTemplateUrl.file
 274       ),
 275     };
 276     await this.workerImplementation.addElement(workerData);
 277     ++this.numberOfChargingStations;
 278   }
 279
 280   private logPrefix(): string {
 281     return Utils.logPrefix(' Bootstrap |');
 282   }
 283 }