X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=2c5d6a7d532b7f7d1eefabd17d8e8923b0c8e08f;hb=5d0498291974ec3a130ba4b1c4663d13d16992c5;hp=8734ed2284b38c5c0e8706cbb86e8afa013c1d0c;hpb=5af9aa8a875b3dbd4b4d394ecac022d046fa725c;p=e-mobility-charging-stations-simulator.git

diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts
index 8734ed22..2c5d6a7d 100644
--- a/src/charging-station/Bootstrap.ts
+++ b/src/charging-station/Bootstrap.ts
@@ -1,68 +1,103 @@
-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { isMainThread } from 'worker_threads';
+import { EventEmitter } from 'node:events';
+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 { version } from '../../package.json';
-import BaseError from '../exception/BaseError';
-import type { Storage } from '../performance/storage/Storage';
-import { StorageFactory } from '../performance/storage/StorageFactory';
+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' };
+import { BaseError } from '../exception';
+import { type Storage, StorageFactory } from '../performance';
 import {
-  ChargingStationData,
-  ChargingStationWorkerData,
-  ChargingStationWorkerMessage,
-  ChargingStationWorkerMessageData,
+  type ChargingStationData,
+  type ChargingStationWorkerData,
+  type ChargingStationWorkerMessage,
+  type ChargingStationWorkerMessageData,
   ChargingStationWorkerMessageEvents,
-} from '../types/ChargingStationWorker';
-import type { StationTemplateUrl } from '../types/ConfigurationData';
-import type Statistics from '../types/Statistics';
-import Configuration from '../utils/Configuration';
-import logger from '../utils/Logger';
-import Utils from '../utils/Utils';
-import type WorkerAbstract from '../worker/WorkerAbstract';
-import WorkerFactory from '../worker/WorkerFactory';
-import { ChargingStationUtils } from './ChargingStationUtils';
-import type { AbstractUIServer } from './ui-server/AbstractUIServer';
-import UIServerFactory from './ui-server/UIServerFactory';
+  ConfigurationSection,
+  ProcedureName,
+  type StationTemplateUrl,
+  type Statistics,
+  type StorageConfiguration,
+  type UIServerConfiguration,
+  type WorkerConfiguration,
+} from '../types';
+import {
+  Configuration,
+  Constants,
+  formatDurationMilliSeconds,
+  generateUUID,
+  handleUncaughtException,
+  handleUnhandledRejection,
+  isNotEmptyArray,
+  isNullOrUndefined,
+  logPrefix,
+  logger,
+} from '../utils';
+import { type WorkerAbstract, WorkerFactory } from '../worker';
 
 const moduleName = 'Bootstrap';
 
-const missingChargingStationsConfigurationExitCode = 1;
-const noChargingStationTemplatesExitCode = 2;
+enum exitCodes {
+  missingChargingStationsConfiguration = 1,
+  noChargingStationTemplates = 2,
+}
 
