fix: fix 'Cannot read properties of undefined' with revervation enabled
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index bed2692b2b37af3a58277e9e634ce84282b8a506..37fe0e6b5ae7c5506df07f5d17b94af3b37abfcf 100644 (file)
@@ -1,13 +1,14 @@
 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
 import { EventEmitter } from 'node:events';
-import path from 'node:path';
+import { dirname, extname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { isMainThread } from 'node:worker_threads';
 
 import chalk from 'chalk';
+import { availableParallelism } from 'poolifier';
 
-import { ChargingStationUtils } from './ChargingStationUtils';
+import { waitChargingStationEvents } from './ChargingStationUtils';
 import type { AbstractUIServer } from './ui-server/AbstractUIServer';
 import { UIServerFactory } from './ui-server/UIServerFactory';
 import { version } from '../../package.json' assert { type: 'json' };
@@ -19,16 +20,24 @@ import {
   type ChargingStationWorkerMessage,
   type ChargingStationWorkerMessageData,
   ChargingStationWorkerMessageEvents,
+  ConfigurationSection,
   ProcedureName,
   type StationTemplateUrl,
   type Statistics,
+  type StorageConfiguration,
+  type UIServerConfiguration,
+  type WorkerConfiguration,
 } from '../types';
 import {
   Configuration,
   Constants,
-  Utils,
+  formatDurationMilliSeconds,
+  generateUUID,
   handleUncaughtException,
   handleUnhandledRejection,
+  isNotEmptyArray,
+  isNullOrUndefined,
+  logPrefix,
   logger,
 } from '../utils';
 import { type WorkerAbstract, WorkerFactory } from '../worker';
@@ -69,17 +78,24 @@ export class Bootstrap extends EventEmitter {
     this.initializedCounters = false;
     this.initializeCounters();
     this.workerImplementation = null;
-    this.workerScript = path.join(
-      path.dirname(fileURLToPath(import.meta.url)),
-      `ChargingStationWorker${path.extname(fileURLToPath(import.meta.url))}`
+    this.workerScript = join(
+      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,
-        this.logPrefix()
+        performanceStorageConfiguration.type!,
+        performanceStorageConfiguration.uri!,
+        this.logPrefix(),
       ));
     Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart());
   }
@@ -99,12 +115,15 @@ export class Bootstrap extends EventEmitter {
       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++) {
@@ -113,9 +132,9 @@ export class Bootstrap extends EventEmitter {
           } catch (error) {
             console.error(
               chalk.red(
-                `Error at starting charging station with template file ${stationTemplateUrl.file}: `
+                `Error at starting charging station with template file ${stationTemplateUrl.file}: `,
               ),
-              error
+              error,
             );
           }
         }
@@ -125,19 +144,25 @@ 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${
-              !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
+            } worker(s) concurrently running in '${workerConfiguration.processType}' mode${
+              !isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
                 ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
                 : ''
-            }`
-          )
+            }`,
+          ),
         );
+        Configuration.workerDynamicPoolInUse() &&
+          console.warn(
+            chalk.yellow(
+              'Charging stations simulator is using dynamic pool mode. This is an experimental feature with known issues.\nPlease consider using static pool or worker set mode instead',
+            ),
+          );
         console.info(chalk.green('Worker set/pool information:'), this.workerImplementation?.info);
         this.started = true;
         this.starting = false;
