X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2FBootstrap.ts;h=6620764559974d12e6ca8a89cf7ccae497937e22;hb=ee7c1da0e12c70134f31537a1c1e7040d309af5a;hp=bed2692b2b37af3a58277e9e634ce84282b8a506;hpb=628c30e510dd0f12be4432bd5eb0ff86790c4de0;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index bed2692b..66207645 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,16 +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 { isMainThread } from 'node:worker_threads'; import chalk from 'chalk'; +import { availableParallelism } from 'poolifier'; -import { ChargingStationUtils } from './ChargingStationUtils'; +import { waitChargingStationEvents } from './Helpers'; import type { AbstractUIServer } from './ui-server/AbstractUIServer'; import { UIServerFactory } from './ui-server/UIServerFactory'; -import { version } from '../../package.json' assert { type: 'json' }; +import { version } from '../../package.json'; import { BaseError } from '../exception'; import { type Storage, StorageFactory } from '../performance'; import { @@ -19,16 +20,24 @@ 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 WorkerAbstract, WorkerFactory } from '../worker'; @@ -36,29 +45,30 @@ import { type WorkerAbstract, WorkerFactory } from '../worker'; const moduleName = 'Bootstrap'; enum exitCodes { + succeeded = 0, missingChargingStationsConfiguration = 1, noChargingStationTemplates = 2, + gracefulShutdownError = 3, } export class Bootstrap extends EventEmitter { private static instance: Bootstrap | null = null; public numberOfChargingStations!: number; public numberOfChargingStationTemplates!: number; - private workerImplementation: WorkerAbstract | null; - private readonly uiServer!: AbstractUIServer | null; - private readonly storage!: Storage; + private workerImplementation?: WorkerAbstract; + private readonly uiServer?: AbstractUIServer; + private storage?: Storage; 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); + process.on(signal, this.gracefulShutdown.bind(this)); } // Enable unconditionally for now handleUnhandledRejection(); @@ -68,20 +78,10 @@ export class Bootstrap extends EventEmitter { this.stopping = false; 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.uiServer = UIServerFactory.getUIServerImplementation( + Configuration.getConfigurationSection(ConfigurationSection.uiServer), ); - Configuration.getUIServer().enabled === true && - (this.uiServer = UIServerFactory.getUIServerImplementation(Configuration.getUIServer())); - Configuration.getPerformanceStorage().enabled === true && - (this.storage = StorageFactory.getStorage( - Configuration.getPerformanceStorage().type, - Configuration.getPerformanceStorage().uri, - this.logPrefix() - )); - Configuration.setConfigurationChangeCallback(async () => Bootstrap.getInstance().restart()); + Configuration.configurationChangeCallback = async () => Bootstrap.getInstance().restart(false); } public static getInstance(): Bootstrap { @@ -92,19 +92,38 @@ 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.on(ChargingStationWorkerMessageEvents.started, this.workerEventStarted); + this.on(ChargingStationWorkerMessageEvents.stopped, this.workerEventStopped); + this.on(ChargingStationWorkerMessageEvents.updated, this.workerEventUpdated); + this.on( + ChargingStationWorkerMessageEvents.performanceStatistics, + this.workerEventPerformanceStatistics, + ); this.initializeCounters(); - this.initializeWorkerImplementation(); + const workerConfiguration = Configuration.getConfigurationSection( + ConfigurationSection.worker, + ); + this.initializeWorkerImplementation(workerConfiguration); await this.workerImplementation?.start(); - await this.storage?.open(); - this.uiServer?.start(); + const performanceStorageConfiguration = + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ); + if (performanceStorageConfiguration.enabled === true) { + this.storage = StorageFactory.getStorage( + performanceStorageConfiguration.type!, + performanceStorageConfiguration.uri!, + this.logPrefix(), + ); + await this.storage?.open(); + } + 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++) { @@ -113,9 +132,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, ); } } @@ -125,19 +144,25 @@ 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; @@ -149,40 +174,30 @@ 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 Promise.race([ - ChargingStationUtils.waitForChargingStationEvents( - this, - ChargingStationWorkerMessageEvents.stopped, - this.numberOfChargingStations - ), - new Promise((resolve) => { - setTimeout(() => { - const message = `Timeout reached ${Utils.formatDurationMilliSeconds( - Constants.STOP_SIMULATOR_TIMEOUT - )} at stopping charging stations simulator`; - console.warn(chalk.yellow(message)); - resolve(message); - }, Constants.STOP_SIMULATOR_TIMEOUT); - }), - ]); + if (stopChargingStations === true) { + 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); + } + } await this.workerImplementation?.stop(); - this.workerImplementation = null; + delete this.workerImplementation; + this.removeAllListeners(); this.uiServer?.stop(); await this.storage?.close(); + delete this.storage; this.resetCounters(); this.initializedCounters = false; this.started = false; @@ -195,72 +210,117 @@ 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 { - this.workerImplementation === null && - (this.workerImplementation = WorkerFactory.getWorkerImplementation( - this.workerScript, - Configuration.getWorker().processType, - { - workerStartDelay: Configuration.getWorker().startDelay, - elementStartDelay: Configuration.getWorker().elementStartDelay, - poolMaxSize: Configuration.getWorker().poolMaxSize, - poolMinSize: Configuration.getWorker().poolMinSize, - elementsPerWorker: Configuration.getWorker().elementsPerWorker, - poolOptions: { - workerChoiceStrategy: Configuration.getWorker().poolStrategy, - messageHandler: this.messageHandler.bind(this) as (message: unknown) => void, - }, - } - )); + private async waitChargingStationsStopped(): Promise { + return new Promise((resolve, reject) => { + const waitTimeout = setTimeout(() => { + const message = `Timeout ${formatDurationMilliSeconds( + Constants.STOP_CHARGING_STATIONS_TIMEOUT, + )} reached at stopping charging stations`; + console.warn(chalk.yellow(message)); + reject(new Error(message)); + }, Constants.STOP_CHARGING_STATIONS_TIMEOUT); + waitChargingStationEvents( + this, + ChargingStationWorkerMessageEvents.stopped, + this.numberOfChargingStations, + ) + .then(() => { + resolve('Charging stations stopped'); + }) + .catch(reject) + .finally(() => { + clearTimeout(waitTimeout); + }); + }); + } + + private initializeWorkerImplementation(workerConfiguration: WorkerConfiguration): void { + let elementsPerWorker: number | undefined; + switch (workerConfiguration?.elementsPerWorker) { + case 'auto': + elementsPerWorker = + this.numberOfChargingStations > availableParallelism() + ? Math.round(this.numberOfChargingStations / (availableParallelism() * 1.5)) + : 1; + break; + case 'all': + elementsPerWorker = this.numberOfChargingStations; + break; + } + this.workerImplementation = WorkerFactory.getWorkerImplementation( + join( + dirname(fileURLToPath(import.meta.url)), + `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`, + ), + workerConfiguration.processType!, + { + workerStartDelay: workerConfiguration.startDelay, + elementStartDelay: workerConfiguration.elementStartDelay, + poolMaxSize: workerConfiguration.poolMaxSize!, + poolMinSize: workerConfiguration.poolMinSize!, + elementsPerWorker: elementsPerWorker ?? (workerConfiguration.elementsPerWorker as number), + poolOptions: { + messageHandler: this.messageHandler.bind(this) as (message: unknown) => void, + workerOptions: { resourceLimits: workerConfiguration.resourceLimits }, + }, + }, + ); } 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); break; case ChargingStationWorkerMessageEvents.stopped: - this.workerEventStopped(msg.data as ChargingStationData); this.emit(ChargingStationWorkerMessageEvents.stopped, msg.data as ChargingStationData); break; case ChargingStationWorkerMessageEvents.updated: - this.workerEventUpdated(msg.data as ChargingStationData); this.emit(ChargingStationWorkerMessageEvents.updated, msg.data as ChargingStationData); break; case ChargingStationWorkerMessageEvents.performanceStatistics: - 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, ); } } @@ -273,7 +333,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) started (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -285,7 +345,7 @@ export class Bootstrap extends EventEmitter { data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) stopped (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfChargingStations})`, ); }; @@ -294,29 +354,29 @@ export class Bootstrap extends EventEmitter { }; private workerEventPerformanceStatistics = (data: Statistics) => { - this.storage.storePerformanceStatistics(data) as void; + this.storage?.storePerformanceStatistics(data) as void; }; 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; } @@ -330,32 +390,39 @@ 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(() => { + exit(exitCodes.gracefulShutdownError); + }); }) .catch((error) => { console.error(chalk.red('Error while shutdowning charging stations simulator: '), error); - process.exit(1); + exit(exitCodes.gracefulShutdownError); }); - }; + } private logPrefix = (): string => { - return Utils.logPrefix(' Bootstrap |'); + return logPrefix(' Bootstrap |'); }; }