Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
2a370053 | 3 | import { WorkerMessageEvents, 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 | |
fd1fdf1b | 10 | export default class WorkerSet<T> extends WorkerAbstract { |
6013bc53 | 11 | public maxElementsPerWorker: number; |
ded13d97 | 12 | private workerSet: Set<WorkerSetElement>; |
6013bc53 JB |
13 | |
14 | /** | |
15 | * Create a new `WorkerSet`. | |
16 | * | |
81797102 JB |
17 | * @param workerScript |
18 | * @param maxElementsPerWorker | |
19 | * @param workerStartDelay | |
20 | * @param messageListenerCallback | |
6013bc53 | 21 | */ |
81797102 JB |
22 | constructor(workerScript: string, maxElementsPerWorker = 1, workerStartDelay?: number, messageListenerCallback: (message: any) => void = () => { /* This is intentional */ }) { |
23 | super(workerScript, workerStartDelay, messageListenerCallback); | |
ded13d97 | 24 | this.workerSet = new Set<WorkerSetElement>(); |
6013bc53 | 25 | this.maxElementsPerWorker = maxElementsPerWorker; |
6013bc53 JB |
26 | } |
27 | ||
28 | get size(): number { | |
ded13d97 | 29 | return this.workerSet.size; |
6013bc53 JB |
30 | } |
31 | ||
32 | /** | |
33 | * | |
81797102 JB |
34 | * @param elementData |
35 | * @returns | |
6013bc53 JB |
36 | * @public |
37 | */ | |
8434025b | 38 | public async addElement(elementData: T): Promise<void> { |
ded13d97 | 39 | if (!this.workerSet) { |
290d006c | 40 | throw new Error('Cannot add a WorkerSet element: workers\' set does not exist'); |
6013bc53 | 41 | } |
c045d9a9 | 42 | if (this.getLastWorkerSetElement().numberOfWorkerElements >= this.maxElementsPerWorker) { |
a4624c96 | 43 | this.startWorker(); |
6013bc53 | 44 | // Start worker sequentially to optimize memory at startup |
322c9192 | 45 | await Utils.sleep(this.workerStartDelay); |
6013bc53 | 46 | } |
2a370053 | 47 | this.getLastWorker().postMessage({ id: WorkerMessageEvents.START_WORKER_ELEMENT, 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> { | |
a4624c96 | 57 | this.startWorker(); |
6013bc53 | 58 | // Start worker sequentially to optimize memory at startup |
322c9192 | 59 | await Utils.sleep(this.workerStartDelay); |
6013bc53 JB |
60 | } |
61 | ||
ded13d97 JB |
62 | /** |
63 | * | |
81797102 | 64 | * @returns |
ded13d97 JB |
65 | * @public |
66 | */ | |
67 | public async stop(): Promise<void> { | |
68 | for (const workerSetElement of this.workerSet) { | |
69 | await workerSetElement.worker.terminate(); | |
70 | } | |
71 | this.workerSet.clear(); | |
72 | } | |
73 | ||
6013bc53 JB |
74 | /** |
75 | * | |
6013bc53 JB |
76 | * @private |
77 | */ | |
a4624c96 JB |
78 | private startWorker(): void { |
79 | const worker = new Worker(this.workerScript); | |
81797102 | 80 | worker.on('message', this.messageListener); |
6c3cfef8 | 81 | worker.on('error', () => { /* This is intentional */ }); |
a4624c96 | 82 | worker.on('exit', (code) => { |
7874b0b1 | 83 | WorkerUtils.defaultExitHandler(code); |
d7a48614 | 84 | this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); |
6013bc53 | 85 | }); |
ded13d97 | 86 | this.workerSet.add({ worker, numberOfWorkerElements: 0 }); |
6013bc53 JB |
87 | } |
88 | ||
c045d9a9 JB |
89 | private getLastWorkerSetElement(): WorkerSetElement { |
90 | let workerSetElement: WorkerSetElement; | |
6013bc53 | 91 | // eslint-disable-next-line no-empty |
6c3cfef8 | 92 | for (workerSetElement of this.workerSet) { /* This is intentional */ } |
c045d9a9 JB |
93 | return workerSetElement; |
94 | } | |
95 | ||
96 | private getLastWorker(): Worker { | |
97 | return this.getLastWorkerSetElement().worker; | |
6013bc53 | 98 | } |
1e924543 JB |
99 | |
100 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { | |
101 | let workerSetElt: WorkerSetElement; | |
0e7a11e1 | 102 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 103 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 104 | workerSetElt = workerSetElement; |
0e7a11e1 | 105 | break; |
1e924543 | 106 | } |
0e7a11e1 | 107 | } |
1e924543 JB |
108 | return workerSetElt; |
109 | } | |
6013bc53 | 110 | } |