Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
c8eeb62b | 2 | |
d972af76 | 3 | import { EventEmitter } from 'node:events'; |
be245fda | 4 | import { SHARE_ENV, Worker } from 'node:worker_threads'; |
c045d9a9 | 5 | |
268a74bb | 6 | import { WorkerAbstract } from './WorkerAbstract'; |
769d3b10 | 7 | import { DEFAULT_POOL_OPTIONS, EMPTY_FUNCTION, workerSetVersion } from './WorkerConstants'; |
0e4fa348 | 8 | import { |
b779c0f8 | 9 | type SetInfo, |
0e4fa348 | 10 | type WorkerData, |
c26984f2 | 11 | type WorkerMessage, |
0e4fa348 JB |
12 | WorkerMessageEvents, |
13 | type WorkerOptions, | |
14 | type WorkerSetElement, | |
810f4caf | 15 | WorkerSetEvents, |
268a74bb | 16 | } from './WorkerTypes'; |
be245fda | 17 | import { sleep } from './WorkerUtils'; |
6013bc53 | 18 | |
268a74bb | 19 | export class WorkerSet extends WorkerAbstract<WorkerData> { |
a37fc6dc | 20 | public readonly emitter!: EventEmitter; |
f2bf9948 | 21 | private readonly workerSet: Set<WorkerSetElement>; |
6013bc53 JB |
22 | |
23 | /** | |
361c98f5 | 24 | * Creates a new `WorkerSet`. |
6013bc53 | 25 | * |
0e4fa348 JB |
26 | * @param workerScript - |
27 | * @param workerOptions - | |
6013bc53 | 28 | */ |
4a3807d1 | 29 | constructor(workerScript: string, workerOptions: WorkerOptions) { |
4d7227e6 | 30 | super(workerScript, workerOptions); |
81027aa5 JB |
31 | if ( |
32 | this.workerOptions.elementsPerWorker === null || | |
33 | this.workerOptions.elementsPerWorker === undefined | |
34 | ) { | |
35 | throw new TypeError('Elements per worker is not defined'); | |
36 | } | |
f028efca | 37 | if (!Number.isSafeInteger(this.workerOptions.elementsPerWorker)) { |
81027aa5 JB |
38 | throw new TypeError('Elements per worker must be an integer'); |
39 | } | |
40 | if (this.workerOptions.elementsPerWorker <= 0) { | |
41 | throw new RangeError('Elements per worker must be greater than zero'); | |
42 | } | |
29bb4dee | 43 | this.workerOptions.poolOptions = { |
4a3807d1 | 44 | ...DEFAULT_POOL_OPTIONS, |
29bb4dee JB |
45 | ...this.workerOptions.poolOptions, |
46 | }; | |
ffd71f2c | 47 | this.workerSet = new Set<WorkerSetElement>(); |
a37fc6dc | 48 | if (this.workerOptions.poolOptions?.enableEvents) { |
d972af76 | 49 | this.emitter = new EventEmitter(); |
29bb4dee | 50 | } |
6013bc53 JB |
51 | } |
52 | ||
b779c0f8 JB |
53 | get info(): SetInfo { |
54 | return { | |
769d3b10 | 55 | version: workerSetVersion, |
0bde1ea1 JB |
56 | type: 'set', |
57 | worker: 'thread', | |
b779c0f8 | 58 | size: this.size, |
19bdf4ca | 59 | elementsExecuting: [...this.workerSet].reduce( |
b779c0f8 | 60 | (accumulator, workerSetElement) => accumulator + workerSetElement.numberOfWorkerElements, |
5edd8ba0 | 61 | 0, |
b779c0f8 | 62 | ), |
e1d9a0f4 | 63 | elementsPerWorker: this.maxElementsPerWorker!, |
b779c0f8 JB |
64 | }; |
65 | } | |
66 | ||
6013bc53 | 67 | get size(): number { |
ded13d97 | 68 | return this.workerSet.size; |
6013bc53 JB |
69 | } |
70 | ||
72092cfc | 71 | get maxElementsPerWorker(): number | undefined { |
4d7227e6 JB |
72 | return this.workerOptions.elementsPerWorker; |
73 | } | |
74 | ||
b0dee778 JB |
75 | /** @inheritDoc */ |
76 | public async start(): Promise<void> { | |
77 | this.addWorkerSetElement(); | |
78 | // Add worker set element sequentially to optimize memory at startup | |
e1d9a0f4 | 79 | this.workerOptions.workerStartDelay! > 0 && (await sleep(this.workerOptions.workerStartDelay!)); |
b0dee778 JB |
80 | } |
81 | ||
82 | /** @inheritDoc */ | |
83 | public async stop(): Promise<void> { | |
84 | for (const workerSetElement of this.workerSet) { | |
b3ded6ae | 85 | const worker = workerSetElement.worker; |
bd62e88f | 86 | const waitWorkerExit = new Promise<void>((resolve) => { |
b3ded6ae | 87 | worker.on('exit', () => { |
dbc29904 JB |
88 | resolve(); |
89 | }); | |
90 | }); | |
b3ded6ae | 91 | await worker.terminate(); |
bd62e88f | 92 | await waitWorkerExit; |
b0dee778 | 93 | } |
b0dee778 JB |
94 | } |
95 | ||
8baf3f8f | 96 | /** @inheritDoc */ |
c3ee95af | 97 | public async addElement(elementData: WorkerData): Promise<void> { |
ded13d97 | 98 | if (!this.workerSet) { |
e7aeea18 | 99 | throw new Error("Cannot add a WorkerSet element: workers' set does not exist"); |
6013bc53 | 100 | } |
962a8159 JB |
101 | const workerSetElement = await this.getWorkerSetElement(); |
102 | workerSetElement.worker.postMessage({ | |
2bb7a73e | 103 | event: WorkerMessageEvents.startWorkerElement, |
e7aeea18 | 104 | data: elementData, |
d070d967 | 105 | }); |
962a8159 JB |
106 | ++workerSetElement.numberOfWorkerElements; |
107 | // Add element sequentially to optimize memory at startup | |
e1d9a0f4 JB |
108 | if (this.workerOptions.elementStartDelay! > 0) { |
109 | await sleep(this.workerOptions.elementStartDelay!); | |
d070d967 | 110 | } |
6013bc53 JB |
111 | } |
112 | ||
6013bc53 | 113 | /** |
361c98f5 | 114 | * Adds a new `WorkerSetElement`. |
6013bc53 | 115 | */ |
962a8159 | 116 | private addWorkerSetElement(): WorkerSetElement { |
be245fda JB |
117 | const worker = new Worker(this.workerScript, { |
118 | env: SHARE_ENV, | |
e1d9a0f4 | 119 | ...this.workerOptions.poolOptions?.workerOptions, |
be245fda | 120 | }); |
769d3b10 | 121 | worker.on('message', this.workerOptions.poolOptions?.messageHandler ?? EMPTY_FUNCTION); |
c26984f2 JB |
122 | worker.on('message', (message: WorkerMessage<WorkerData>) => { |
123 | if (message.event === WorkerMessageEvents.startedWorkerElement) { | |
bdb50f5a | 124 | this.emitter?.emit(WorkerSetEvents.elementStarted, this.info); |
c26984f2 JB |
125 | } else if (message.event === WorkerMessageEvents.startWorkerElementError) { |
126 | this.emitter?.emit(WorkerSetEvents.elementError, message.data); | |
127 | } | |
128 | }); | |
769d3b10 | 129 | worker.on('error', this.workerOptions.poolOptions?.errorHandler ?? EMPTY_FUNCTION); |
962a8159 | 130 | worker.on('error', (error) => { |
fac8866f | 131 | this.emitter?.emit(WorkerSetEvents.error, error); |
a37fc6dc | 132 | if (this.workerOptions.poolOptions?.restartWorkerOnError) { |
29bb4dee JB |
133 | this.addWorkerSetElement(); |
134 | } | |
962a8159 | 135 | }); |
769d3b10 JB |
136 | worker.on('online', this.workerOptions.poolOptions?.onlineHandler ?? EMPTY_FUNCTION); |
137 | worker.on('exit', this.workerOptions.poolOptions?.exitHandler ?? EMPTY_FUNCTION); | |
dbc29904 | 138 | worker.once('exit', () => |
e1d9a0f4 | 139 | this.removeWorkerSetElement(this.getWorkerSetElementByWorker(worker)!), |
dbc29904 | 140 | ); |
962a8159 JB |
141 | const workerSetElement: WorkerSetElement = { worker, numberOfWorkerElements: 0 }; |
142 | this.workerSet.add(workerSetElement); | |
143 | return workerSetElement; | |
6013bc53 JB |
144 | } |
145 | ||
dbc29904 JB |
146 | private removeWorkerSetElement(workerSetElement: WorkerSetElement): void { |
147 | this.workerSet.delete(workerSetElement); | |
148 | } | |
149 | ||
962a8159 | 150 | private async getWorkerSetElement(): Promise<WorkerSetElement> { |
e1d9a0f4 | 151 | let chosenWorkerSetElement: WorkerSetElement | undefined; |
962a8159 | 152 | for (const workerSetElement of this.workerSet) { |
e1d9a0f4 | 153 | if (workerSetElement.numberOfWorkerElements < this.workerOptions.elementsPerWorker!) { |
962a8159 JB |
154 | chosenWorkerSetElement = workerSetElement; |
155 | break; | |
156 | } | |
e7aeea18 | 157 | } |
962a8159 JB |
158 | if (!chosenWorkerSetElement) { |
159 | chosenWorkerSetElement = this.addWorkerSetElement(); | |
160 | // Add worker set element sequentially to optimize memory at startup | |
e1d9a0f4 JB |
161 | this.workerOptions.workerStartDelay! > 0 && |
162 | (await sleep(this.workerOptions.workerStartDelay!)); | |
962a8159 JB |
163 | } |
164 | return chosenWorkerSetElement; | |
c045d9a9 JB |
165 | } |
166 | ||
962a8159 | 167 | private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement | undefined { |
e1d9a0f4 | 168 | let workerSetElt: WorkerSetElement | undefined; |
0e7a11e1 | 169 | for (const workerSetElement of this.workerSet) { |
81696bd5 | 170 | if (workerSetElement.worker.threadId === worker.threadId) { |
1e924543 | 171 | workerSetElt = workerSetElement; |
0e7a11e1 | 172 | break; |
1e924543 | 173 | } |
0e7a11e1 | 174 | } |
1e924543 JB |
175 | return workerSetElt; |
176 | } | |
6013bc53 | 177 | } |