feat: add graceful shutdown
[e-mobility-charging-stations-simulator.git] / src / charging-station / Bootstrap.ts
index 7a823e56f3ed7f253db079fbf8482d188528ecf4..4a6bd75c2d7a2ebbce2e6ebb24c3ceab9019dba6 100644 (file)
@@ -2,32 +2,27 @@
 
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { type Worker, isMainThread } from 'worker_threads';
+import { type Worker, isMainThread } from 'node:worker_threads';
 
 import chalk from 'chalk';
 
-import { ChargingStationUtils } from './ChargingStationUtils';
 import type { AbstractUIServer } from './ui-server/AbstractUIServer';
-import UIServerFactory from './ui-server/UIServerFactory';
-import { version } from '../../package.json';
-import BaseError from '../exception/BaseError';
-import type { Storage } from '../performance/storage/Storage';
-import { StorageFactory } from '../performance/storage/StorageFactory';
+import { UIServerFactory } from './ui-server/UIServerFactory';
+import packageJson from '../../package.json' assert { type: 'json' };
+import { BaseError } from '../exception';
+import { type Storage, StorageFactory } from '../performance';
 import {
   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 type { MessageHandler } from '../types/Worker';
-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';
+  ProcedureName,
+  type StationTemplateUrl,
+  type Statistics,
+} from '../types';
+import { Configuration, Constants, ErrorUtils, Utils, logger } from '../utils';
+import { type MessageHandler, type WorkerAbstract, WorkerFactory } from '../worker';
 
 const moduleName = 'Bootstrap';
 
