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