src/charging-station/Bootstrap.ts

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