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