Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
c8eeb62b | 2 | |
962a8159 | 3 | import EventEmitterAsyncResource from 'node:events'; |
01f4001e | 4 | import { Worker } from 'node:worker_threads'; |
c045d9a9 | 5 | |
268a74bb | 6 | import { WorkerAbstract } from './WorkerAbstract'; |
59b6ed8d | 7 | import { WorkerConstants } from './WorkerConstants'; |
0e4fa348 JB |
8 | import { |
9 | type MessageHandler, | |
b779c0f8 | 10 | type SetInfo, |
0e4fa348 JB |
11 | type WorkerData, |
12 | WorkerMessageEvents, | |
13 | type WorkerOptions, | |
14 | type WorkerSetElement, | |
810f4caf | 15 | WorkerSetEvents, |
268a74bb | 16 | } from './WorkerTypes'; |
789871d6 | 17 | import { defaultErrorHandler, defaultExitHandler, sleep } from './WorkerUtils'; |
6013bc53 | 18 | |
268a74bb | 19 | export class WorkerSet extends WorkerAbstract<WorkerData> { |
962a8159 | 20 | public readonly emitter: EventEmitterAsyncResource; |
f2bf9948 | 21 | private readonly workerSet: Set<WorkerSetElement>; |
6013bc53 JB |
22 | |
23 | /** | |
24 | * Create a new `WorkerSet`. | |
25 | * | |
0e4fa348 JB |
26 | * @param workerScript - |
27 | * @param workerOptions - | |
6013bc53 | 28 | */ |
4d7227e6 JB |
29 | constructor(workerScript: string, workerOptions?: WorkerOptions) { |
30 | super(workerScript, workerOptions); | |
ffd71f2c | 31 | this.workerSet = new Set<WorkerSetElement>(); |
962a8159 | 32 | this.emitter = new EventEmitterAsyncResource(); |
6013bc53 JB |
33 | } |
34 | ||
b779c0f8 JB |
35 | get info(): SetInfo { |
36 | return { | |
37 | size: this.size, | |
38 | runningElements: [...this.workerSet].reduce( | |
39 | (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements, | |
40 | 0 | |
41 | ), | |
42 | elementsPerWorker: this.maxElementsPerWorker, | |
43 | }; | |
44 | } | |
45 | ||
6013bc53 | 46 | get size(): number { |
ded13d97 | 47 | return this.workerSet.size; |
6013bc53 JB |
48 | } |
49 | ||
72092cfc | 50 | get maxElementsPerWorker(): number | undefined { |
4d7227e6 JB |
51 | return this.workerOptions.elementsPerWorker; |
52 | } | |
53 | ||
b0dee778 JB |
54 | /** @inheritDoc */ |
55 | public async start(): Promise<void> { | |
56 | this.addWorkerSetElement(); | |
57 | // Add worker set element sequentially to optimize memory at startup | |
58 | this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay)); | |
59 | } | |
60 | ||
61 | /** @inheritDoc */ | |
62 | public async stop(): Promise<void> { | |
63 | for (const workerSetElement of this.workerSet) { | |
64 | await workerSetElement.worker.terminate(); | |
65 | } | |
66 | this.workerSet.clear(); | |
67 | } | |
68 | ||
8baf3f8f | 69 | /** @inheritDoc */ |
c3ee95af | 70 | public async addElement(elementData: WorkerData): Promise<void> { |
ded13d97 | 71 | if (!this.workerSet) { |
e7aeea18 | 72 | throw new Error("Cannot add a WorkerSet element: workers' set does not exist"); |
6013bc53 | 73 | } |
962a8159 JB |
74 | const workerSetElement = await this.getWorkerSetElement(); |
75 | workerSetElement.worker.postMessage({ | |
721646e9 | 76 | id: WorkerMessageEvents.startWorkerElement, |
e7aeea18 | 77 | data: elementData, |
d070d967 | 78 | }); |
962a8159 JB |
79 | ++workerSetElement.numberOfWorkerElements; |
80 | // Add element sequentially to optimize memory at startup | |
d070d967 | 81 | if (this.workerOptions.elementStartDelay > 0) { |
789871d6 | 82 | await sleep(this.workerOptions.elementStartDelay); |
d070d967 | 83 | } |
6013bc53 JB |
84 | } |
85 | ||
6013bc53 | 86 | /** |
962a8159 | 87 | * Add a new `WorkerSetElement`. |
6013bc53 | 88 | */ |
962a8159 | 89 | private addWorkerSetElement(): WorkerSetElement { |
a4624c96 | 90 | const worker = new Worker(this.workerScript); |
0e4fa348 JB |
91 | worker.on( |
92 | 'message', | |
59b6ed8d JB |
93 | (this.workerOptions?.messageHandler ?? WorkerConstants.EMPTY_FUNCTION).bind( |
94 | this | |
95 | ) as MessageHandler<Worker> | |
0e4fa348 | 96 | ); |
789871d6 | 97 | worker.on('error', defaultErrorHandler.bind(this) as (err: Error) => void); |
962a8159 | 98 | worker.on('error', (error) => { |
810f4caf | 99 | this.emitter.emit(WorkerSetEvents.error, error); |
962a8159 JB |
100 | this.addWorkerSetElement(); |
101 | }); | |
8baf3f8f JB |
102 | worker.on('exit', defaultExitHandler.bind(this) as (exitCode: number) => void); |
103 | worker.on('exit', () => this.workerSet.delete(this.getWorkerSetElementByWorker(worker))); | |
962a8159 JB |
104 | const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 }; |
105 | this.workerSet.add(workerSetElement); | |
106 | return workerSetElement; | |
6013bc53 JB |
107 | } |
108 | ||
962a8159 JB |
109 | private async getWorkerSetElement(): Promise<WorkerSetElement> { |
110 | let chosenWorkerSetElement: WorkerSetElement; | |
111 | for (const workerSetElement of this.workerSet) { | |
112 | if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker) { | |
113 | chosenWorkerSetElement = workerSetElement; | |
114 | break; | |
115 | } | |
e7aeea18 | 116 | } |
962a8159 JB |
117 | if (!chosenWorkerSetElement) { |
118 | chosenWorkerSetElement = this.addWorkerSetElement(); | |
119 | // Add worker set element sequentially to optimize memory at startup | |
120 | this.workerOptions.workerStartDelay > 0 && (await sleep(this.workerOptions.workerStartDelay)); | |
121 | } | |
122 | return chosenWorkerSetElement; | |
c045d9a9 JB |
123 | } |
124 | ||
962a8159 | 125 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined { |
1e924543 | 126 | let workerSetElt: WorkerSetElement; |
0e7a11e1 | 127 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 128 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 129 | workerSetElt = workerSetElement; |
0e7a11e1 | 130 | break; |
1e924543 | 131 | } |
0e7a11e1 | 132 | } |
1e924543 JB |
133 | return workerSetElt; |
134 | } | |
6013bc53 | 135 | } |