fix: fix elementsPerWorker automatic calculation

[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts

diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts
index 8a3f9078d92ccafcdaf8013e71c5502b17d4c1a0..1550f6a7dc8ee92547fda280dbe4f569592f753e 100644 (file)
--- a/src/charging-station/Bootstrap.ts
+++ b/src/charging-station/Bootstrap.ts
@@ -6,8 +6,9 @@ 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' };
@@ -26,12 +27,16 @@ import {
 import {
   Configuration,
   Constants,
-  Utils,
+  formatDurationMilliSeconds,
+  generateUUID,
   handleUncaughtException,
   handleUnhandledRejection,
+  isNotEmptyArray,
+  isNullOrUndefined,
+  logPrefix,
   logger,
 } from '../utils';
-import { type WorkerAbstract, WorkerFactory } from '../worker';
+import { type WorkerAbstract, WorkerConstants, WorkerFactory } from '../worker';
 
 const moduleName = 'Bootstrap';
 
@@ -71,7 +76,7 @@ export class Bootstrap extends EventEmitter {
     this.workerImplementation = null;
     this.workerScript = join(
       dirname(fileURLToPath(import.meta.url)),
-      `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`
+      `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`,
     );
     Configuration.getUIServer().enabled === true &&
       (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer()));
@@ -79,7 +84,7 @@ export class Bootstrap extends EventEmitter {
       (this.storage = StorageFactory.getStorage(
         Configuration.getPerformanceStorage().type,
         Configuration.getPerformanceStorage().uri,
-        this.logPrefix()
+        this.logPrefix(),
       ));
     Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart());
   }
@@ -113,9 +118,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,
             );
           }
         }
@@ -132,12 +137,18 @@ export class Bootstrap extends EventEmitter {
                 ? `/${Configuration.getWorker().poolMaxSize?.toString()}`
                 : ''
             } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
-              !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
+              !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 +169,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);
@@ -201,6 +212,13 @@ export class Bootstrap extends EventEmitter {
   }
 
   private initializeWorkerImplementation(): void {
+    let elementsPerWorker: number;
+    if (Configuration.getWorker()?.elementsPerWorker === 'auto') {
+      elementsPerWorker =
+        this.numberOfChargingStations > availableParallelism()
+          ? Math.round(this.numberOfChargingStations / availableParallelism())
+          : 1;
+    }
     this.workerImplementation === null &&
       (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
         this.workerScript,
@@ -210,17 +228,18 @@ export class Bootstrap extends EventEmitter {
           elementStartDelay: Configuration.getWorker().elementStartDelay,
           poolMaxSize: Configuration.getWorker().poolMaxSize,
           poolMinSize: Configuration.getWorker().poolMinSize,
-          elementsPerWorker: Configuration.getWorker().elementsPerWorker,
+          elementsPerWorker:
+            elementsPerWorker ?? (Configuration.getWorker().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(
@@ -247,12 +266,12 @@ 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.id}' for data: ${JSON.stringify(msg.data, null, 2)}`,
           );
       }
     } catch (error) {
@@ -260,7 +279,7 @@ export class Bootstrap extends EventEmitter {
         `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${
           msg.id
         }' event:`,
-        error
+        error,
       );
     }
   }
@@ -273,7 +292,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 +304,7 @@ export class Bootstrap extends EventEmitter {
         data.stationInfo.chargingStationId
       } (hashId: ${data.stationInfo.hashId}) stopped (${
         this.numberOfStartedChargingStations
-      } started from ${this.numberOfChargingStations})`
+      } started from ${this.numberOfChargingStations})`,
     );
   };
 
@@ -301,20 +320,20 @@ export class Bootstrap extends EventEmitter {
     if (this.initializedCounters === false) {
       this.resetCounters();
       const stationTemplateUrls = Configuration.getStationTemplateUrls();
-      if (Utils.isNotEmptyArray(stationTemplateUrls)) {
+      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,7 +349,7 @@ export class Bootstrap extends EventEmitter {
 
   private async startChargingStation(
     index: number,
-    stationTemplateUrl: StationTemplateUrl
+    stationTemplateUrl: StationTemplateUrl,
   ): Promise<void> {
     await this.workerImplementation?.addElement({
       index,
@@ -338,7 +357,7 @@ export class Bootstrap extends EventEmitter {
         dirname(fileURLToPath(import.meta.url)),
         'assets',
         'station-templates',
-        stationTemplateUrl.file
+        stationTemplateUrl.file,
       ),
     });
   }
@@ -356,6 +375,6 @@ export class Bootstrap extends EventEmitter {
   };
 
   private logPrefix = (): string => {
-    return Utils.logPrefix(' Bootstrap |');
+    return logPrefix(' Bootstrap |');
   };
 }