X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=ca45d287e139407ca66858f11c94dcbb3fc23d3c;hb=44eb6026079c8dc2c77b10a96a42d0c0b2da7c8f;hp=bb76c9061833e154331424f42b185b31cfda4731;hpb=ec7f4dcea28197007a32308483e8e8f4750fae5e;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index bb76c906..ca45d287 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,55 +1,65 @@ -// 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 { type Worker, isMainThread } from '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 { - ChargingStationWorkerData, - ChargingStationWorkerMessage, + type ChargingStationData, + type ChargingStationWorkerData, + type ChargingStationWorkerMessage, + type ChargingStationWorkerMessageData, ChargingStationWorkerMessageEvents, } from '../types/ChargingStationWorker'; - -import { AbstractUIServer } from './ui-server/AbstractUIServer'; -import { ApplicationProtocol } from '../types/UIProtocol'; -import { ChargingStationUtils } from './ChargingStationUtils'; +import type { StationTemplateUrl } from '../types/ConfigurationData'; +import type { Statistics } from '../types/Statistics'; +import type { MessageHandler } from '../types/Worker'; import Configuration from '../utils/Configuration'; -import { StationTemplateUrl } from '../types/ConfigurationData'; -import Statistics from '../types/Statistics'; -import { Storage } from '../performance/storage/Storage'; -import { StorageFactory } from '../performance/storage/StorageFactory'; -import UIServerFactory from './ui-server/UIServerFactory'; -import { UIServiceUtils } from './ui-server/ui-services/UIServiceUtils'; +import logger from '../utils/Logger'; import Utils from '../utils/Utils'; -import WorkerAbstract from '../worker/WorkerAbstract'; +import type WorkerAbstract from '../worker/WorkerAbstract'; import WorkerFactory from '../worker/WorkerFactory'; -import chalk from 'chalk'; -import { fileURLToPath } from 'url'; -import { isMainThread } from 'worker_threads'; -import path from 'path'; -import { version } from '../../package.json'; -export default class Bootstrap { +const moduleName = 'Bootstrap'; + +enum exitCodes { + missingChargingStationsConfiguration = 1, + noChargingStationTemplates = 2, +} + +export class Bootstrap { private static instance: Bootstrap | null = null; - private workerImplementation: WorkerAbstract | null = null; + private workerImplementation: WorkerAbstract | null; private readonly uiServer!: AbstractUIServer; private readonly storage!: Storage; private numberOfChargingStationTemplates!: number; private numberOfChargingStations!: number; + private numberOfStartedChargingStations!: number; private readonly version: string = version; private started: boolean; private readonly workerScript: string; private constructor() { this.started = false; + this.workerImplementation = null; this.workerScript = path.join( path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), 'charging-station', - 'ChargingStationWorker' + path.extname(fileURLToPath(import.meta.url)) + `ChargingStationWorker${path.extname(fileURLToPath(import.meta.url))}` ); this.initialize(); - Configuration.getUIServer().enabled && - (this.uiServer = UIServerFactory.getUIServerImplementation(ApplicationProtocol.WS, { - ...Configuration.getUIServer().options, - handleProtocols: UIServiceUtils.handleProtocols, - })); - Configuration.getPerformanceStorage().enabled && + Configuration.getUIServer().enabled === true && + (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer())); + Configuration.getPerformanceStorage().enabled === true && (this.storage = StorageFactory.getStorage( Configuration.getPerformanceStorage().type, Configuration.getPerformanceStorage().uri, @@ -59,15 +69,18 @@ export default class Bootstrap { } public static getInstance(): Bootstrap { - if (!Bootstrap.instance) { + if (Bootstrap.instance === null) { Bootstrap.instance = new Bootstrap(); } return Bootstrap.instance; } public async start(): Promise { - if (isMainThread && !this.started) { + if (isMainThread && this.started === false) { try { + // Enable unconditionally for now + this.logUnhandledRejection(); + this.logUncaughtException(); this.initialize(); await this.storage?.open(); await this.workerImplementation.start(); @@ -85,9 +98,7 @@ export default class Bootstrap { } 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 ); @@ -97,25 +108,27 @@ export default class Bootstrap { 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); } else { - console.log( + 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.getWorkerPoolMinSize().toString()}/` + ? `${Configuration.getWorker().poolMinSize.toString()}/` : '' }${this.workerImplementation.size}${ ChargingStationUtils.workerPoolInUse() - ? `/${Configuration.getWorkerPoolMaxSize().toString()}` + ? `/${Configuration.getWorker().poolMaxSize.toString()}` : '' - } worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${ + } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${ this.workerImplementation.maxElementsPerWorker ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)` : '' @@ -125,7 +138,7 @@ export default class Bootstrap { } this.started = true; } catch (error) { - console.error(chalk.red('Bootstrap start error '), error); + console.error(chalk.red('Bootstrap start error: '), error); } } else { console.error(chalk.red('Cannot start an already started charging stations simulator')); @@ -133,14 +146,15 @@ export default class Bootstrap { } public async stop(): Promise { - if (isMainThread && this.started) { + if (isMainThread && this.started === true) { await this.workerImplementation.stop(); + this.workerImplementation = null; this.uiServer?.stop(); await this.storage?.close(); + this.started = false; } else { - console.error(chalk.red('Trying to stop the charging stations simulator while not started')); + console.error(chalk.red('Cannot stop a not started charging stations simulator')); } - this.started = false; } public async restart(): Promise { @@ -150,38 +164,114 @@ export default class Bootstrap { } private initializeWorkerImplementation(): void { - !this.workerImplementation && + this.workerImplementation === null && (this.workerImplementation = WorkerFactory.getWorkerImplementation( this.workerScript, - Configuration.getWorkerProcess(), + Configuration.getWorker().processType, { - workerStartDelay: Configuration.getWorkerStartDelay(), - elementStartDelay: Configuration.getElementStartDelay(), - poolMaxSize: Configuration.getWorkerPoolMaxSize(), - poolMinSize: Configuration.getWorkerPoolMinSize(), - elementsPerWorker: Configuration.getChargingStationsPerWorker(), + workerStartDelay: Configuration.getWorker().startDelay, + elementStartDelay: Configuration.getWorker().elementStartDelay, + poolMaxSize: Configuration.getWorker().poolMaxSize, + poolMinSize: Configuration.getWorker().poolMinSize, + elementsPerWorker: Configuration.getWorker().elementsPerWorker, poolOptions: { - workerChoiceStrategy: Configuration.getWorkerPoolStrategy(), - }, - messageHandler: async (msg: ChargingStationWorkerMessage) => { - if (msg.id === ChargingStationWorkerMessageEvents.STARTED) { - this.uiServer.chargingStations.add(msg.data.id as string); - } else if (msg.id === ChargingStationWorkerMessageEvents.STOPPED) { - this.uiServer.chargingStations.delete(msg.data.id as string); - } else if (msg.id === ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS) { - await this.storage.storePerformanceStatistics(msg.data as unknown as Statistics); - } + workerChoiceStrategy: Configuration.getWorker().poolStrategy, }, + messageHandler: this.messageHandler.bind(this) as MessageHandler, } )); } + private messageHandler( + msg: ChargingStationWorkerMessage + ): void { + // logger.debug( + // `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify( + // msg, + // null, + // 2 + // )}` + // ); + try { + switch (msg.id) { + case ChargingStationWorkerMessageEvents.STARTED: + this.workerEventStarted(msg.data as ChargingStationData); + break; + case ChargingStationWorkerMessageEvents.STOPPED: + this.workerEventStopped(msg.data as ChargingStationData); + break; + case ChargingStationWorkerMessageEvents.UPDATED: + this.workerEventUpdated(msg.data as ChargingStationData); + break; + case ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS: + this.workerEventPerformanceStatistics(msg.data as Statistics); + break; + default: + throw new BaseError( + `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}` + ); + } + } catch (error) { + logger.error( + `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${ + msg.id + }' event:`, + error + ); + } + } + + 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) => { + 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) => { + this.uiServer?.chargingStations.set(data.stationInfo.hashId, data); + }; + + private workerEventPerformanceStatistics = (data: Statistics) => { + this.storage.storePerformanceStatistics(data) as void; + }; + private initialize() { - this.numberOfChargingStations = 0; this.numberOfChargingStationTemplates = 0; + this.numberOfChargingStations = 0; + this.numberOfStartedChargingStations = 0; this.initializeWorkerImplementation(); } + 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 @@ -192,11 +282,11 @@ export default class Bootstrap { path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../'), 'assets', 'station-templates', - path.basename(stationTemplateUrl.file) + stationTemplateUrl.file ), }; await this.workerImplementation.addElement(workerData); - this.numberOfChargingStations++; + ++this.numberOfChargingStations; } private logPrefix(): string {