Commit | Line | Data |
---|---|---|
c8eeb62b JB |
1 | // Partial Copyright Jerome Benoit. 2021. All Rights Reserved. |
2 | ||
8114d10e | 3 | import { Worker } from 'worker_threads'; |
c045d9a9 | 4 | |
8114d10e | 5 | import { WorkerData, WorkerMessageEvents, WorkerOptions, WorkerSetElement } from '../types/Worker'; |
6013bc53 | 6 | import Utils from '../utils/Utils'; |
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>(); |
e7aeea18 JB |
23 | this.messageHandler = |
24 | workerOptions?.messageHandler ?? | |
25 | (() => { | |
26 | /* This is intentional */ | |
27 | }); | |
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 | * | |
81797102 JB |
40 | * @param elementData |
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 JB |
86 | /** |
87 | * | |
6013bc53 JB |
88 | * @private |
89 | */ | |
4581acf3 | 90 | private async startWorker(): Promise<void> { |
a4624c96 | 91 | const worker = new Worker(this.workerScript); |
821c6c82 JB |
92 | worker.on('message', (msg) => { |
93 | (async () => { | |
94 | await this.messageHandler(msg); | |
e7aeea18 JB |
95 | })().catch(() => { |
96 | /* This is intentional */ | |
97 | }); | |
98 | }); | |
0f187001 JB |
99 | worker.on('error', (error) => { |
100 | WorkerUtils.defaultErrorHandler(error); | |
821c6c82 | 101 | }); |
a4624c96 | 102 | worker.on('exit', (code) => { |
7874b0b1 | 103 | WorkerUtils.defaultExitHandler(code); |
d7a48614 | 104 | this.workerSet.delete(this.getWorkerSetElementByWorker(worker)); |
6013bc53 | 105 | }); |
ded13d97 | 106 | this.workerSet.add({ worker, numberOfWorkerElements: 0 }); |
4581acf3 | 107 | // Start worker sequentially to optimize memory at startup |
e7aeea18 JB |
108 | this.workerOptions.workerStartDelay > 0 && |
109 | (await Utils.sleep(this.workerOptions.workerStartDelay)); | |
6013bc53 JB |
110 | } |
111 | ||
c045d9a9 JB |
112 | private getLastWorkerSetElement(): WorkerSetElement { |
113 | let workerSetElement: WorkerSetElement; | |
e7aeea18 JB |
114 | for (workerSetElement of this.workerSet) { |
115 | /* This is intentional */ | |
116 | } | |
c045d9a9 JB |
117 | return workerSetElement; |
118 | } | |
119 | ||
120 | private getLastWorker(): Worker { | |
121 | return this.getLastWorkerSetElement().worker; | |
6013bc53 | 122 | } |
1e924543 JB |
123 | |
124 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement { | |
125 | let workerSetElt: WorkerSetElement; | |
0e7a11e1 | 126 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 127 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 128 | workerSetElt = workerSetElement; |
0e7a11e1 | 129 | break; |
1e924543 | 130 | } |
0e7a11e1 | 131 | } |
1e924543 JB |
132 | return workerSetElt; |
133 | } | |
6013bc53 | 134 | } |