Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
4d7227e6 | 3 | import { WorkerData, WorkerMessageEvents, WorkerOptions, WorkerSetElement } from '../types/Worker'; |
c045d9a9 | 4 | |
6013bc53 | 5 | import Utils from '../utils/Utils'; |
1e924543 | 6 | import { Worker } from 'worker_threads'; |
fd1fdf1b | 7 | import WorkerAbstract from './WorkerAbstract'; |
7874b0b1 | 8 | import { WorkerUtils } from './WorkerUtils'; |
6013bc53 | 9 | |
c3ee95af | 10 | export default class WorkerSet extends WorkerAbstract<WorkerData> { |
f2bf9948 | 11 | private readonly workerSet: Set<WorkerSetElement>; |
4d7227e6 | 12 | private readonly messageHandler: (message: unknown) => void | Promise<void>; |
6013bc53 JB |
13 | |
14 | /** | |
15 | * Create a new `WorkerSet`. | |
16 | * | |
81797102 | 17 | * @param workerScript |
4d7227e6 | 18 | * @param workerOptions |
6013bc53 | 19 | */ |
4d7227e6 JB |
20 | constructor(workerScript: string, workerOptions?: WorkerOptions) { |
21 | super(workerScript, workerOptions); | |
ffd71f2c | 22 | this.workerSet = new Set<WorkerSetElement>(); |
57678745 | 23 | this.messageHandler = workerOptions?.messageHandler ?? (() => { /* This is intentional */ }); |
6013bc53 JB |
24 | } |
25 | ||
26 | get size(): number { | |
ded13d97 | 27 | return this.workerSet.size; |
6013bc53 JB |
28 | } |
29 | ||
4d7227e6 JB |
30 | get maxElementsPerWorker(): number | null { |
31 | return this.workerOptions.elementsPerWorker; | |
32 | } | |
33 | ||
6013bc53 JB |
34 | /** |
35 | * | |
81797102 JB |
36 | * @param elementData |
37 | * @returns | |
6013bc53 JB |
38 | * @public |
39 | */ | |
c3ee95af | 40 | public async addElement(elementData: WorkerData): Promise<void> { |
ded13d97 | 41 | if (!this.workerSet) { |
290d006c | 42 | throw new Error('Cannot add a WorkerSet element: workers\' set does not exist'); |
6013bc53 | 43 | } |
4d7227e6 | 44 | if (this.getLastWorkerSetElement().numberOfWorkerElements >= this.workerOptions.elementsPerWorker) { |
4581acf3 | 45 | await this.startWorker(); |
6013bc53 | 46 | } |
36367c31 | 47 | this.getLastWorker().postMessage({ id: WorkerMessageEvents.START_WORKER_ELEMENT, workerOptions: this.workerOptions, data: elementData }); |
c045d9a9 | 48 | this.getLastWorkerSetElement().numberOfWorkerElements++; |
6013bc53 JB |
49 | } |
50 | ||
51 | /** | |
52 | * | |
81797102 | 53 | * @returns |
6013bc53 JB |
54 | * @public |
55 | */ | |
56 | public async start(): Promise<void> { | |
4581acf3 | 57 | await this.startWorker(); |
6013bc53 JB |
58 | } |
59 | ||
ded13d97 JB |
60 | /** |
61 | * | |
81797102 | 62 | * @returns |
ded13d97 JB |
63 | * @public |
64 | */ | |
65 | public async stop(): Promise<void> { | |
66 | for (const workerSetElement of this.workerSet) { | |
67 | await workerSetElement.worker.terminate(); | |
68 | } | |
69 | this.workerSet.clear(); | |
70 | } | |
71 | ||
6013bc53 JB |
72 | /** |
73 | * | |
6013bc53 JB |
74 | * @private |
75 | */ | |
4581acf3 | 76 | private async startWorker(): Promise<void> { |
a4624c96 | 77 | const worker = new Worker(this.workerScript); |
821c6c82 JB |
78 | worker.on('message', (msg) => { |
79 | (async () => { | |
80 | await this.messageHandler(msg); | |
0dad4bda | 81 | })().catch(() => { /* This is intentional */ }); |
821c6c82 | 82 | }); |
6c3cfef8 | 83 | worker.on('error', () => { /* This is intentional */ }); |
a4624c96 | 84 | worker.on('exit', (code) => { |
7874b0b1 | 85 | WorkerUtils.defaultExitHandler(code); |
d7a48614 | 86 | this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); |
6013bc53 | 87 | }); |
ded13d97 | 88 | this.workerSet.add({ worker, numberOfWorkerElements: 0 }); |
4581acf3 | 89 | // Start worker sequentially to optimize memory at startup |
4d7227e6 | 90 | this.workerOptions.workerStartDelay > 0 && await Utils.sleep(this.workerOptions.workerStartDelay); |
6013bc53 JB |
91 | } |
92 | ||
c045d9a9 JB |
93 | private getLastWorkerSetElement(): WorkerSetElement { |
94 | let workerSetElement: WorkerSetElement; | |
6c3cfef8 | 95 | for (workerSetElement of this.workerSet) { /* This is intentional */ } |
c045d9a9 JB |
96 | return workerSetElement; |
97 | } | |
98 | ||
99 | private getLastWorker(): Worker { | |
100 | return this.getLastWorkerSetElement().worker; | |
6013bc53 | 101 | } |
1e924543 JB |
102 | |
103 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { | |
104 | let workerSetElt: WorkerSetElement; | |
0e7a11e1 | 105 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 106 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 107 | workerSetElt = workerSetElement; |
0e7a11e1 | 108 | break; |
1e924543 | 109 | } |
0e7a11e1 | 110 | } |
1e924543 JB |
111 | return workerSetElt; |
112 | } | |
6013bc53 | 113 | } |