X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2FWorkerSet.ts;h=ce25e7e3a6e4ec3428072a05fc6e13d90e14c0fd;hb=4a3807d16c54137840a60af41877f3b21de12950;hp=b8507d53fe96d24898d418ae1006bfca7cdfddbf;hpb=59b6ed8d1db313ef3371efd8ab5e039cf3dedab0;p=e-mobility-charging-stations-simulator.git diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts index b8507d53..ce25e7e3 100644 --- a/src/worker/WorkerSet.ts +++ b/src/worker/WorkerSet.ts @@ -1,30 +1,61 @@ // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -import { Worker } from 'node:worker_threads'; +import { EventEmitter } from 'node:events'; +import { SHARE_ENV, Worker } from 'node:worker_threads'; + +import type { ThreadPoolOptions } from 'poolifier'; import { WorkerAbstract } from './WorkerAbstract'; import { WorkerConstants } from './WorkerConstants'; import { - type MessageHandler, + type SetInfo, type WorkerData, WorkerMessageEvents, type WorkerOptions, type WorkerSetElement, + WorkerSetEvents, } from './WorkerTypes'; -import { WorkerUtils } from './WorkerUtils'; +import { sleep } from './WorkerUtils'; + +const DEFAULT_POOL_OPTIONS: ThreadPoolOptions = { + enableEvents: true, + restartWorkerOnError: true, +}; export class WorkerSet extends WorkerAbstract { + public readonly emitter!: EventEmitter; private readonly workerSet: Set; /** - * Create a new `WorkerSet`. + * Creates a new `WorkerSet`. * * @param workerScript - * @param workerOptions - */ - constructor(workerScript: string, workerOptions?: WorkerOptions) { + constructor(workerScript: string, workerOptions: WorkerOptions) { super(workerScript, workerOptions); + this.workerOptions.poolOptions = { + ...DEFAULT_POOL_OPTIONS, + ...this.workerOptions.poolOptions, + }; this.workerSet = new Set(); + if (this.workerOptions.poolOptions?.enableEvents) { + this.emitter = new EventEmitter(); + } + } + + get info(): SetInfo { + return { + version: WorkerConstants.version, + type: 'set', + worker: 'thread', + size: this.size, + elementsExecuting: [...this.workerSet].reduce( + (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements, + 0, + ), + elementsPerWorker: this.maxElementsPerWorker!, + }; } get size(): number { @@ -35,90 +66,105 @@ export class WorkerSet extends WorkerAbstract { return this.workerOptions.elementsPerWorker; } - /** - * - * @param elementData - - * @returns - * @public - */ - public async addElement(elementData: WorkerData): Promise { - if (!this.workerSet) { - throw new Error("Cannot add a WorkerSet element: workers' set does not exist"); - } - if ( - this.workerSet.size === 0 || - this.getLastWorkerSetElement().numberOfWorkerElements >= this.workerOptions.elementsPerWorker - ) { - await this.startWorker(); - } - this.getLastWorker().postMessage({ - id: WorkerMessageEvents.START_WORKER_ELEMENT, - data: elementData, - }); - this.getLastWorkerSetElement().numberOfWorkerElements++; - // Start element sequentially to optimize memory at startup - if (this.workerOptions.elementStartDelay > 0) { - await WorkerUtils.sleep(this.workerOptions.elementStartDelay); - } - } - - /** - * - * @returns - * @public - */ + /** @inheritDoc */ public async start(): Promise { - await this.startWorker(); + this.addWorkerSetElement(); + // Add worker set element sequentially to optimize memory at startup + this.workerOptions.workerStartDelay! > 0 && (await sleep(this.workerOptions.workerStartDelay!)); } - /** - * - * @returns - * @public - */ + /** @inheritDoc */ public async stop(): Promise { for (const workerSetElement of this.workerSet) { + const workerExitPromise = new Promise((resolve) => { + workerSetElement.worker.on('exit', () => { + resolve(); + }); + }); await workerSetElement.worker.terminate(); + await workerExitPromise; } this.workerSet.clear(); } + /** @inheritDoc */ + public async addElement(elementData: WorkerData): Promise { + if (!this.workerSet) { + throw new Error("Cannot add a WorkerSet element: workers' set does not exist"); + } + const workerSetElement = await this.getWorkerSetElement(); + workerSetElement.worker.postMessage({ + id: WorkerMessageEvents.startWorkerElement, + data: elementData, + }); + ++workerSetElement.numberOfWorkerElements; + // Add element sequentially to optimize memory at startup + if (this.workerOptions.elementStartDelay! > 0) { + await sleep(this.workerOptions.elementStartDelay!); + } + } + /** - * Start a new `Worker`. + * Adds a new `WorkerSetElement`. */ - private async startWorker(): Promise { - const worker = new Worker(this.workerScript); + private addWorkerSetElement(): WorkerSetElement { + const worker = new Worker(this.workerScript, { + env: SHARE_ENV, + ...this.workerOptions.poolOptions?.workerOptions, + }); worker.on( 'message', - (this.workerOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION).bind( - this - ) as MessageHandler + this.workerOptions.poolOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION, + ); + worker.on( + 'error', + this.workerOptions.poolOptions?.errorHandler ?? WorkerConstants.EMPTY_FUNCTION, ); - worker.on('error', WorkerUtils.defaultErrorHandler.bind(this) as (err: Error) => void); - worker.on('exit', (code) => { - WorkerUtils.defaultExitHandler(code); - this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); + worker.on('error', (error) => { + this.emitter?.emit(WorkerSetEvents.error, error); + if (this.workerOptions.poolOptions?.restartWorkerOnError) { + this.addWorkerSetElement(); + } }); - this.workerSet.add({ worker, numberOfWorkerElements: 0 }); - // Start worker sequentially to optimize memory at startup - this.workerOptions.workerStartDelay > 0 && - (await WorkerUtils.sleep(this.workerOptions.workerStartDelay)); + worker.on( + 'online', + this.workerOptions.poolOptions?.onlineHandler ?? WorkerConstants.EMPTY_FUNCTION, + ); + worker.on( + 'exit', + this.workerOptions.poolOptions?.exitHandler ?? WorkerConstants.EMPTY_FUNCTION, + ); + worker.once('exit', () => + this.removeWorkerSetElement(this.getWorkerSetElementByWorker(worker)!), + ); + const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 }; + this.workerSet.add(workerSetElement); + return workerSetElement; } - private getLastWorkerSetElement(): WorkerSetElement { - let workerSetElement: WorkerSetElement; - for (workerSetElement of this.workerSet) { - /* This is intentional */ - } - return workerSetElement; + private removeWorkerSetElement(workerSetElement: WorkerSetElement): void { + this.workerSet.delete(workerSetElement); } - private getLastWorker(): Worker { - return this.getLastWorkerSetElement().worker; + private async getWorkerSetElement(): Promise { + let chosenWorkerSetElement: WorkerSetElement | undefined; + for (const workerSetElement of this.workerSet) { + if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker!) { + chosenWorkerSetElement = workerSetElement; + break; + } + } + if (!chosenWorkerSetElement) { + chosenWorkerSetElement = this.addWorkerSetElement(); + // Add worker set element sequentially to optimize memory at startup + this.workerOptions.workerStartDelay! > 0 && + (await sleep(this.workerOptions.workerStartDelay!)); + } + return chosenWorkerSetElement; } - private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { - let workerSetElt: WorkerSetElement; + private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined { + let workerSetElt: WorkerSetElement | undefined; for (const workerSetElement of this.workerSet) { if (workerSetElement.worker.threadId === worker.threadId) { workerSetElt = workerSetElement;