Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
8114d10e | 3 | import { Worker } from 'worker_threads'; |
c045d9a9 | 4 | |
0e4fa348 JB |
5 | import { |
6 | type MessageHandler, | |
7 | type WorkerData, | |
8 | WorkerMessageEvents, | |
9 | type WorkerOptions, | |
10 | type WorkerSetElement, | |
11 | } from '../types/Worker'; | |
6013bc53 | 12 | import Utils from '../utils/Utils'; |
fd1fdf1b | 13 | import WorkerAbstract from './WorkerAbstract'; |
7874b0b1 | 14 | import { WorkerUtils } from './WorkerUtils'; |
6013bc53 | 15 | |
c3ee95af | 16 | export default 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 | ||
4d7227e6 JB |
34 | get maxElementsPerWorker(): number | null { |
35 | return this.workerOptions.elementsPerWorker; | |
36 | } | |
37 | ||
6013bc53 JB |
38 | /** |
39 | * | |
0e4fa348 | 40 | * @param elementData - |
81797102 | 41 | * @returns |
6013bc53 JB |
42 | * @public |
43 | */ | |
c3ee95af | 44 | public async addElement(elementData: WorkerData): Promise<void> { |
ded13d97 | 45 | if (!this.workerSet) { |
e7aeea18 | 46 | throw new Error("Cannot add a WorkerSet element: workers' set does not exist"); |
6013bc53 | 47 | } |
e7aeea18 | 48 | if ( |
c1cee602 | 49 | this.workerSet.size === 0 || |
e7aeea18 JB |
50 | this.getLastWorkerSetElement().numberOfWorkerElements >= this.workerOptions.elementsPerWorker |
51 | ) { | |
4581acf3 | 52 | await this.startWorker(); |
6013bc53 | 53 | } |
d070d967 JB |
54 | this.getLastWorker().postMessage({ |
55 | id: WorkerMessageEvents.START_WORKER_ELEMENT, | |
e7aeea18 | 56 | data: elementData, |
d070d967 | 57 | }); |
c045d9a9 | 58 | this.getLastWorkerSetElement().numberOfWorkerElements++; |
d070d967 JB |
59 | // Start element sequentially to optimize memory at startup |
60 | if (this.workerOptions.elementStartDelay > 0) { | |
61 | await Utils.sleep(this.workerOptions.elementStartDelay); | |
62 | } | |
6013bc53 JB |
63 | } |
64 | ||
65 | /** | |
66 | * | |
81797102 | 67 | * @returns |
6013bc53 JB |
68 | * @public |
69 | */ | |
70 | public async start(): Promise<void> { | |
4581acf3 | 71 | await this.startWorker(); |
6013bc53 JB |
72 | } |
73 | ||
ded13d97 JB |
74 | /** |
75 | * | |
81797102 | 76 | * @returns |
ded13d97 JB |
77 | * @public |
78 | */ | |
79 | public async stop(): Promise<void> { | |
80 | for (const workerSetElement of this.workerSet) { | |
81 | await workerSetElement.worker.terminate(); | |
82 | } | |
83 | this.workerSet.clear(); | |
84 | } | |
85 | ||
6013bc53 | 86 | /** |
1f7a0346 | 87 | * Start a new `Worker`. |
6013bc53 | 88 | */ |
4581acf3 | 89 | private async startWorker(): Promise<void> { |
a4624c96 | 90 | const worker = new Worker(this.workerScript); |
0e4fa348 JB |
91 | worker.on( |
92 | 'message', | |
93 | ( | |
94 | this.workerOptions?.messageHandler ?? | |
95 | (() => { | |
96 | /* This is intentional */ | |
97 | }) | |
98 | ).bind(this) as MessageHandler<Worker> | |
99 | ); | |
100 | worker.on('error', WorkerUtils.defaultErrorHandler.bind(this) as (err: Error) => void); | |
a4624c96 | 101 | worker.on('exit', (code) => { |
7874b0b1 | 102 | WorkerUtils.defaultExitHandler(code); |
d7a48614 | 103 | this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); |
6013bc53 | 104 | }); |
ded13d97 | 105 | this.workerSet.add({ worker, numberOfWorkerElements: 0 }); |
4581acf3 | 106 | // Start worker sequentially to optimize memory at startup |
e7aeea18 JB |
107 | this.workerOptions.workerStartDelay > 0 && |
108 | (await Utils.sleep(this.workerOptions.workerStartDelay)); | |
6013bc53 JB |
109 | } |
110 | ||
c045d9a9 JB |
111 | private getLastWorkerSetElement(): WorkerSetElement { |
112 | let workerSetElement: WorkerSetElement; | |
e7aeea18 JB |
113 | for (workerSetElement of this.workerSet) { |
114 | /* This is intentional */ | |
115 | } | |
c045d9a9 JB |
116 | return workerSetElement; |
117 | } | |
118 | ||
119 | private getLastWorker(): Worker { | |
120 | return this.getLastWorkerSetElement().worker; | |
6013bc53 | 121 | } |
1e924543 JB |
122 | |
123 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { | |
124 | let workerSetElt: WorkerSetElement; | |
0e7a11e1 | 125 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 126 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 127 | workerSetElt = workerSetElement; |
0e7a11e1 | 128 | break; |
1e924543 | 129 | } |
0e7a11e1 | 130 | } |
1e924543 JB |
131 | return workerSetElt; |
132 | } | |
6013bc53 | 133 | } |