@@ -44,19 +39,26 @@ export class Bootstrap {
   private readonly uiServer!: AbstractUIServer | null;
   private readonly storage!: Storage;
   private numberOfStartedChargingStations!: number;
-  private readonly version: string = version;
+  private readonly version: string = packageJson.version;
+  private initializedCounters: boolean;
   private started: boolean;
   private readonly workerScript: string;
 
   private constructor() {
+    for (const signal of ['SIGINT', 'SIGQUIT', 'SIGTERM']) {
+      process.on(signal, () => {
+        this.gracefulShutdown().catch(Constants.EMPTY_FUNCTION);
+      });
+    }
     // Enable unconditionally for now
-    this.logUnhandledRejection();
-    this.logUncaughtException();
+    ErrorUtils.handleUnhandledRejection();
+    ErrorUtils.handleUncaughtException();
+    this.initializedCounters = false;
     this.started = false;
+    this.initializeCounters();
     this.workerImplementation = null;
     this.workerScript = path.join(
-      path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
-      'charging-station',
+      path.dirname(fileURLToPath(import.meta.url)),
       `ChargingStationWorker${path.extname(fileURLToPath(import.meta.url))}`
     );
     Configuration.getUIServer().enabled === true &&
@@ -79,52 +81,47 @@ export class Bootstrap {
 
   public async start(): Promise<void> {
     if (isMainThread && this.started === false) {
-      try {
-        this.initializeCounters();
-        this.initializeWorkerImplementation();
-        await this.storage?.open();
-        await this.workerImplementation?.start();
-        this.uiServer?.start();
-        const stationTemplateUrls = Configuration.getStationTemplateUrls();
-        // Start ChargingStation object in worker thread
-        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
-            );
+      this.initializeCounters();
+      this.initializeWorkerImplementation();
+      await this.workerImplementation?.start();
+      await this.storage?.open();
+      this.uiServer?.start();
+      // 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
+          );
         }
-        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${
-              !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
-                ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
-                : ''
-            }`
-          )
-        );
-        this.started = true;
-      } catch (error) {
-        console.error(chalk.red('Bootstrap start error: '), error);
       }
+      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.getWorker().poolMinSize?.toString()}/`
+              : ''
+          }${this.workerImplementation?.size}${
+            Configuration.workerPoolInUse()
+              ? `/${Configuration.getWorker().poolMaxSize?.toString()}`
+              : ''
+          } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${
+            !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
+              ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
+              : ''
+          }`
+        )
+      );
+      this.started = true;
     } else {
       console.error(chalk.red('Cannot start an already started charging stations simulator'));
     }
@@ -132,10 +129,16 @@ export class Bootstrap {
 
   public async stop(): Promise<void> {
     if (isMainThread && this.started === true) {
+      await this.uiServer?.sendBroadcastChannelRequest(
+        Utils.generateUUID(),
+        ProcedureName.STOP_CHARGING_STATION,
+        Constants.EMPTY_FREEZED_OBJECT
+      );
       await this.workerImplementation?.stop();
       this.workerImplementation = null;
       this.uiServer?.stop();
       await this.storage?.close();
+      this.initializedCounters = false;
       this.started = false;
     } else {
       console.error(chalk.red('Cannot stop a not started charging stations simulator'));
@@ -178,16 +181,16 @@ export class Bootstrap {
     // );
     try {
       switch (msg.id) {
-        case ChargingStationWorkerMessageEvents.STARTED:
+        case ChargingStationWorkerMessageEvents.started:
           this.workerEventStarted(msg.data as ChargingStationData);
           break;
-        case ChargingStationWorkerMessageEvents.STOPPED:
+        case ChargingStationWorkerMessageEvents.stopped:
           this.workerEventStopped(msg.data as ChargingStationData);
           break;
-        case ChargingStationWorkerMessageEvents.UPDATED:
+        case ChargingStationWorkerMessageEvents.updated:
           this.workerEventUpdated(msg.data as ChargingStationData);
           break;
-        case ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS:
+        case ChargingStationWorkerMessageEvents.performanceStatistics:
           this.workerEventPerformanceStatistics(msg.data as Statistics);
           break;
         default:
@@ -238,55 +241,57 @@ export class Bootstrap {
   };
 
   private initializeCounters() {
-    this.numberOfChargingStationTemplates = 0;
-    this.numberOfChargingStations = 0;
-    const stationTemplateUrls = Configuration.getStationTemplateUrls();
-    if (!Utils.isEmptyArray(stationTemplateUrls)) {
-      this.numberOfChargingStationTemplates = stationTemplateUrls?.length;
-      stationTemplateUrls.forEach((stationTemplateUrl) => {
-        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);
+    if (this.initializedCounters === false) {
+      this.numberOfChargingStationTemplates = 0;
+      this.numberOfChargingStations = 0;
+      const stationTemplateUrls = Configuration.getStationTemplateUrls();
+      if (Utils.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.numberOfStartedChargingStations = 0;
+      this.initializedCounters = true;
     }
-    this.numberOfStartedChargingStations = 0;
-  }
-
-  private logUncaughtException(): void {
-    process.on('uncaughtException', (error: Error) => {
-      console.error(chalk.red('Uncaught exception: '), error);
-    });
-  }
-
-  private logUnhandledRejection(): void {
-    process.on('unhandledRejection', (reason: unknown) => {
-      console.error(chalk.red('Unhandled rejection: '), reason);
-    });
   }
 
   private async startChargingStation(
     index: number,
     stationTemplateUrl: StationTemplateUrl
   ): Promise<void> {
-    const workerData: ChargingStationWorkerData = {
+    await this.workerImplementation?.addElement({
       index,
       templateFile: path.join(
-        path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'),
+        path.dirname(fileURLToPath(import.meta.url)),
         'assets',
         'station-templates',
         stationTemplateUrl.file
       ),
-    };
-    await this.workerImplementation?.addElement(workerData);
+    });
   }
 
+  private gracefulShutdown = async (): Promise<void> => {
+    console.info(`${chalk.green('Graceful shutdown')}`);
+    try {
+      await this.stop();
+      process.exit(0);
+    } catch (error) {
+      process.exit(1);
+    }
+  };
+
   private logPrefix = (): string => {
     return Utils.logPrefix(' Bootstrap |');
   };