X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcharging-station%2FBootstrap.ts;h=9247ab3deb5112925a4a7f8f215c31a5823712ff;hb=6027002ff1398a1cb3bb55d4994e4615efded2c0;hp=f09864d4ed66d935960084061359fe6ca7af3799;hpb=ba9a56a613727d96757690a8b52af6731f3fd8a8;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts index f09864d4..9247ab3d 100644 --- a/src/charging-station/Bootstrap.ts +++ b/src/charging-station/Bootstrap.ts @@ -1,9 +1,10 @@ // Partial Copyright Jerome Benoit. 2021-2024. All Rights Reserved. import { EventEmitter } from 'node:events' -import { dirname, extname, join } from 'node:path' +import { dirname, extname, join, parse } from 'node:path' import process, { exit } from 'node:process' import { fileURLToPath } from 'node:url' +import { isMainThread } from 'node:worker_threads' import type { Worker } from 'worker_threads' import chalk from 'chalk' @@ -17,13 +18,14 @@ import { BaseError } from '../exception/index.js' import { type Storage, StorageFactory } from '../performance/index.js' import { type ChargingStationData, + type ChargingStationOptions, type ChargingStationWorkerData, + type ChargingStationWorkerEventError, type ChargingStationWorkerMessage, type ChargingStationWorkerMessageData, ChargingStationWorkerMessageEvents, ConfigurationSection, ProcedureName, - type StationTemplateUrl, type Statistics, type StorageConfiguration, type UIServerConfiguration, @@ -48,23 +50,30 @@ const moduleName = 'Bootstrap' enum exitCodes { succeeded = 0, missingChargingStationsConfiguration = 1, - noChargingStationTemplates = 2, - gracefulShutdownError = 3 + duplicateChargingStationTemplateUrls = 2, + noChargingStationTemplates = 3, + gracefulShutdownError = 4 +} + +interface TemplateChargingStations { + configured: number + added: number + started: number + indexes: Set } export class Bootstrap extends EventEmitter { private static instance: Bootstrap | null = null - public numberOfChargingStations!: number - public numberOfChargingStationTemplates!: number private workerImplementation?: WorkerAbstract - private readonly uiServer?: AbstractUIServer + private readonly uiServer: AbstractUIServer private storage?: Storage - private numberOfStartedChargingStations!: number + private readonly templatesChargingStations: Map private readonly version: string = version private initializedCounters: boolean private started: boolean private starting: boolean private stopping: boolean + private uiServerStarted: boolean private constructor () { super() @@ -77,13 +86,17 @@ export class Bootstrap extends EventEmitter { this.started = false this.starting = false this.stopping = false - this.initializedCounters = false - this.initializeCounters() + this.uiServerStarted = false this.uiServer = UIServerFactory.getUIServerImplementation( Configuration.getConfigurationSection(ConfigurationSection.uiServer) ) + this.templatesChargingStations = new Map() + this.initializedCounters = false + this.initializeCounters() Configuration.configurationChangeCallback = async () => { - await Bootstrap.getInstance().restart(false) + if (isMainThread) { + await Bootstrap.getInstance().restart() + } } } @@ -94,10 +107,60 @@ export class Bootstrap extends EventEmitter { return Bootstrap.instance } + public get numberOfChargingStationTemplates (): number { + return this.templatesChargingStations.size + } + + public get numberOfConfiguredChargingStations (): number { + return [...this.templatesChargingStations.values()].reduce( + (accumulator, value) => accumulator + value.configured, + 0 + ) + } + + public getState (): { started: boolean } { + return { + started: this.started + } + } + + public getLastIndex (templateName: string): number { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const indexes = [...this.templatesChargingStations.get(templateName)!.indexes] + .concat(0) + .sort((a, b) => a - b) + for (let i = 0; i < indexes.length - 1; i++) { + if (indexes[i + 1] - indexes[i] !== 1) { + return indexes[i] + } + } + return indexes[indexes.length - 1] + } + + public getPerformanceStatistics (): IterableIterator | undefined { + return this.storage?.getPerformanceStatistics() + } + + private get numberOfAddedChargingStations (): number { + return [...this.templatesChargingStations.values()].reduce( + (accumulator, value) => accumulator + value.added, + 0 + ) + } + + private get numberOfStartedChargingStations (): number { + return [...this.templatesChargingStations.values()].reduce( + (accumulator, value) => accumulator + value.started, + 0 + ) + } + public async start (): Promise { if (!this.started) { if (!this.starting) { this.starting = true + this.on(ChargingStationWorkerMessageEvents.added, this.workerEventAdded) + this.on(ChargingStationWorkerMessageEvents.deleted, this.workerEventDeleted) this.on(ChargingStationWorkerMessageEvents.started, this.workerEventStarted) this.on(ChargingStationWorkerMessageEvents.stopped, this.workerEventStopped) this.on(ChargingStationWorkerMessageEvents.updated, this.workerEventUpdated) @@ -105,6 +168,15 @@ export class Bootstrap extends EventEmitter { ChargingStationWorkerMessageEvents.performanceStatistics, this.workerEventPerformanceStatistics ) + this.on( + ChargingStationWorkerMessageEvents.workerElementError, + (eventError: ChargingStationWorkerEventError) => { + logger.error( + `${this.logPrefix()} ${moduleName}.start: Error occurred while handling '${eventError.event}' event on worker:`, + eventError + ) + } + ) this.initializeCounters() const workerConfiguration = Configuration.getConfigurationSection( ConfigurationSection.worker @@ -125,15 +197,24 @@ export class Bootstrap extends EventEmitter { ) await this.storage?.open() } - Configuration.getConfigurationSection(ConfigurationSection.uiServer) - .enabled === true && this.uiServer?.start() + if ( + !this.uiServerStarted && + Configuration.getConfigurationSection( + ConfigurationSection.uiServer + ).enabled === true + ) { + this.uiServer.start() + this.uiServerStarted = true + } // Start ChargingStation object instance in worker thread // eslint-disable-next-line @typescript-eslint/no-non-null-assertion for (const stationTemplateUrl of Configuration.getStationTemplateUrls()!) { try { - const nbStations = stationTemplateUrl.numberOfStations + const nbStations = + this.templatesChargingStations.get(parse(stationTemplateUrl.file).name)?.configured ?? + stationTemplateUrl.numberOfStations for (let index = 1; index <= nbStations; index++) { - await this.startChargingStation(index, stationTemplateUrl) + await this.addChargingStation(index, stationTemplateUrl.file) } } catch (error) { console.error( @@ -148,14 +229,10 @@ export class Bootstrap extends EventEmitter { 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() - ? `${workerConfiguration.poolMinSize?.toString()}/` - : '' + } started with ${this.numberOfConfiguredChargingStations} configured charging station(s) from ${this.numberOfChargingStationTemplates} charging station template(s) and ${ + Configuration.workerDynamicPoolInUse() ? `${workerConfiguration.poolMinSize}/` : '' }${this.workerImplementation?.size}${ - Configuration.workerPoolInUse() - ? `/${workerConfiguration.poolMaxSize?.toString()}` - : '' + Configuration.workerPoolInUse() ? `/${workerConfiguration.poolMaxSize}` : '' } worker(s) concurrently running in '${workerConfiguration.processType}' mode${ this.workerImplementation?.maxElementsPerWorker != null ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)` @@ -180,31 +257,29 @@ export class Bootstrap extends EventEmitter { } } - public async stop (stopChargingStations = true): Promise { + public async stop (): Promise { if (this.started) { if (!this.stopping) { this.stopping = true - if (stopChargingStations) { - await this.uiServer?.sendInternalRequest( - this.uiServer.buildProtocolRequest( - generateUUID(), - ProcedureName.STOP_CHARGING_STATION, - Constants.EMPTY_FROZEN_OBJECT - ) + 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) - } + ) + try { + await this.waitChargingStationsStopped() + } catch (error) { + console.error(chalk.red('Error while waiting for charging stations to stop: '), error) } await this.workerImplementation?.stop() delete this.workerImplementation this.removeAllListeners() + this.uiServer.clearCaches() + this.initializedCounters = false await this.storage?.close() delete this.storage - this.resetCounters() - this.initializedCounters = false this.started = false this.stopping = false } else { @@ -215,10 +290,16 @@ export class Bootstrap extends EventEmitter { } } - public async restart (stopChargingStations?: boolean): Promise { - await this.stop(stopChargingStations) - Configuration.getConfigurationSection(ConfigurationSection.uiServer) - .enabled === false && this.uiServer?.stop() + private async restart (): Promise { + await this.stop() + if ( + this.uiServerStarted && + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled !== true + ) { + this.uiServer.stop() + this.uiServerStarted = false + } await this.start() } @@ -247,17 +328,21 @@ export class Bootstrap extends EventEmitter { } private initializeWorkerImplementation (workerConfiguration: WorkerConfiguration): void { - let elementsPerWorker: number | undefined + if (!isMainThread) { + return + } + let elementsPerWorker: number switch (workerConfiguration.elementsPerWorker) { + case 'all': + elementsPerWorker = this.numberOfConfiguredChargingStations + break case 'auto': + default: elementsPerWorker = - this.numberOfChargingStations > availableParallelism() - ? Math.round(this.numberOfChargingStations / (availableParallelism() * 1.5)) + this.numberOfConfiguredChargingStations > availableParallelism() + ? Math.round(this.numberOfConfiguredChargingStations / (availableParallelism() * 1.5)) : 1 break - case 'all': - elementsPerWorker = this.numberOfChargingStations - break } this.workerImplementation = WorkerFactory.getWorkerImplementation( join( @@ -273,7 +358,7 @@ export class Bootstrap extends EventEmitter { poolMaxSize: workerConfiguration.poolMaxSize!, // eslint-disable-next-line @typescript-eslint/no-non-null-assertion poolMinSize: workerConfiguration.poolMinSize!, - elementsPerWorker: elementsPerWorker ?? (workerConfiguration.elementsPerWorker as number), + elementsPerWorker, poolOptions: { messageHandler: this.messageHandler.bind(this) as MessageHandler, workerOptions: { resourceLimits: workerConfiguration.resourceLimits } @@ -294,29 +379,29 @@ export class Bootstrap extends EventEmitter { // ) try { switch (msg.event) { + case ChargingStationWorkerMessageEvents.added: + this.emit(ChargingStationWorkerMessageEvents.added, msg.data) + break + case ChargingStationWorkerMessageEvents.deleted: + this.emit(ChargingStationWorkerMessageEvents.deleted, msg.data) + break case ChargingStationWorkerMessageEvents.started: - this.emit(ChargingStationWorkerMessageEvents.started, msg.data as ChargingStationData) + this.emit(ChargingStationWorkerMessageEvents.started, msg.data) break case ChargingStationWorkerMessageEvents.stopped: - this.emit(ChargingStationWorkerMessageEvents.stopped, msg.data as ChargingStationData) + this.emit(ChargingStationWorkerMessageEvents.stopped, msg.data) break case ChargingStationWorkerMessageEvents.updated: - this.emit(ChargingStationWorkerMessageEvents.updated, msg.data as ChargingStationData) + this.emit(ChargingStationWorkerMessageEvents.updated, msg.data) break case ChargingStationWorkerMessageEvents.performanceStatistics: - this.emit( - ChargingStationWorkerMessageEvents.performanceStatistics, - msg.data as Statistics - ) + this.emit(ChargingStationWorkerMessageEvents.performanceStatistics, msg.data) break - case ChargingStationWorkerMessageEvents.startWorkerElementError: - logger.error( - `${this.logPrefix()} ${moduleName}.messageHandler: Error occured while starting worker element:`, - msg.data - ) - this.emit(ChargingStationWorkerMessageEvents.startWorkerElementError, msg.data) + case ChargingStationWorkerMessageEvents.addedWorkerElement: + this.emit(ChargingStationWorkerMessageEvents.addWorkerElement, msg.data) break - case ChargingStationWorkerMessageEvents.startedWorkerElement: + case ChargingStationWorkerMessageEvents.workerElementError: + this.emit(ChargingStationWorkerMessageEvents.workerElementError, msg.data) break default: throw new BaseError( @@ -335,32 +420,62 @@ export class Bootstrap extends EventEmitter { } } + private readonly workerEventAdded = (data: ChargingStationData): void => { + this.uiServer.chargingStations.set(data.stationInfo.hashId, data) + logger.info( + `${this.logPrefix()} ${moduleName}.workerEventAdded: Charging station ${ + data.stationInfo.chargingStationId + } (hashId: ${data.stationInfo.hashId}) added (${ + this.numberOfAddedChargingStations + } added from ${this.numberOfConfiguredChargingStations} configured charging station(s))` + ) + } + + private readonly workerEventDeleted = (data: ChargingStationData): void => { + this.uiServer.chargingStations.delete(data.stationInfo.hashId) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const templateChargingStations = this.templatesChargingStations.get( + data.stationInfo.templateName + )! + --templateChargingStations.added + templateChargingStations.indexes.delete(data.stationInfo.templateIndex) + logger.info( + `${this.logPrefix()} ${moduleName}.workerEventDeleted: Charging station ${ + data.stationInfo.chargingStationId + } (hashId: ${data.stationInfo.hashId}) deleted (${ + this.numberOfAddedChargingStations + } added from ${this.numberOfConfiguredChargingStations} configured charging station(s))` + ) + } + private readonly workerEventStarted = (data: ChargingStationData): void => { - this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) - ++this.numberOfStartedChargingStations + this.uiServer.chargingStations.set(data.stationInfo.hashId, data) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + ++this.templatesChargingStations.get(data.stationInfo.templateName)!.started logger.info( `${this.logPrefix()} ${moduleName}.workerEventStarted: Charging station ${ data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) started (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfAddedChargingStations} added charging station(s))` ) } private readonly workerEventStopped = (data: ChargingStationData): void => { - this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) - --this.numberOfStartedChargingStations + this.uiServer.chargingStations.set(data.stationInfo.hashId, data) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + --this.templatesChargingStations.get(data.stationInfo.templateName)!.started logger.info( `${this.logPrefix()} ${moduleName}.workerEventStopped: Charging station ${ data.stationInfo.chargingStationId } (hashId: ${data.stationInfo.hashId}) stopped (${ this.numberOfStartedChargingStations - } started from ${this.numberOfChargingStations})` + } started from ${this.numberOfAddedChargingStations} added charging station(s))` ) } private readonly workerEventUpdated = (data: ChargingStationData): void => { - this.uiServer?.chargingStations.set(data.stationInfo.hashId, data) + this.uiServer.chargingStations.set(data.stationInfo.hashId, data) } private readonly workerEventPerformanceStatistics = (data: Statistics): void => { @@ -380,37 +495,53 @@ export class Bootstrap extends EventEmitter { private initializeCounters (): void { if (!this.initializedCounters) { - this.resetCounters() // eslint-disable-next-line @typescript-eslint/no-non-null-assertion const stationTemplateUrls = Configuration.getStationTemplateUrls()! if (isNotEmptyArray(stationTemplateUrls)) { - this.numberOfChargingStationTemplates = stationTemplateUrls.length for (const stationTemplateUrl of stationTemplateUrls) { - this.numberOfChargingStations += stationTemplateUrl.numberOfStations + const templateName = parse(stationTemplateUrl.file).name + this.templatesChargingStations.set(templateName, { + configured: stationTemplateUrl.numberOfStations, + added: 0, + started: 0, + indexes: new Set() + }) + this.uiServer.chargingStationTemplates.add(templateName) + } + if (this.templatesChargingStations.size !== stationTemplateUrls.length) { + console.error( + chalk.red( + "'stationTemplateUrls' contains duplicate entries, please check your configuration" + ) + ) + exit(exitCodes.duplicateChargingStationTemplateUrls) } } else { - console.warn( - chalk.yellow("'stationTemplateUrls' not defined or empty in configuration, exiting") + console.error( + chalk.red("'stationTemplateUrls' not defined or empty, please check your configuration") ) exit(exitCodes.missingChargingStationsConfiguration) } - if (this.numberOfChargingStations === 0) { - console.warn(chalk.yellow('No charging station template enabled in configuration, exiting')) + if ( + this.numberOfConfiguredChargingStations === 0 && + Configuration.getConfigurationSection(ConfigurationSection.uiServer) + .enabled !== true + ) { + console.error( + chalk.red( + "'stationTemplateUrls' has no charging station enabled and UI server is disabled, please check your configuration" + ) + ) exit(exitCodes.noChargingStationTemplates) } this.initializedCounters = true } } - private resetCounters (): void { - this.numberOfChargingStationTemplates = 0 - this.numberOfChargingStations = 0 - this.numberOfStartedChargingStations = 0 - } - - private async startChargingStation ( + public async addChargingStation ( index: number, - stationTemplateUrl: StationTemplateUrl + stationTemplateFile: string, + options?: ChargingStationOptions ): Promise { await this.workerImplementation?.addElement({ index, @@ -418,17 +549,24 @@ export class Bootstrap extends EventEmitter { dirname(fileURLToPath(import.meta.url)), 'assets', 'station-templates', - stationTemplateUrl.file - ) + stationTemplateFile + ), + options }) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const templateChargingStations = this.templatesChargingStations.get( + parse(stationTemplateFile).name + )! + ++templateChargingStations.added + templateChargingStations.indexes.add(index) } private gracefulShutdown (): void { this.stop() .then(() => { console.info(chalk.green('Graceful shutdown')) - this.uiServer?.stop() - // stop() asks for charging stations to stop by default + this.uiServer.stop() + this.uiServerStarted = false this.waitChargingStationsStopped() .then(() => { exit(exitCodes.succeeded)