X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=2c7f56fe4de94c1d7524e99957e68c1b8503c83c;hb=f23be6aad227f8942bb140d286585423fe84f60b;hp=df0bb8e98cda7c85b30104ba9ed9fac37fceb610;hpb=d58b442097da31f8b974d51aef63c64470d9ab48;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index df0bb8e9..2c7f56fe 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,15 +1,17 @@ // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. import { EventEmitter } from 'node:events'; -import path from 'node:path'; +import { dirname, extname, join } from 'node:path'; +import process, { exit } from 'node:process'; import { fileURLToPath } from 'node:url'; -import { type Worker, isMainThread } from 'node:worker_threads'; import chalk from 'chalk'; +import { availableParallelism } from 'poolifier'; +import { waitChargingStationEvents } from './Helpers'; import type { AbstractUIServer } from './ui-server/AbstractUIServer'; import { UIServerFactory } from './ui-server/UIServerFactory'; -import packageJson from '../../package.json' assert { type: 'json' }; +import { version } from '../../package.json'; import { BaseError } from '../exception'; import { type Storage, StorageFactory } from '../performance'; import { @@ -18,25 +20,35 @@ import { type ChargingStationWorkerMessage, type ChargingStationWorkerMessageData, ChargingStationWorkerMessageEvents, + ConfigurationSection, ProcedureName, type StationTemplateUrl, type Statistics, + type StorageConfiguration, + type UIServerConfiguration, + type WorkerConfiguration, } from '../types'; import { Configuration, Constants, - Utils, + formatDurationMilliSeconds, + generateUUID, handleUncaughtException, handleUnhandledRejection, + isNotEmptyArray, + isNullOrUndefined, + logPrefix, logger, } from '../utils'; -import { type MessageHandler, type WorkerAbstract, WorkerFactory } from '../worker'; +import { type WorkerAbstract, WorkerFactory } from '../worker'; const moduleName = 'Bootstrap'; enum exitCodes { + succeeded = 0, missingChargingStationsConfiguration = 1, noChargingStationTemplates = 2, + gracefulShutdownError = 3, } export class Bootstrap extends EventEmitter { @@ -44,10 +56,10 @@ export class Bootstrap extends EventEmitter { public numberOfChargingStations!: number; public numberOfChargingStationTemplates!: number; private workerImplementation: WorkerAbstract | null; - private readonly uiServer!: AbstractUIServer | null; + private readonly uiServer: AbstractUIServer | null; private readonly storage!: Storage; private numberOfStartedChargingStations!: number; - private readonly version: string = packageJson.version; + private readonly version: string = version; private initializedCounters: boolean; private started: boolean; private starting: boolean; @@ -57,7 +69,7 @@ export class Bootstrap extends EventEmitter { private constructor() { super(); for (const signal of ['SIGINT', 'SIGQUIT', 'SIGTERM']) { - process.on(signal, this.gracefulShutdown); + process.on(signal, this.gracefulShutdown.bind(this)); } // Enable unconditionally for now handleUnhandledRejection(); @@ -68,19 +80,24 @@ export class Bootstrap extends EventEmitter { this.initializedCounters = false; this.initializeCounters(); this.workerImplementation = null; - this.workerScript = path.join( - path.dirname(fileURLToPath(import.meta.url)), - `ChargingStationWorker${path.extname(fileURLToPath(import.meta.url))}` + this.workerScript = join( + dirname(fileURLToPath(import.meta.url)), + `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`, ); - Configuration.getUIServer().enabled === true && - (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer())); - Configuration.getPerformanceStorage().enabled === true && + this.uiServer = UIServerFactory.getUIServerImplementation( + Configuration.getConfigurationSection(ConfigurationSection.uiServer), + ); + const performanceStorageConfiguration = + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ); + performanceStorageConfiguration.enabled === true && (this.storage = StorageFactory.getStorage( - Configuration.getPerformanceStorage().type, - Configuration.getPerformanceStorage().uri, - this.logPrefix() + performanceStorageConfiguration.type!, + performanceStorageConfiguration.uri!, + this.logPrefix(), )); - Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart()); + Configuration.configurationChangeCallback = async () => Bootstrap.getInstance().restart(false); } public static getInstance(): Bootstrap { @@ -91,19 +108,20 @@ export class Bootstrap extends EventEmitter { } public async start(): Promise { - 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(); + const workerConfiguration = Configuration.getConfigurationSection( + ConfigurationSection.worker, + ); + this.initializeWorkerImplementation(workerConfiguration); await this.workerImplementation?.start(); await this.storage?.open(); - this.uiServer?.start(); + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled === true && this.uiServer?.start(); // Start ChargingStation object instance in worker thread - for (const stationTemplateUrl of Configuration.getStationTemplateUrls()) { + for (const stationTemplateUrl of Configuration.getStationTemplateUrls()!) { try { const nbStations = stationTemplateUrl.numberOfStations ?? 0; for (let index = 1; index <= nbStations; index++) { @@ -112,9 +130,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, ); } } @@ -124,19 +142,26 @@ export class Bootstrap extends EventEmitter { 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()}/` + ? `${workerConfiguration.poolMinSize?.toString()}/` : '' }${this.workerImplementation?.size}${ Configuration.workerPoolInUse() - ? `/${Configuration.getWorker().poolMaxSize?.toString()}` + ? `/${workerConfiguration.poolMaxSize?.toString()}` : '' - } worker(s) concurrently running in '${Configuration.getWorker().processType}' mode${ - !Utils.isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker) + } worker(s) concurrently running in '${workerConfiguration.processType}' mode${ + !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 fixed pool or worker set mode instead', + ), + ); + console.info(chalk.green('Worker set/pool information:'), this.workerImplementation?.info); this.started = true; this.starting = false; } else { @@ -147,21 +172,20 @@ export class Bootstrap extends EventEmitter { } } - public async stop(): Promise { - if (!isMainThread) { - throw new Error('Cannot stop charging stations simulator from worker thread'); - } + public async stop(stopChargingStations = true): Promise { if (this.started === true) { if (this.stopping === false) { this.stopping = true; - await this.uiServer?.sendInternalRequest( - this.uiServer.buildProtocolRequest( - Utils.generateUUID(), - ProcedureName.STOP_CHARGING_STATION, - Constants.EMPTY_FREEZED_OBJECT - ) - ); - await this.waitForChargingStationsStopped(); + if (stopChargingStations === true) { + await this.uiServer?.sendInternalRequest( + this.uiServer.buildProtocolRequest( + generateUUID(), + ProcedureName.STOP_CHARGING_STATION, + Constants.EMPTY_FROZEN_OBJECT, + ), + ); + await this.waitChargingStationsStopped(); + } await this.workerImplementation?.stop(); this.workerImplementation = null; this.uiServer?.stop(); @@ -178,42 +202,67 @@ export class Bootstrap extends EventEmitter { } } - public async restart(): Promise { - await this.stop(); + public async restart(stopChargingStations?: boolean): Promise { + await this.stop(stopChargingStations); await this.start(); } - private initializeWorkerImplementation(): void { + private async waitChargingStationsStopped(): Promise { + await Promise.race([ + waitChargingStationEvents( + this, + ChargingStationWorkerMessageEvents.stopped, + this.numberOfChargingStations, + ), + new Promise((resolve) => { + setTimeout(() => { + const message = `Timeout ${formatDurationMilliSeconds( + Constants.STOP_SIMULATOR_TIMEOUT, + )} reached at stopping charging stations simulator`; + console.warn(chalk.yellow(message)); + resolve(message); + }, Constants.STOP_SIMULATOR_TIMEOUT); + }), + ]); + } + + private initializeWorkerImplementation(workerConfiguration: WorkerConfiguration): void { + let elementsPerWorker: number | undefined; + if (workerConfiguration?.elementsPerWorker === 'auto') { + elementsPerWorker = + this.numberOfChargingStations > availableParallelism() + ? Math.round(this.numberOfChargingStations / (availableParallelism() * 1.5)) + : 1; + } this.workerImplementation === null && (this.workerImplementation = WorkerFactory.getWorkerImplementation( this.workerScript, - Configuration.getWorker().processType, + workerConfiguration.processType!, { - workerStartDelay: Configuration.getWorker().startDelay, - elementStartDelay: Configuration.getWorker().elementStartDelay, - poolMaxSize: Configuration.getWorker().poolMaxSize, - poolMinSize: Configuration.getWorker().poolMinSize, - elementsPerWorker: Configuration.getWorker().elementsPerWorker, + workerStartDelay: workerConfiguration.startDelay, + elementStartDelay: workerConfiguration.elementStartDelay, + poolMaxSize: workerConfiguration.poolMaxSize!, + poolMinSize: workerConfiguration.poolMinSize!, + elementsPerWorker: elementsPerWorker ?? (workerConfiguration.elementsPerWorker as number), poolOptions: { - workerChoiceStrategy: Configuration.getWorker().poolStrategy, + messageHandler: this.messageHandler.bind(this) as (message: unknown) => void, }, - messageHandler: this.messageHandler.bind(this) as MessageHandler, - } + }, )); } private messageHandler( - msg: ChargingStationWorkerMessage + msg: ChargingStationWorkerMessage, ): void { // logger.debug( // `${this.logPrefix()} ${moduleName}.messageHandler: Worker channel message received: ${JSON.stringify( // msg, - // null, - // 2 - // )}` + // undefined, + // 2, + // )}`, // ); try { - switch (msg.id) { + switch (msg.event) { case ChargingStationWorkerMessageEvents.started: this.workerEventStarted(msg.data as ChargingStationData); this.emit(ChargingStationWorkerMessageEvents.started, msg.data as ChargingStationData); @@ -230,20 +279,31 @@ export class Bootstrap extends EventEmitter { this.workerEventPerformanceStatistics(msg.data as Statistics); this.emit( ChargingStationWorkerMessageEvents.performanceStatistics, - msg.data as Statistics + msg.data as Statistics, + ); + break; + case ChargingStationWorkerMessageEvents.startWorkerElementError: + logger.error( + `${this.logPrefix()} ${moduleName}.messageHandler: Error occured while starting worker element:`, + msg.data, ); + this.emit(ChargingStationWorkerMessageEvents.startWorkerElementError, msg.data); + break; + case ChargingStationWorkerMessageEvents.startedWorkerElement: break; default: throw new BaseError( - `Unknown event type: '${msg.id}' for data: ${JSON.stringify(msg.data, null, 2)}` + `Unknown charging station worker event: '${ + msg.event + }' received with data: ${JSON.stringify(msg.data, undefined, 2)}`, ); } } catch (error) { logger.error( `${this.logPrefix()} ${moduleName}.messageHandler: Error occurred while handling '${ - msg.id + msg.event }' event:`, - error + error, ); } } @@ -256,7 +316,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) started (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -268,7 +328,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) stopped (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -283,23 +343,23 @@ export class Bootstrap extends EventEmitter { private initializeCounters() { if (this.initializedCounters === false) { this.resetCounters(); - const stationTemplateUrls = Configuration.getStationTemplateUrls(); - if (Utils.isNotEmptyArray(stationTemplateUrls)) { + 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") + chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting"), ); - process.exit(exitCodes.missingChargingStationsConfiguration); + 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); + exit(exitCodes.noChargingStationTemplates); } this.initializedCounters = true; } @@ -313,49 +373,40 @@ export class Bootstrap extends EventEmitter { private async startChargingStation( index: number, - stationTemplateUrl: StationTemplateUrl + stationTemplateUrl: StationTemplateUrl, ): Promise { await this.workerImplementation?.addElement({ index, - templateFile: path.join( - path.dirname(fileURLToPath(import.meta.url)), + templateFile: join( + dirname(fileURLToPath(import.meta.url)), 'assets', 'station-templates', - stationTemplateUrl.file + stationTemplateUrl.file, ), }); } - private gracefulShutdown = (): void => { - console.info(`${chalk.green('Graceful shutdown')}`); + private gracefulShutdown(): void { this.stop() .then(() => { - process.exit(0); + console.info(`${chalk.green('Graceful shutdown')}`); + // stop() asks for charging stations to stop by default + this.waitChargingStationsStopped() + .then(() => { + exit(exitCodes.succeeded); + }) + .catch((error) => { + console.error(chalk.red('Error while waiting for charging stations to stop: '), error); + exit(exitCodes.gracefulShutdownError); + }); }) .catch((error) => { console.error(chalk.red('Error while shutdowning charging stations simulator: '), error); - process.exit(1); - }); - }; - - private waitForChargingStationsStopped = async ( - stoppedEventsToWait = this.numberOfStartedChargingStations - ): Promise => { - return new Promise((resolve) => { - let stoppedEvents = 0; - if (stoppedEventsToWait === 0) { - resolve(stoppedEvents); - } - this.on(ChargingStationWorkerMessageEvents.stopped, () => { - ++stoppedEvents; - if (stoppedEvents === stoppedEventsToWait) { - resolve(stoppedEvents); - } + exit(exitCodes.gracefulShutdownError); }); - }); - }; + } private logPrefix = (): string => { - return Utils.logPrefix(' Bootstrap |'); + return logPrefix(' Bootstrap |'); }; }