X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2FWorkerSet.ts;h=96a9901d96e5633cf85c786ab541ed98f992b67a;hb=0bde1ea1ef9f72552609d6314d0533d565a09aba;hp=81a6b05fdc3f1898c73cb99b18ed4a7f1bbf85a3;hpb=5767874516784070db4445321b5212ad7e5a84b4;p=e-mobility-charging-stations-simulator.git diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts index 81a6b05f..96a9901d 100644 --- a/src/worker/WorkerSet.ts +++ b/src/worker/WorkerSet.ts @@ -1,68 +1,74 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -import { WorkerData, WorkerMessageEvents, WorkerOptions, WorkerSetElement } from '../types/Worker'; +import EventEmitterAsyncResource from 'node:events'; +import { SHARE_ENV, Worker } from 'node:worker_threads'; -import Utils from '../utils/Utils'; -import { Worker } from 'worker_threads'; -import WorkerAbstract from './WorkerAbstract'; -import { WorkerUtils } from './WorkerUtils'; +import { WorkerAbstract } from './WorkerAbstract'; +import { WorkerConstants } from './WorkerConstants'; +import { + type SetInfo, + type WorkerData, + WorkerMessageEvents, + type WorkerOptions, + type WorkerSetElement, + WorkerSetEvents, +} from './WorkerTypes'; +import { sleep } from './WorkerUtils'; -export default class WorkerSet extends WorkerAbstract { +export class WorkerSet extends WorkerAbstract { + public readonly emitter: EventEmitterAsyncResource; private readonly workerSet: Set; - private readonly messageHandler: (message: unknown) => void | Promise; /** * Create a new `WorkerSet`. * - * @param workerScript - * @param workerOptions + * @param workerScript - + * @param workerOptions - */ constructor(workerScript: string, workerOptions?: WorkerOptions) { super(workerScript, workerOptions); + this.workerOptions.poolOptions = { + ...{ + enableEvents: true, + restartWorkerOnError: true, + }, + ...this.workerOptions.poolOptions, + }; this.workerSet = new Set(); - this.messageHandler = workerOptions?.messageHandler ?? (() => { /* This is intentional */ }); + if (this.workerOptions?.poolOptions?.enableEvents) { + this.emitter = new EventEmitterAsyncResource(); + } + } + + get info(): SetInfo { + return { + type: 'set', + worker: 'thread', + size: this.size, + elementsExecuting: [...this.workerSet].reduce( + (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements, + 0 + ), + elementsPerWorker: this.maxElementsPerWorker, + }; } get size(): number { return this.workerSet.size; } - get maxElementsPerWorker(): number | null { + get maxElementsPerWorker(): number | undefined { 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.getLastWorkerSetElement().numberOfWorkerElements >= this.workerOptions.elementsPerWorker) { - await this.startWorker(); - } - this.getLastWorker().postMessage({ id: WorkerMessageEvents.START_WORKER_ELEMENT, data: elementData }); - this.getLastWorkerSetElement().numberOfWorkerElements++; - this.workerOptions.elementStartDelay > 0 && await Utils.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) { await workerSetElement.worker.terminate(); @@ -70,38 +76,78 @@ export default class WorkerSet extends WorkerAbstract { 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); + } + } + /** - * - * @private + * Add a new `WorkerSetElement`. */ - private async startWorker(): Promise { - const worker = new Worker(this.workerScript); - worker.on('message', (msg) => { - (async () => { - await this.messageHandler(msg); - })().catch(() => { /* This is intentional */ }); + private addWorkerSetElement(): WorkerSetElement { + const worker = new Worker(this.workerScript, { + env: SHARE_ENV, + ...this.workerOptions.poolOptions.workerOptions, }); - worker.on('error', () => { /* This is intentional */ }); - worker.on('exit', (code) => { - WorkerUtils.defaultExitHandler(code); - this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); + worker.on( + 'message', + this.workerOptions?.poolOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION + ); + worker.on( + 'error', + this.workerOptions?.poolOptions?.errorHandler ?? WorkerConstants.EMPTY_FUNCTION + ); + worker.on('error', (error) => { + if (this.emitter !== undefined) { + 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 Utils.sleep(this.workerOptions.workerStartDelay); - } - - private getLastWorkerSetElement(): WorkerSetElement { - let workerSetElement: WorkerSetElement; - for (workerSetElement of this.workerSet) { /* This is intentional */ } + worker.on( + 'online', + this.workerOptions?.poolOptions?.onlineHandler ?? WorkerConstants.EMPTY_FUNCTION + ); + worker.on( + 'exit', + this.workerOptions?.poolOptions?.exitHandler ?? WorkerConstants.EMPTY_FUNCTION + ); + worker.once('exit', () => this.workerSet.delete(this.getWorkerSetElementByWorker(worker))); + const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 }; + this.workerSet.add(workerSetElement); return workerSetElement; } - private getLastWorker(): Worker { - return this.getLastWorkerSetElement().worker; + private async getWorkerSetElement(): Promise { + let chosenWorkerSetElement: WorkerSetElement; + 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 { + private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined { let workerSetElt: WorkerSetElement; for (const workerSetElement of this.workerSet) { if (workerSetElement.worker.threadId === worker.threadId) {