feat: add performance statistics to UI protocol
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index 96baeacb9d968399520a1fc059d8e504a1d064fb..2c1b0f43b3443f8f239888b7f4e507ad6eefd584 100644 (file)
@@ -4,6 +4,7 @@ import { EventEmitter } from 'node:events'
 import { dirname, extname, join, parse } from 'node:path'
 import process, { exit } from 'node:process'
 import { fileURLToPath } from 'node:url'
+import { isMainThread } from 'node:worker_threads'
 import type { Worker } from 'worker_threads'
 
 import chalk from 'chalk'
@@ -18,12 +19,12 @@ import { type Storage, StorageFactory } from '../performance/index.js'
 import {
   type ChargingStationData,
   type ChargingStationWorkerData,
+  type ChargingStationWorkerEventError,
   type ChargingStationWorkerMessage,
   type ChargingStationWorkerMessageData,
   ChargingStationWorkerMessageEvents,
   ConfigurationSection,
   ProcedureName,
-  type StationTemplateUrl,
   type Statistics,
   type StorageConfiguration,
   type UIServerConfiguration,
@@ -39,7 +40,8 @@ import {
   isAsyncFunction,
   isNotEmptyArray,
   logPrefix,
-  logger
+  logger,
+  max
 } from '../utils/index.js'
 import { type WorkerAbstract, WorkerFactory } from '../worker/index.js'
 
@@ -53,12 +55,19 @@ enum exitCodes {
   gracefulShutdownError = 4
 }
 
+interface TemplateChargingStations {
+  configured: number
+  added: number
+  started: number
+  lastIndex: number
+}
+
 export class Bootstrap extends EventEmitter {
   private static instance: Bootstrap | null = null
   private workerImplementation?: WorkerAbstract<ChargingStationWorkerData>
   private readonly uiServer?: AbstractUIServer
   private storage?: Storage
-  private readonly chargingStationsByTemplate!: Map<string, { configured: number, started: number }>
+  private readonly chargingStationsByTemplate: Map<string, TemplateChargingStations>
   private readonly version: string = version
   private initializedCounters: boolean
   private started: boolean
@@ -76,20 +85,16 @@ export class Bootstrap extends EventEmitter {
     this.started = false
     this.starting = false
     this.stopping = false
-    this.chargingStationsByTemplate = new Map<
-    string,
-    {
-      configured: number
-      started: number
-    }
-    >()
-    this.initializedCounters = false
-    this.initializeCounters()
+    this.chargingStationsByTemplate = new Map<string, TemplateChargingStations>()
     this.uiServer = UIServerFactory.getUIServerImplementation(
       Configuration.getConfigurationSection<UIServerConfiguration>(ConfigurationSection.uiServer)
     )
+    this.initializedCounters = false
+    this.initializeCounters()
     Configuration.configurationChangeCallback = async () => {
-      await Bootstrap.getInstance().restart(false)
+      if (isMainThread) {
+        await Bootstrap.getInstance().restart()
+      }
     }
   }
 
@@ -111,6 +116,21 @@ export class Bootstrap extends EventEmitter {
     )
   }
 
+  public getLastIndex (templateName: string): number {
+    return this.chargingStationsByTemplate.get(templateName)?.lastIndex ?? 0
+  }
+
+  public getPerformanceStatistics (): IterableIterator<Statistics> | undefined {
+    return this.storage?.getPerformanceStatistics()
+  }
+
+  private get numberOfAddedChargingStations (): number {
+    return [...this.chargingStationsByTemplate.values()].reduce(
+      (accumulator, value) => accumulator + value.added,
+      0
+    )
+  }
+
   private get numberOfStartedChargingStations (): number {
     return [...this.chargingStationsByTemplate.values()].reduce(
       (accumulator, value) => accumulator + value.started,
@@ -122,6 +142,7 @@ export class Bootstrap extends EventEmitter {
     if (!this.started) {
       if (!this.starting) {
         this.starting = true
+        this.on(ChargingStationWorkerMessageEvents.added, this.workerEventAdded)
         this.on(ChargingStationWorkerMessageEvents.started, this.workerEventStarted)
         this.on(ChargingStationWorkerMessageEvents.stopped, this.workerEventStopped)
         this.on(ChargingStationWorkerMessageEvents.updated, this.workerEventUpdated)
@@ -159,7 +180,7 @@ export class Bootstrap extends EventEmitter {
               this.chargingStationsByTemplate.get(parse(stationTemplateUrl.file).name)
                 ?.configured ?? stationTemplateUrl.numberOfStations
             for (let index = 1; index <= nbStations; index++) {
-              await this.startChargingStation(index, stationTemplateUrl)
+              await this.addChargingStation(index, stationTemplateUrl.file)
             }
           } catch (error) {
             console.error(
@@ -174,7 +195,7 @@ export class Bootstrap extends EventEmitter {
           chalk.green(
             `Charging stations simulator ${
               this.version
-            } started with ${this.numberOfConfiguredChargingStations} charging station(s) from ${this.numberOfChargingStationTemplates} configured charging station template(s) and ${
+            } started with ${this.numberOfConfiguredChargingStations} configured charging station(s) from ${this.numberOfChargingStationTemplates} charging station template(s) and ${
               Configuration.workerDynamicPoolInUse() ? `${workerConfiguration.poolMinSize}/` : ''
             }${this.workerImplementation?.size}${
               Configuration.workerPoolInUse() ? `/${workerConfiguration.poolMaxSize}` : ''
@@ -202,23 +223,21 @@ export class Bootstrap extends EventEmitter {
     }
   }
 
-  public async stop (stopChargingStations = true): Promise<void> {
+  public async stop (): Promise<void> {
     if (this.started) {
       if (!this.stopping) {
         this.stopping = true
-        if (stopChargingStations) {
-          await this.uiServer?.sendInternalRequest(
-            this.uiServer.buildProtocolRequest(
-              generateUUID(),
-              ProcedureName.STOP_CHARGING_STATION,
-              Constants.EMPTY_FROZEN_OBJECT
-            )
+        await this.uiServer?.sendInternalRequest(
+          this.uiServer.buildProtocolRequest(
+            generateUUID(),
+            ProcedureName.STOP_CHARGING_STATION,
+            Constants.EMPTY_FROZEN_OBJECT
           )
-          try {
-            await this.waitChargingStationsStopped()
-          } catch (error) {
-            console.error(chalk.red('Error while waiting for charging stations to stop: '), error)
-          }
+        )
+        try {
+          await this.waitChargingStationsStopped()
+        } catch (error) {
+          console.error(chalk.red('Error while waiting for charging stations to stop: '), error)
         }
         await this.workerImplementation?.stop()
         delete this.workerImplementation
@@ -235,10 +254,10 @@ export class Bootstrap extends EventEmitter {
     }
   }
 
-  public async restart (stopChargingStations?: boolean): Promise<void> {
-    await this.stop(stopChargingStations)
+  private async restart (): Promise<void> {
+    await this.stop()
     Configuration.getConfigurationSection<UIServerConfiguration>(ConfigurationSection.uiServer)
-      .enabled === false && this.uiServer?.stop()
+      .enabled !== true && this.uiServer?.stop()
     this.initializedCounters = false
     await this.start()
   }
@@ -268,6 +287,9 @@ export class Bootstrap extends EventEmitter {
   }
 
   private initializeWorkerImplementation (workerConfiguration: WorkerConfiguration): void {
+    if (!isMainThread) {
+      return
+    }
     let elementsPerWorker: number | undefined
     switch (workerConfiguration.elementsPerWorker) {
       case 'auto':
@@ -315,6 +337,9 @@ export class Bootstrap extends EventEmitter {
     // )
     try {
       switch (msg.event) {
+        case ChargingStationWorkerMessageEvents.added:
+          this.emit(ChargingStationWorkerMessageEvents.added, msg.data as ChargingStationData)
+          break
         case ChargingStationWorkerMessageEvents.started:
           this.emit(ChargingStationWorkerMessageEvents.started, msg.data as ChargingStationData)
           break
@@ -330,14 +355,14 @@ export class Bootstrap extends EventEmitter {
             msg.data as Statistics
           )
           break
-        case ChargingStationWorkerMessageEvents.startWorkerElementError:
+        case ChargingStationWorkerMessageEvents.addedWorkerElement:
+          break
+        case ChargingStationWorkerMessageEvents.workerElementError:
           logger.error(
-            `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while starting worker element:`,
+            `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${(msg.data as ChargingStationWorkerEventError).event}' event on worker:`,
             msg.data
           )
-          this.emit(ChargingStationWorkerMessageEvents.startWorkerElementError, msg.data)
-          break
-        case ChargingStationWorkerMessageEvents.startedWorkerElement:
+          this.emit(ChargingStationWorkerMessageEvents.workerElementError, msg.data)
           break
         default:
           throw new BaseError(
@@ -356,6 +381,19 @@ export class Bootstrap extends EventEmitter {
     }
   }
 
+  private readonly workerEventAdded = (data: ChargingStationData): void => {
+    this.uiServer?.chargingStations.set(data.stationInfo.hashId, data)
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    ++this.chargingStationsByTemplate.get(data.stationInfo.templateName)!.added
+    logger.info(
+      `${this.logPrefix()} ${moduleName}.workerEventAdded: Charging station ${
+        data.stationInfo.chargingStationId
+      } (hashId: ${data.stationInfo.hashId}) added (${
+        this.numberOfAddedChargingStations
+      } added from ${this.numberOfConfiguredChargingStations} configured charging station(s))`
+    )
+  }
+
   private readonly workerEventStarted = (data: ChargingStationData): void => {
     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data)
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -365,7 +403,7 @@ export class Bootstrap extends EventEmitter {
         data.stationInfo.chargingStationId
       } (hashId: ${data.stationInfo.hashId}) started (${
         this.numberOfStartedChargingStations
-      } started from ${this.numberOfConfiguredChargingStations})`
+      } started from ${this.numberOfAddedChargingStations} added charging station(s))`
     )
   }
 
@@ -378,7 +416,7 @@ export class Bootstrap extends EventEmitter {
         data.stationInfo.chargingStationId
       } (hashId: ${data.stationInfo.hashId}) stopped (${
         this.numberOfStartedChargingStations
-      } started from ${this.numberOfConfiguredChargingStations})`
+      } started from ${this.numberOfAddedChargingStations} added charging station(s))`
     )
   }
 
@@ -410,7 +448,9 @@ export class Bootstrap extends EventEmitter {
           const templateName = parse(stationTemplateUrl.file).name
           this.chargingStationsByTemplate.set(templateName, {
             configured: stationTemplateUrl.numberOfStations,
-            started: 0
+            added: 0,
+            started: 0,
+            lastIndex: 0
           })
           this.uiServer?.chargingStationTemplates.add(templateName)
         }
@@ -428,10 +468,14 @@ export class Bootstrap extends EventEmitter {
         )
         exit(exitCodes.missingChargingStationsConfiguration)
       }
-      if (this.numberOfConfiguredChargingStations === 0) {
+      if (
+        this.numberOfConfiguredChargingStations === 0 &&
+        Configuration.getConfigurationSection<UIServerConfiguration>(ConfigurationSection.uiServer)
+          .enabled !== true
+      ) {
         console.error(
           chalk.red(
-            "'stationTemplateUrls' has no charging station enabled, please check your configuration"
+            "'stationTemplateUrls' has no charging station enabled and UI server is disabled, please check your configuration"
           )
         )
         exit(exitCodes.noChargingStationTemplates)
@@ -440,19 +484,21 @@ export class Bootstrap extends EventEmitter {
     }
   }
 
-  private async startChargingStation (
-    index: number,
-    stationTemplateUrl: StationTemplateUrl
-  ): Promise<void> {
+  public async addChargingStation (index: number, stationTemplateFile: string): Promise<void> {
     await this.workerImplementation?.addElement({
       index,
       templateFile: join(
         dirname(fileURLToPath(import.meta.url)),
         'assets',
         'station-templates',
-        stationTemplateUrl.file
+        stationTemplateFile
       )
     })
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    this.chargingStationsByTemplate.get(parse(stationTemplateFile).name)!.lastIndex = max(
+      index,
+      this.chargingStationsByTemplate.get(parse(stationTemplateFile).name)?.lastIndex ?? -Infinity
+    )
   }
 
   private gracefulShutdown (): void {
@@ -460,7 +506,6 @@ export class Bootstrap extends EventEmitter {
       .then(() => {
         console.info(chalk.green('Graceful shutdown'))
         this.uiServer?.stop()
-        // stop() asks for charging stations to stop by default
         this.waitChargingStationsStopped()
           .then(() => {
             exit(exitCodes.succeeded)