-export class Bootstrap {
+export class Bootstrap extends EventEmitter {
   private static instance: Bootstrap | null = null;
-  private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null = null;
-  private readonly uiServer!: AbstractUIServer;
+  public numberOfChargingStations!: number;
+  public numberOfChargingStationTemplates!: number;
+  private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null;
+  private readonly uiServer!: AbstractUIServer | null;
   private readonly storage!: Storage;
-  private numberOfChargingStationTemplates!: number;
-  private numberOfChargingStations!: number;
   private numberOfStartedChargingStations!: number;
   private readonly version: string = version;
+  private initializedCounters: boolean;
   private started: boolean;
+  private starting: boolean;
+  private stopping: boolean;
   private readonly workerScript: string;
 
   private constructor() {
+    super();
+    for (const signal of ['SIGINT', 'SIGQUIT', 'SIGTERM']) {
+      process.on(signal, this.gracefulShutdown);
+    }
+    // Enable unconditionally for now
+    handleUnhandledRejection();
+    handleUncaughtException();
     this.started = false;
-    this.workerScript = path.join(
-      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
-      'charging-station',
-      'ChargingStationWorker' + path.extname(fileURLToPath(import.meta.url))
+    this.starting = false;
+    this.stopping = false;
+    this.initializedCounters = false;
+    this.initializeCounters();
+    this.workerImplementation = null;
+    this.workerScript = join(
+      dirname(fileURLToPath(import.meta.url)),
+      `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`,
     );
-    this.initialize();
-    Configuration.getUIServer().enabled === true &&
+    Configuration.getConfigurationSection<UIServerConfiguration>(ConfigurationSection.uiServer)
+      .enabled === true &&
       (this.uiServer = UIServerFactory.getUIServerImplementation(
-        Configuration.getUIServer().type,
-        Configuration.getUIServer()
+        Configuration.getConfigurationSection<UIServerConfiguration>(ConfigurationSection.uiServer),
       ));
-    Configuration.getPerformanceStorage().enabled === true &&
+    Configuration.getConfigurationSection<StorageConfiguration>(
+      ConfigurationSection.performanceStorage,
+    ).enabled === true &&
       (this.storage = StorageFactory.getStorage(
-        Configuration.getPerformanceStorage().type,
-        Configuration.getPerformanceStorage().uri,
-        this.logPrefix()
+        Configuration.getConfigurationSection<StorageConfiguration>(
+          ConfigurationSection.performanceStorage,
+        ).type!,
+        Configuration.getConfigurationSection<StorageConfiguration>(
+          ConfigurationSection.performanceStorage,
+        ).uri!,
+        this.logPrefix(),
       ));
     Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart());
   }
@@ -75,68 +110,71 @@ export class Bootstrap {
   }
 
   public async start(): Promise<void> {
-    if (isMainThread && this.started === false) {
-      try {
-        this.initialize();
+    if (!isMainThread) {
+      throw new Error('Cannot start charging stations simulator from worker thread');
+    }
+    if (this.started === false) {
+      if (this.starting === false) {
+        this.starting = true;
+        this.initializeCounters();
+        this.initializeWorkerImplementation();
+        await this.workerImplementation?.start();
         await this.storage?.open();
-        await this.workerImplementation.start();
         this.uiServer?.start();
-        const stationTemplateUrls = Configuration.getStationTemplateUrls();
-        this.numberOfChargingStationTemplates = stationTemplateUrls.length;
-        // Start ChargingStation object in worker thread
-        if (!Utils.isEmptyArray(stationTemplateUrls)) {
-          for (const stationTemplateUrl of stationTemplateUrls) {
-            try {
-              const nbStations = stationTemplateUrl.numberOfStations ?? 0;
-              for (let index = 1; index <= nbStations; index++) {
-                await this.startChargingStation(index, stationTemplateUrl);
-              }
-            } catch (error) {
-              console.error(
-                chalk.red(
-                  'Error at starting charging station with template file ' +
-                    stationTemplateUrl.file +
-                    ': '
-                ),
-                error
-              );
+        // Start ChargingStation object instance in worker thread
+        for (const stationTemplateUrl of Configuration.getStationTemplateUrls()!) {
+          try {
+            const nbStations = stationTemplateUrl.numberOfStations ?? 0;
+            for (let index = 1; index <= nbStations; index++) {
+              await this.startChargingStation(index, stationTemplateUrl);
             }
+          } catch (error) {
+            console.error(
+              chalk.red(
+                `Error at starting charging station with template file ${stationTemplateUrl.file}: `,
+              ),
+              error,
+            );
           }
-        } else {
-          console.warn(
-            chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting")
-          );
-          process.exit(missingChargingStationsConfigurationExitCode);
         }
-        if (this.numberOfChargingStations === 0) {
+        console.info(
+          chalk.green(
+            `Charging stations simulator ${
+              this.version
+            } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${
+              Configuration.workerDynamicPoolInUse()
+                ? `${Configuration.getConfigurationSection<WorkerConfiguration>(
+                    ConfigurationSection.worker,
+                  ).poolMinSize?.toString()}/`
+                : ''
+            }${this.workerImplementation?.size}${
+              Configuration.workerPoolInUse()
+                ? `/${Configuration.getConfigurationSection<WorkerConfiguration>(
+                    ConfigurationSection.worker,
+                  ).poolMaxSize?.toString()}`
+                : ''
+            } worker(s) concurrently running in '${
+              Configuration.getConfigurationSection<WorkerConfiguration>(
+                ConfigurationSection.worker,
+              ).processType
+            }' mode${
+              !isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
+                ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
+                : ''
+            }`,
+          ),
+        );
+        Configuration.workerDynamicPoolInUse() &&
           console.warn(
-            chalk.yellow('No charging station template enabled in configuration, exiting')
+            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',
+            ),
           );
-          process.exit(noChargingStationTemplatesExitCode);
-        } else {
-          console.info(
-            chalk.green(
-              `Charging stations simulator ${
-                this.version
-              } started with ${this.numberOfChargingStations.toString()} charging station(s) from ${this.numberOfChargingStationTemplates.toString()} configured charging station template(s) and ${
-                ChargingStationUtils.workerDynamicPoolInUse()
-                  ? `${Configuration.getWorker().poolMinSize.toString()}/`
-                  : ''
-              }${this.workerImplementation.size}${
-                ChargingStationUtils.workerPoolInUse()
-                  ? `/${Configuration.getWorker().poolMaxSize.toString()}`
-                  : ''
-              } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
-                this.workerImplementation.maxElementsPerWorker
-                  ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)`
-                  : ''
-              }`
-            )
-          );
-        }
+        console.info(chalk.green('Worker set/pool information:'), this.workerImplementation?.info);
         this.started = true;
-      } catch (error) {
-        console.error(chalk.red('Bootstrap start error: '), error);
+        this.starting = false;
+      } else {
+        console.error(chalk.red('Cannot start an already starting charging stations simulator'));
       }
     } else {
       console.error(chalk.red('Cannot start an already started charging stations simulator'));
@@ -144,71 +182,130 @@ export class Bootstrap {
   }
 
   public async stop(): Promise<void> {
-    if (isMainThread && this.started === true) {
-      await this.workerImplementation.stop();
-      this.workerImplementation = null;
-      this.uiServer?.stop();
-      await this.storage?.close();
+    if (!isMainThread) {
+      throw new Error('Cannot stop charging stations simulator from worker thread');
+    }
+    if (this.started === true) {
+      if (this.stopping === false) {
+        this.stopping = true;
+        await this.uiServer?.sendInternalRequest(
+          this.uiServer.buildProtocolRequest(
+            generateUUID(),
+            ProcedureName.STOP_CHARGING_STATION,
+            Constants.EMPTY_FREEZED_OBJECT,
+          ),
+        );
+        await Promise.race([
+          waitChargingStationEvents(
+            this,
+            ChargingStationWorkerMessageEvents.stopped,
+            this.numberOfChargingStations,
+          ),
+          new Promise<string>((resolve) => {
+            setTimeout(() => {
+              const message = `Timeout reached ${formatDurationMilliSeconds(
+                Constants.STOP_SIMULATOR_TIMEOUT,
+              )} at stopping charging stations simulator`;
+              console.warn(chalk.yellow(message));
+              resolve(message);
+            }, Constants.STOP_SIMULATOR_TIMEOUT);
+          }),
+        ]);
+        await this.workerImplementation?.stop();
+        this.workerImplementation = null;
+        this.uiServer?.stop();
+        await this.storage?.close();
+        this.resetCounters();
+        this.initializedCounters = false;
+        this.started = false;
+        this.stopping = false;
+      } else {
+        console.error(chalk.red('Cannot stop an already stopping charging stations simulator'));
+      }
     } else {
-      console.error(chalk.red('Trying to stop the charging stations simulator while not started'));
+      console.error(chalk.red('Cannot stop an already stopped charging stations simulator'));
     }
-    this.started = false;
   }
 
   public async restart(): Promise<void> {
     await this.stop();
-    this.initialize();
     await this.start();
   }
 
   private initializeWorkerImplementation(): void {
-    !this.workerImplementation &&
+    let elementsPerWorker: number | undefined;
+    if (
+      Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+        ?.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,
+        Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+          .processType!,
         {
-          workerStartDelay: Configuration.getWorker().startDelay,
-          elementStartDelay: Configuration.getWorker().elementStartDelay,
-          poolMaxSize: Configuration.getWorker().poolMaxSize,
-          poolMinSize: Configuration.getWorker().poolMinSize,
-          elementsPerWorker: Configuration.getWorker().elementsPerWorker,
+          workerStartDelay: Configuration.getConfigurationSection<WorkerConfiguration>(
+            ConfigurationSection.worker,
+          ).startDelay,
+          elementStartDelay: Configuration.getConfigurationSection<WorkerConfiguration>(
+            ConfigurationSection.worker,
+          ).elementStartDelay,
+          poolMaxSize: Configuration.getConfigurationSection<WorkerConfiguration>(
+            ConfigurationSection.worker,
+          ).poolMaxSize!,
+          poolMinSize: Configuration.getConfigurationSection<WorkerConfiguration>(
+            ConfigurationSection.worker,
+          ).poolMinSize!,
+          elementsPerWorker:
+            elementsPerWorker ??
+            (Configuration.getConfigurationSection<WorkerConfiguration>(ConfigurationSection.worker)
+              .elementsPerWorker as number),
           poolOptions: {
-            workerChoiceStrategy: Configuration.getWorker().poolStrategy,
+            messageHandler: this.messageHandler.bind(this) as (message: unknown) => void,
           },
-          messageHandler: this.messageHandler.bind(this) as (
-            msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
-          ) => 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,
+    //   )}`,
     // );
     try {
       switch (msg.id) {
-        case ChargingStationWorkerMessageEvents.STARTED:
+        case ChargingStationWorkerMessageEvents.started:
           this.workerEventStarted(msg.data as ChargingStationData);
+          this.emit(ChargingStationWorkerMessageEvents.started, msg.data as ChargingStationData);
           break;
-        case ChargingStationWorkerMessageEvents.STOPPED:
+        case ChargingStationWorkerMessageEvents.stopped:
           this.workerEventStopped(msg.data as ChargingStationData);
+          this.emit(ChargingStationWorkerMessageEvents.stopped, msg.data as ChargingStationData);
           break;
-        case ChargingStationWorkerMessageEvents.UPDATED:
+        case ChargingStationWorkerMessageEvents.updated:
           this.workerEventUpdated(msg.data as ChargingStationData);
+          this.emit(ChargingStationWorkerMessageEvents.updated, msg.data as ChargingStationData);
           break;
-        case ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS:
+        case ChargingStationWorkerMessageEvents.performanceStatistics:
           this.workerEventPerformanceStatistics(msg.data as Statistics);
+          this.emit(
+            ChargingStationWorkerMessageEvents.performanceStatistics,
+            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) {
@@ -216,54 +313,102 @@ export class Bootstrap {
         `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${
           msg.id
         }' event:`,
-        error
+        error,
       );
     }
   }
 
-  private workerEventStarted(data: ChargingStationData) {
+  private workerEventStarted = (data: ChargingStationData) => {
     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
     ++this.numberOfStartedChargingStations;
-  }
+    logger.info(
+      `${this.logPrefix()} ${moduleName}.workerEventStarted: Charging station ${
+        data.stationInfo.chargingStationId
+      } (hashId: ${data.stationInfo.hashId}) started (${
+        this.numberOfStartedChargingStations
+      } started from ${this.numberOfChargingStations})`,
+    );
+  };
 
-  private workerEventStopped(data: ChargingStationData) {
+  private workerEventStopped = (data: ChargingStationData) => {
     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
     --this.numberOfStartedChargingStations;
-  }
+    logger.info(
+      `${this.logPrefix()} ${moduleName}.workerEventStopped: Charging station ${
+        data.stationInfo.chargingStationId
+      } (hashId: ${data.stationInfo.hashId}) stopped (${
+        this.numberOfStartedChargingStations
+      } started from ${this.numberOfChargingStations})`,
+    );
+  };
 
-  private workerEventUpdated(data: ChargingStationData) {
+  private workerEventUpdated = (data: ChargingStationData) => {
     this.uiServer?.chargingStations.set(data.stationInfo.hashId, data);
-  }
+  };
 
   private workerEventPerformanceStatistics = (data: Statistics) => {
     this.storage.storePerformanceStatistics(data) as void;
   };
 
-  private initialize() {
+  private initializeCounters() {
+    if (this.initializedCounters === false) {
+      this.resetCounters();
+      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"),
+        );
+        process.exit(exitCodes.missingChargingStationsConfiguration);
+      }
+      if (this.numberOfChargingStations === 0) {
+        console.warn(
+          chalk.yellow('No charging station template enabled in configuration, exiting'),
+        );
+        process.exit(exitCodes.noChargingStationTemplates);
+      }
+      this.initializedCounters = true;
+    }
+  }
+
+  private resetCounters(): void {
     this.numberOfChargingStationTemplates = 0;
     this.numberOfChargingStations = 0;
     this.numberOfStartedChargingStations = 0;
-    this.initializeWorkerImplementation();
   }
 
   private async startChargingStation(
     index: number,
-    stationTemplateUrl: StationTemplateUrl
+    stationTemplateUrl: StationTemplateUrl,
   ): Promise<void> {
-    const workerData: ChargingStationWorkerData = {
+    await this.workerImplementation?.addElement({
       index,
-      templateFile: path.join(
-        path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+      templateFile: join(
+        dirname(fileURLToPath(import.meta.url)),
         'assets',
         'station-templates',
-        stationTemplateUrl.file
+        stationTemplateUrl.file,
       ),
-    };
-    await this.workerImplementation.addElement(workerData);
-    ++this.numberOfChargingStations;
+    });
   }
 
-  private logPrefix(): string {
-    return Utils.logPrefix(' Bootstrap |');
-  }
+  private gracefulShutdown = (): void => {
+    console.info(`${chalk.green('Graceful shutdown')}`);
+    this.stop()
+      .then(() => {
+        process.exit(0);
+      })
+      .catch((error) => {
+        console.error(chalk.red('Error while shutdowning charging stations simulator: '), error);
+        process.exit(1);
+      });
+  };
+
+  private logPrefix = (): string => {
+    return logPrefix(' Bootstrap |');
+  };
 }