@@ -158,21 +183,21 @@ export class Bootstrap extends EventEmitter {
         this.stopping = true;
         await this.uiServer?.sendInternalRequest(
           this.uiServer.buildProtocolRequest(
-            Utils.generateUUID(),
+            generateUUID(),
             ProcedureName.STOP_CHARGING_STATION,
-            Constants.EMPTY_FREEZED_OBJECT
-          )
+            Constants.EMPTY_FREEZED_OBJECT,
+          ),
         );
         await Promise.race([
-          ChargingStationUtils.waitForChargingStationEvents(
+          waitChargingStationEvents(
             this,
             ChargingStationWorkerMessageEvents.stopped,
-            this.numberOfChargingStations
+            this.numberOfChargingStations,
           ),
           new Promise<string>((resolve) => {
             setTimeout(() => {
-              const message = `Timeout reached ${Utils.formatDurationMilliSeconds(
-                Constants.STOP_SIMULATOR_TIMEOUT
+              const message = `Timeout reached ${formatDurationMilliSeconds(
+                Constants.STOP_SIMULATOR_TIMEOUT,
               )} at stopping charging stations simulator`;
               console.warn(chalk.yellow(message));
               resolve(message);
@@ -200,37 +225,46 @@ 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;
+    }
     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,
           },
-        }
+        },
       ));
   }
 
   private messageHandler(
-    msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
+    msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>,
   ): void {
     // logger.debug(
     //   `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify(
     //     msg,
     //     null,
-    //     2
-    //   )}`
+    //     2,
+    //   )}`,
     // );
+    if (isNullOrUndefined(msg?.event)) {
+      return;
+    }
     try {
-      switch (msg.id) {
+      switch (msg.event) {
         case ChargingStationWorkerMessageEvents.started:
           this.workerEventStarted(msg.data as ChargingStationData);
           this.emit(ChargingStationWorkerMessageEvents.started, msg.data as ChargingStationData);
@@ -247,20 +281,20 @@ export class Bootstrap extends EventEmitter {
           this.workerEventPerformanceStatistics(msg.data as Statistics);
           this.emit(
             ChargingStationWorkerMessageEvents.performanceStatistics,
-            msg.data as Statistics
+            msg.data as Statistics,
           );
           break;
         default:
           throw new BaseError(
-            `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}`
+            `Unknown event type: '${msg.event}' for 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
+        error,
       );
     }
   }
@@ -273,7 +307,7 @@ export class Bootstrap extends EventEmitter {
         data.stationInfo.chargingStationId
       } (hashId: ${data.stationInfo.hashId}) started (${
         this.numberOfStartedChargingStations
-      } started from ${this.numberOfChargingStations})`
+      } started from ${this.numberOfChargingStations})`,
     );
   };
 
@@ -285,7 +319,7 @@ export class Bootstrap extends EventEmitter {
         data.stationInfo.chargingStationId
       } (hashId: ${data.stationInfo.hashId}) stopped (${
         this.numberOfStartedChargingStations
-      } started from ${this.numberOfChargingStations})`
+      } started from ${this.numberOfChargingStations})`,
     );
   };
 
@@ -300,21 +334,21 @@ export class Bootstrap extends EventEmitter {
   private initializeCounters() {
     if (this.initializedCounters === false) {
       this.resetCounters();
-      const stationTemplateUrls = Configuration.getStationTemplateUrls();
-      if (Utils.isNotEmptyArray(stationTemplateUrls)) {
+      const stationTemplateUrls = Configuration.getStationTemplateUrls()!;
+      if (isNotEmptyArray(stationTemplateUrls)) {
         this.numberOfChargingStationTemplates = stationTemplateUrls.length;
         for (const stationTemplateUrl of stationTemplateUrls) {
           this.numberOfChargingStations += stationTemplateUrl.numberOfStations ?? 0;
         }
       } else {
         console.warn(
-          chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
+          chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting"),
         );
         process.exit(exitCodes.missingChargingStationsConfiguration);
       }
       if (this.numberOfChargingStations === 0) {
         console.warn(
-          chalk.yellow('No charging station template enabled in configuration, exiting')
+          chalk.yellow('No charging station template enabled in configuration, exiting'),
         );
         process.exit(exitCodes.noChargingStationTemplates);
       }
@@ -330,15 +364,15 @@ export class Bootstrap extends EventEmitter {
 
   private async startChargingStation(
     index: number,
-    stationTemplateUrl: StationTemplateUrl
+    stationTemplateUrl: StationTemplateUrl,
   ): Promise<void> {
     await this.workerImplementation?.addElement({
       index,
-      templateFile: path.join(
-        path.dirname(fileURLToPath(import.meta.url)),
+      templateFile: join(
+        dirname(fileURLToPath(import.meta.url)),
         'assets',
         'station-templates',
-        stationTemplateUrl.file
+        stationTemplateUrl.file,
       ),
     });
   }
@@ -356,6 +390,6 @@ export class Bootstrap extends EventEmitter {
   };
 
   private logPrefix = (): string => {
-    return Utils.logPrefix(' Bootstrap |');
+    return logPrefix(' Bootstrap |');
   };
 }