-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
+import { EventEmitter } from 'node:events';
+import { dirname, extname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { 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' assert { type: 'json' };
+import { BaseError } from '../exception';
+import { type Storage, StorageFactory } from '../performance';
import {
- ChargingStationWorkerData,
- ChargingStationWorkerMessage,
+ type ChargingStationData,
+ type ChargingStationWorkerData,
+ type ChargingStationWorkerMessage,
+ type ChargingStationWorkerMessageData,
ChargingStationWorkerMessageEvents,
-} from '../types/ChargingStationWorker';
-
-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 { UIServiceUtils } from './ui-websocket-services/UIServiceUtils';
-import UIWebSocketServer from './UIWebSocketServer';
-import Utils from '../utils/Utils';
-import WorkerAbstract from '../worker/WorkerAbstract';
-import WorkerFactory from '../worker/WorkerFactory';
-import chalk from 'chalk';
-import { isMainThread } from 'worker_threads';
-import path from 'path';
-import { version } from '../../package.json';
+ ProcedureName,
+ type StationTemplateUrl,
+ type Statistics,
+} from '../types';
+import {
+ Configuration,
+ Constants,
+ formatDurationMilliSeconds,
+ generateUUID,
+ handleUncaughtException,
+ handleUnhandledRejection,
+ isNotEmptyArray,
+ isNullOrUndefined,
+ logPrefix,
+ logger,
+} from '../utils';
+import { type WorkerAbstract, WorkerFactory } from '../worker';
-export default class Bootstrap {
+const moduleName = 'Bootstrap';
+
+enum exitCodes {
+ missingChargingStationsConfiguration = 1,
+ noChargingStationTemplates = 2,
+}
+
+export class Bootstrap extends EventEmitter {
private static instance: Bootstrap | null = null;
- private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null = null;
- private readonly uiWebSocketServer!: UIWebSocketServer;
+ public numberOfChargingStations!: number;
+ public numberOfChargingStationTemplates!: number;
+ private workerImplementation: WorkerAbstract<ChargingStationWorkerData> | null;
+ private readonly uiServer!: AbstractUIServer | null;
private readonly storage!: Storage;
- private numberOfChargingStations: number;
+ 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);
+ }
+ // Enable unconditionally for now
+ handleUnhandledRejection();
+ handleUncaughtException();
this.started = false;
- this.workerScript = path.join(
- path.resolve(__dirname, '../'),
- 'charging-station',
- 'ChargingStationWorker.js'
+ this.starting = false;
+ this.stopping = false;
+ this.initializedCounters = false;
+ this.initializeCounters();
+ this.workerImplementation = null;
+ this.workerScript = join(
+ dirname(fileURLToPath(import.meta.url)),
+ `ChargingStationWorker${extname(fileURLToPath(import.meta.url))}`
);
- this.initWorkerImplementation();
- Configuration.getUIWebSocketServer().enabled &&
- (this.uiWebSocketServer = new UIWebSocketServer({
- ...Configuration.getUIWebSocketServer().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,
}
public static getInstance(): Bootstrap {
- if (!Bootstrap.instance) {
+ if (Bootstrap.instance === null) {
Bootstrap.instance = new Bootstrap();
}
return Bootstrap.instance;
}
public async start(): Promise<void> {
- if (isMainThread && !this.started) {
- try {
- this.numberOfChargingStations = 0;
+ 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();
+ await this.workerImplementation?.start();
await this.storage?.open();
- await this.workerImplementation.start();
- this.uiWebSocketServer?.start();
- const stationTemplateUrls = Configuration.getStationTemplateUrls();
- // Start ChargingStation object in worker thread
- if (stationTemplateUrls) {
- 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.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
+ );
}
- } else {
- console.warn(chalk.yellow("No 'stationTemplateUrls' defined in configuration, exiting"));
- }
- if (this.numberOfChargingStations === 0) {
- console.warn(
- chalk.yellow('No charging station template enabled in configuration, exiting')
- );
- } else {
- console.log(
- chalk.green(
- `Charging stations simulator ${
- this.version
- } started with ${this.numberOfChargingStations.toString()} charging station(s) and ${
- Utils.workerDynamicPoolInUse()
- ? `${Configuration.getWorkerPoolMinSize().toString()}/`
- : ''
- }${this.workerImplementation.size}${
- Utils.workerPoolInUse() ? `/${Configuration.getWorkerPoolMaxSize().toString()}` : ''
- } worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${
- this.workerImplementation.maxElementsPerWorker
- ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)`
- : ''
- }`
- )
- );
}
+ 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${
+ !isNullOrUndefined(this.workerImplementation?.maxElementsPerWorker)
+ ? ` (${this.workerImplementation?.maxElementsPerWorker} charging station(s) per worker)`
+ : ''
+ }`
+ )
+ );
+ console.info(chalk.green('Worker set/pool information:'), this.workerImplementation?.info);
this.started = true;
- } catch (error) {
- console.error(chalk.red('Bootstrap start error '), error);
+ this.starting = false;
+ } else {
+ console.error(chalk.red('Cannot start an already starting charging stations simulator'));
}
} else {
console.error(chalk.red('Cannot start an already started charging stations simulator'));
}
public async stop(): Promise<void> {
- if (isMainThread && this.started) {
- await this.workerImplementation.stop();
- this.uiWebSocketServer?.stop();
- await this.storage?.close();
+ if (!isMainThread) {
+ throw new Error('Cannot stop charging stations simulator from worker thread');
+ }
+ if (this.started === true) {
+ if (this.stopping === false) {
+ this.stopping = true;
+ await this.uiServer?.sendInternalRequest(
+ this.uiServer.buildProtocolRequest(
+ generateUUID(),
+ ProcedureName.STOP_CHARGING_STATION,
+ Constants.EMPTY_FREEZED_OBJECT
+ )
+ );
+ await Promise.race([
+ ChargingStationUtils.waitForChargingStationEvents(
+ this,
+ ChargingStationWorkerMessageEvents.stopped,
+ this.numberOfChargingStations
+ ),
+ new Promise<string>((resolve) => {
+ setTimeout(() => {
+ const message = `Timeout reached ${formatDurationMilliSeconds(
+ Constants.STOP_SIMULATOR_TIMEOUT
+ )} at stopping charging stations simulator`;
+ console.warn(chalk.yellow(message));
+ resolve(message);
+ }, Constants.STOP_SIMULATOR_TIMEOUT);
+ }),
+ ]);
+ await this.workerImplementation?.stop();
+ this.workerImplementation = null;
+ this.uiServer?.stop();
+ await this.storage?.close();
+ this.resetCounters();
+ this.initializedCounters = false;
+ this.started = false;
+ this.stopping = false;
+ } else {
+ console.error(chalk.red('Cannot stop an already stopping charging stations simulator'));
+ }
} else {
- console.error(chalk.red('Trying to stop the charging stations simulator while not started'));
+ console.error(chalk.red('Cannot stop an already stopped charging stations simulator'));
}
- this.started = false;
}
public async restart(): Promise<void> {
await this.stop();
- this.initWorkerImplementation();
await this.start();
}
- private initWorkerImplementation(): void {
- this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
- this.workerScript,
- Configuration.getWorkerProcess(),
- {
- workerStartDelay: Configuration.getWorkerStartDelay(),
- elementStartDelay: Configuration.getElementStartDelay(),
- poolMaxSize: Configuration.getWorkerPoolMaxSize(),
- poolMinSize: Configuration.getWorkerPoolMinSize(),
- elementsPerWorker: Configuration.getChargingStationsPerWorker(),
- poolOptions: {
- workerChoiceStrategy: Configuration.getWorkerPoolStrategy(),
- },
- messageHandler: async (msg: ChargingStationWorkerMessage) => {
- if (msg.id === ChargingStationWorkerMessageEvents.STARTED) {
- this.uiWebSocketServer.chargingStations.add(msg.data.id as string);
- } else if (msg.id === ChargingStationWorkerMessageEvents.STOPPED) {
- this.uiWebSocketServer.chargingStations.delete(msg.data.id as string);
- } else if (msg.id === ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS) {
- await this.storage.storePerformanceStatistics(msg.data as unknown as Statistics);
- }
- },
+ private initializeWorkerImplementation(): void {
+ this.workerImplementation === null &&
+ (this.workerImplementation = WorkerFactory.getWorkerImplementation<ChargingStationWorkerData>(
+ 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 messageHandler(
+ msg: ChargingStationWorkerMessage<ChargingStationWorkerMessageData>
+ ): 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);
+ 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
+ );
+ 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 initializeCounters() {
+ if (this.initializedCounters === false) {
+ this.resetCounters();
+ 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")
+ );
+ 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.initializedCounters = true;
+ }
+ }
+
+ private resetCounters(): void {
+ this.numberOfChargingStationTemplates = 0;
+ this.numberOfChargingStations = 0;
+ this.numberOfStartedChargingStations = 0;
}
private async startChargingStation(
index: number,
stationTemplateUrl: StationTemplateUrl
): Promise<void> {
- const workerData: ChargingStationWorkerData = {
+ await this.workerImplementation?.addElement({
index,
- templateFile: path.join(
- path.resolve(__dirname, '../'),
+ templateFile: join(
+ dirname(fileURLToPath(import.meta.url)),
'assets',
'station-templates',
- path.basename(stationTemplateUrl.file)
+ stationTemplateUrl.file
),
- };
- await this.workerImplementation.addElement(workerData);
- this.numberOfChargingStations++;
+ });
}
- private logPrefix(): string {
- return Utils.logPrefix(' Bootstrap |');
- }
+ private gracefulShutdown = (): void => {
+ console.info(`${chalk.green('Graceful shutdown')}`);
+ this.stop()
+ .then(() => {
+ process.exit(0);
+ })
+ .catch((error) => {
+ console.error(chalk.red('Error while shutdowning charging stations simulator: '), error);
+ process.exit(1);
+ });
+ };
+
+ private logPrefix = (): string => {
+ return logPrefix(' Bootstrap |');
+ };
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff