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