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