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 | } |
d070d967 JB |
47 | this.getLastWorker().postMessage({ |
48 | id: WorkerMessageEvents.START_WORKER_ELEMENT, | |
49 | data: elementData | |
50 | }); | |
c045d9a9 | 51 | this.getLastWorkerSetElement().numberOfWorkerElements++; |
d070d967 JB |
52 | // Start element sequentially to optimize memory at startup |
53 | if (this.workerOptions.elementStartDelay > 0) { | |
54 | await Utils.sleep(this.workerOptions.elementStartDelay); | |
55 | } | |
6013bc53 JB |
56 | } |
57 | ||
58 | /** | |
59 | * | |
81797102 | 60 | * @returns |
6013bc53 JB |
61 | * @public |
62 | */ | |
63 | public async start(): Promise<void> { | |
4581acf3 | 64 | await this.startWorker(); |
6013bc53 JB |
65 | } |
66 | ||
ded13d97 JB |
67 | /** |
68 | * | |
81797102 | 69 | * @returns |
ded13d97 JB |
70 | * @public |
71 | */ | |
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 JB |
79 | /** |
80 | * | |
6013bc53 JB |
81 | * @private |
82 | */ | |
4581acf3 | 83 | private async startWorker(): Promise<void> { |
a4624c96 | 84 | const worker = new Worker(this.workerScript); |
821c6c82 JB |
85 | worker.on('message', (msg) => { |
86 | (async () => { | |
87 | await this.messageHandler(msg); | |
0dad4bda | 88 | })().catch(() => { /* This is intentional */ }); |
821c6c82 | 89 | }); |
6c3cfef8 | 90 | worker.on('error', () => { /* This is intentional */ }); |
a4624c96 | 91 | worker.on('exit', (code) => { |
7874b0b1 | 92 | WorkerUtils.defaultExitHandler(code); |
d7a48614 | 93 | this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); |
6013bc53 | 94 | }); |
ded13d97 | 95 | this.workerSet.add({ worker, numberOfWorkerElements: 0 }); |
4581acf3 | 96 | // Start worker sequentially to optimize memory at startup |
4d7227e6 | 97 | this.workerOptions.workerStartDelay > 0 && await Utils.sleep(this.workerOptions.workerStartDelay); |
6013bc53 JB |
98 | } |
99 | ||
c045d9a9 JB |
100 | private getLastWorkerSetElement(): WorkerSetElement { |
101 | let workerSetElement: WorkerSetElement; | |
6c3cfef8 | 102 | for (workerSetElement of this.workerSet) { /* This is intentional */ } |
c045d9a9 JB |
103 | return workerSetElement; |
104 | } | |
105 | ||
106 | private getLastWorker(): Worker { | |
107 | return this.getLastWorkerSetElement().worker; | |
6013bc53 | 108 | } |
1e924543 JB |
109 | |
110 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { | |
111 | let workerSetElt: WorkerSetElement; | |
0e7a11e1 | 112 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 113 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 114 | workerSetElt = workerSetElement; |
0e7a11e1 | 115 | break; |
1e924543 | 116 | } |
0e7a11e1 | 117 | } |
1e924543 JB |
118 | return workerSetElt; |
119 | } | |
6013bc53 | 120 | } |