refactor: switch to public static instead of setter in configuration
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index 9741fc25bdcc5d6daec04bc13a977464c6079ada..66b2d5f835146782bdb9a703b5002c9ab540146c 100644 (file)
@@ -6,8 +6,9 @@ import { fileURLToPath } from 'node:url';
 import { isMainThread } from 'node:worker_threads';
 
 import chalk from 'chalk';
+import { availableParallelism } from 'poolifier';
 
-import { waitChargingStationEvents } from './ChargingStationUtils';
+import { waitChargingStationEvents } from './Helpers';
 import type { AbstractUIServer } from './ui-server/AbstractUIServer';
 import { UIServerFactory } from './ui-server/UIServerFactory';
 import { version } from '../../package.json' assert { type: 'json' };
@@ -19,9 +20,13 @@ import {
   type ChargingStationWorkerMessage,
   type ChargingStationWorkerMessageData,
   ChargingStationWorkerMessageEvents,
+  ConfigurationSection,
   ProcedureName,
   type StationTemplateUrl,
   type Statistics,
+  type StorageConfiguration,
+  type UIServerConfiguration,
+  type WorkerConfiguration,
 } from '../types';
 import {
   Configuration,
@@ -40,8 +45,10 @@ import { type WorkerAbstract, WorkerFactory } from '../worker';
 const moduleName = 'Bootstrap';
 
 enum exitCodes {
+  succeeded = 0,
   missingChargingStationsConfiguration = 1,
   noChargingStationTemplates = 2,
+  gracefulShutdownError = 3,
 }
 
 export class Bootstrap extends EventEmitter {
@@ -77,15 +84,22 @@ export class Bootstrap extends EventEmitter {
       dirname(fileURLToPath(import.meta.url)),
       `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`,
     );
-    Configuration.getUIServer().enabled === true &&
-      (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer()));
-    Configuration.getPerformanceStorage().enabled === true &&
+    const uiServerConfiguration = Configuration.getConfigurationSection<UIServerConfiguration>(
+      ConfigurationSection.uiServer,
+    );
+    uiServerConfiguration.enabled === true &&
+      (this.uiServer = UIServerFactory.getUIServerImplementation(uiServerConfiguration));
+    const performanceStorageConfiguration =
+      Configuration.getConfigurationSection<StorageConfiguration>(
+        ConfigurationSection.performanceStorage,
+      );
+    performanceStorageConfiguration.enabled === true &&
       (this.storage = StorageFactory.getStorage(
-        Configuration.getPerformanceStorage().type,
-        Configuration.getPerformanceStorage().uri,
+        performanceStorageConfiguration.type!,
+        performanceStorageConfiguration.uri!,
         this.logPrefix(),
       ));
-    Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart());
+    Configuration.configurationChangeCallback = async () => Bootstrap.getInstance().restart();
   }
 
   public static getInstance(): Bootstrap {
@@ -97,18 +111,21 @@ export class Bootstrap extends EventEmitter {
 
   public async start(): Promise<void> {
     if (!isMainThread) {
-      throw new Error('Cannot start charging stations simulator from worker thread');
+      throw new BaseError('Cannot start charging stations simulator from worker thread');
     }
     if (this.started === false) {
       if (this.starting === false) {
         this.starting = true;
         this.initializeCounters();
-        this.initializeWorkerImplementation();
+        const workerConfiguration = Configuration.getConfigurationSection<WorkerConfiguration>(
+          ConfigurationSection.worker,
+        );
+        this.initializeWorkerImplementation(workerConfiguration);
         await this.workerImplementation?.start();
         await this.storage?.open();
         this.uiServer?.start();
         // Start ChargingStation object instance in worker thread
-        for (const stationTemplateUrl of Configuration.getStationTemplateUrls()) {
+        for (const stationTemplateUrl of Configuration.getStationTemplateUrls()!) {
           try {
             const nbStations = stationTemplateUrl.numberOfStations ?? 0;
             for (let index = 1; index <= nbStations; index++) {
@@ -129,13 +146,13 @@ export class Bootstrap extends EventEmitter {
               this.version
             } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${
               Configuration.workerDynamicPoolInUse()
-                ? `${Configuration.getWorker().poolMinSize?.toString()}/`
+                ? `${workerConfiguration.poolMinSize?.toString()}/`
                 : ''
             }${this.workerImplementation?.size}${
               Configuration.workerPoolInUse()
-                ? `/${Configuration.getWorker().poolMaxSize?.toString()}`
+                ? `/${workerConfiguration.poolMaxSize?.toString()}`
                 : ''
-            } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
+            } worker(s) concurrently running in '${workerConfiguration.processType}' mode${
               !isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
                 ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
                 : ''
@@ -161,7 +178,7 @@ export class Bootstrap extends EventEmitter {
 
   public async stop(): Promise<void> {
     if (!isMainThread) {
-      throw new Error('Cannot stop charging stations simulator from worker thread');
+      throw new BaseError('Cannot stop charging stations simulator from worker thread');
     }
     if (this.started === true) {
       if (this.stopping === false) {
@@ -170,7 +187,7 @@ export class Bootstrap extends EventEmitter {
           this.uiServer.buildProtocolRequest(
             generateUUID(),
             ProcedureName.STOP_CHARGING_STATION,
-            Constants.EMPTY_FREEZED_OBJECT,
+            Constants.EMPTY_FROZEN_OBJECT,
           ),
         );
         await Promise.race([
@@ -210,19 +227,25 @@ export class Bootstrap extends EventEmitter {
     await this.start();
   }
 
-  private initializeWorkerImplementation(): void {
+  private initializeWorkerImplementation(workerConfiguration: WorkerConfiguration): void {
+    let elementsPerWorker: number | undefined;
+    if (workerConfiguration?.elementsPerWorker === 'auto') {
+      elementsPerWorker =
+        this.numberOfChargingStations > availableParallelism()
+          ? Math.round(this.numberOfChargingStations / (availableParallelism() * 1.5))
+          : 1;
+    }
     this.workerImplementation === null &&
       (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
         this.workerScript,
-        Configuration.getWorker().processType,
+        workerConfiguration.processType!,
         {
-          workerStartDelay: Configuration.getWorker().startDelay,
-          elementStartDelay: Configuration.getWorker().elementStartDelay,
-          poolMaxSize: Configuration.getWorker().poolMaxSize,
-          poolMinSize: Configuration.getWorker().poolMinSize,
-          elementsPerWorker: Configuration.getWorker().elementsPerWorker,
+          workerStartDelay: workerConfiguration.startDelay,
+          elementStartDelay: workerConfiguration.elementStartDelay,
+          poolMaxSize: workerConfiguration.poolMaxSize!,
+          poolMinSize: workerConfiguration.poolMinSize!,
+          elementsPerWorker: elementsPerWorker ?? (workerConfiguration.elementsPerWorker as number),
           poolOptions: {
-            workerChoiceStrategy: Configuration.getWorker().poolStrategy,
             messageHandler: this.messageHandler.bind(this) as (message: unknown) => void,
           },
         },
@@ -236,11 +259,11 @@ export class Bootstrap extends EventEmitter {
     //   `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify(
     //     msg,
     //     null,
-    //     2
-    //   )}`
+    //     2,
+    //   )}`,
     // );
     try {
-      switch (msg.id) {
+      switch (msg.event) {
         case ChargingStationWorkerMessageEvents.started:
           this.workerEventStarted(msg.data as ChargingStationData);
           this.emit(ChargingStationWorkerMessageEvents.started, msg.data as ChargingStationData);
@@ -260,15 +283,26 @@ export class Bootstrap extends EventEmitter {
             msg.data as Statistics,
           );
           break;
+        case ChargingStationWorkerMessageEvents.startWorkerElementError:
+          logger.error(
+            `${this.logPrefix()} ${moduleName}.messageHandler: Error occured while starting worker element:`,
+            msg.data,
+          );
+          this.emit(ChargingStationWorkerMessageEvents.startWorkerElementError, msg.data);
+          break;
+        case ChargingStationWorkerMessageEvents.startedWorkerElement:
+          break;
         default:
           throw new BaseError(
-            `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}`,
+            `Unknown charging station worker event: '${
+              msg.event
+            }' received with data: ${JSON.stringify(msg.data, null, 2)}`,
           );
       }
     } catch (error) {
       logger.error(
         `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${
-          msg.id
+          msg.event
         }' event:`,
         error,
       );
@@ -310,7 +344,7 @@ export class Bootstrap extends EventEmitter {
   private initializeCounters() {
     if (this.initializedCounters === false) {
       this.resetCounters();
-      const stationTemplateUrls = Configuration.getStationTemplateUrls();
+      const stationTemplateUrls = Configuration.getStationTemplateUrls()!;
       if (isNotEmptyArray(stationTemplateUrls)) {
         this.numberOfChargingStationTemplates = stationTemplateUrls.length;
         for (const stationTemplateUrl of stationTemplateUrls) {
@@ -357,11 +391,11 @@ export class Bootstrap extends EventEmitter {
     console.info(`${chalk.green('Graceful shutdown')}`);
     this.stop()
       .then(() => {
-        process.exit(0);
+        process.exit(exitCodes.succeeded);
       })
       .catch((error) => {
         console.error(chalk.red('Error while shutdowning charging stations simulator: '), error);
-        process.exit(1);
+        process.exit(exitCodes.gracefulShutdownError);
       });
   };