Commit | Line | Data |
---|---|---|
fc3e6586 | 1 | import { AsyncResource } from 'node:async_hooks' |
6677a3d3 | 2 | import type { Worker } from 'node:cluster' |
fc3e6586 | 3 | import type { MessagePort } from 'node:worker_threads' |
d715b7bc JB |
4 | import { performance } from 'node:perf_hooks' |
5 | import type { | |
6 | MessageValue, | |
5c4d16da | 7 | Task, |
d715b7bc JB |
8 | TaskPerformance, |
9 | WorkerStatistics | |
10 | } from '../utility-types' | |
ff128cc9 JB |
11 | import { |
12 | DEFAULT_TASK_NAME, | |
13 | EMPTY_FUNCTION, | |
14 | isAsyncFunction, | |
15 | isPlainObject | |
16 | } from '../utils' | |
d38d0e30 | 17 | import { KillBehaviors, type WorkerOptions } from './worker-options' |
b6b32453 | 18 | import type { |
82ea6492 JB |
19 | TaskAsyncFunction, |
20 | TaskFunction, | |
e81c38f2 | 21 | TaskFunctionOperationReturnType, |
b6b32453 | 22 | TaskFunctions, |
82ea6492 JB |
23 | TaskSyncFunction |
24 | } from './task-functions' | |
4c35177b | 25 | |
978aad6f | 26 | const DEFAULT_MAX_INACTIVE_TIME = 60000 |
d38d0e30 JB |
27 | const DEFAULT_WORKER_OPTIONS: WorkerOptions = { |
28 | /** | |
29 | * The kill behavior option on this worker or its default value. | |
30 | */ | |
31 | killBehavior: KillBehaviors.SOFT, | |
32 | /** | |
33 | * The maximum time to keep this worker active while idle. | |
34 | * The pool automatically checks and terminates this worker when the time expires. | |
35 | */ | |
36 | maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME, | |
37 | /** | |
38 | * The function to call when the worker is killed. | |
39 | */ | |
40 | killHandler: EMPTY_FUNCTION | |
41 | } | |
c97c7edb | 42 | |
729c563d | 43 | /** |
ea7a90d3 | 44 | * Base class that implements some shared logic for all poolifier workers. |
729c563d | 45 | * |
38e795c1 | 46 | * @typeParam MainWorker - Type of main worker. |
e102732c JB |
47 | * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data. |
48 | * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data. | |
729c563d | 49 | */ |
c97c7edb | 50 | export abstract class AbstractWorker< |
6677a3d3 | 51 | MainWorker extends Worker | MessagePort, |
d3c8a1a8 S |
52 | Data = unknown, |
53 | Response = unknown | |
c97c7edb | 54 | > extends AsyncResource { |
f59e1027 | 55 | /** |
83fa0a36 | 56 | * Worker id. |
f59e1027 JB |
57 | */ |
58 | protected abstract id: number | |
a86b6df1 JB |
59 | /** |
60 | * Task function(s) processed by the worker when the pool's `execution` function is invoked. | |
61 | */ | |
82ea6492 | 62 | protected taskFunctions!: Map<string, TaskFunction<Data, Response>> |
729c563d S |
63 | /** |
64 | * Timestamp of the last task processed by this worker. | |
65 | */ | |
a9d9ea34 | 66 | protected lastTaskTimestamp!: number |
b6b32453 | 67 | /** |
8a970421 | 68 | * Performance statistics computation requirements. |
b6b32453 JB |
69 | */ |
70 | protected statistics!: WorkerStatistics | |
729c563d | 71 | /** |
b0a4db63 | 72 | * Handler id of the `activeInterval` worker activity check. |
729c563d | 73 | */ |
b0a4db63 | 74 | protected activeInterval?: NodeJS.Timeout |
c97c7edb | 75 | /** |
729c563d | 76 | * Constructs a new poolifier worker. |
c97c7edb | 77 | * |
38e795c1 JB |
78 | * @param type - The type of async event. |
79 | * @param isMain - Whether this is the main worker or not. | |
38e795c1 | 80 | * @param mainWorker - Reference to main worker. |
85aeb3f3 | 81 | * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function. |
38e795c1 | 82 | * @param opts - Options for the worker. |
c97c7edb S |
83 | */ |
84 | public constructor ( | |
85 | type: string, | |
c2ade475 | 86 | protected readonly isMain: boolean, |
6c0c538c | 87 | private readonly mainWorker: MainWorker, |
82ea6492 | 88 | taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>, |
d38d0e30 | 89 | protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS |
c97c7edb S |
90 | ) { |
91 | super(type) | |
9d2d0da1 JB |
92 | if (this.isMain == null) { |
93 | throw new Error('isMain parameter is mandatory') | |
94 | } | |
a86b6df1 | 95 | this.checkTaskFunctions(taskFunctions) |
9d2d0da1 | 96 | this.checkWorkerOptions(this.opts) |
1f68cede | 97 | if (!this.isMain) { |
9d2d0da1 | 98 | this.getMainWorker().on('message', this.handleReadyMessage.bind(this)) |
c97c7edb S |
99 | } |
100 | } | |
101 | ||
41aa7dcd | 102 | private checkWorkerOptions (opts: WorkerOptions): void { |
d38d0e30 | 103 | this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts } |
3c5dc3fb | 104 | delete this.opts.async |
41aa7dcd JB |
105 | } |
106 | ||
0628df39 JB |
107 | private checkValidTaskFunction ( |
108 | name: string, | |
109 | fn: TaskFunction<Data, Response> | |
110 | ): void { | |
111 | if (typeof name !== 'string') { | |
112 | throw new TypeError( | |
113 | 'A taskFunctions parameter object key is not a string' | |
114 | ) | |
115 | } | |
116 | if (typeof name === 'string' && name.trim().length === 0) { | |
117 | throw new TypeError( | |
118 | 'A taskFunctions parameter object key is an empty string' | |
119 | ) | |
120 | } | |
121 | if (typeof fn !== 'function') { | |
122 | throw new TypeError( | |
123 | 'A taskFunctions parameter object value is not a function' | |
124 | ) | |
125 | } | |
126 | } | |
127 | ||
41aa7dcd | 128 | /** |
a86b6df1 | 129 | * Checks if the `taskFunctions` parameter is passed to the constructor. |
41aa7dcd | 130 | * |
82888165 | 131 | * @param taskFunctions - The task function(s) parameter that should be checked. |
41aa7dcd | 132 | */ |
a86b6df1 | 133 | private checkTaskFunctions ( |
82ea6492 | 134 | taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response> |
a86b6df1 | 135 | ): void { |
ec8fd331 JB |
136 | if (taskFunctions == null) { |
137 | throw new Error('taskFunctions parameter is mandatory') | |
138 | } | |
82ea6492 | 139 | this.taskFunctions = new Map<string, TaskFunction<Data, Response>>() |
0d80593b | 140 | if (typeof taskFunctions === 'function') { |
2a69b8c5 JB |
141 | const boundFn = taskFunctions.bind(this) |
142 | this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) | |
143 | this.taskFunctions.set( | |
144 | typeof taskFunctions.name === 'string' && | |
8ebe6c30 | 145 | taskFunctions.name.trim().length > 0 |
2a69b8c5 JB |
146 | ? taskFunctions.name |
147 | : 'fn1', | |
148 | boundFn | |
149 | ) | |
0d80593b | 150 | } else if (isPlainObject(taskFunctions)) { |
82888165 | 151 | let firstEntry = true |
a86b6df1 | 152 | for (const [name, fn] of Object.entries(taskFunctions)) { |
0628df39 | 153 | this.checkValidTaskFunction(name, fn) |
2a69b8c5 | 154 | const boundFn = fn.bind(this) |
82888165 | 155 | if (firstEntry) { |
2a69b8c5 | 156 | this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) |
82888165 JB |
157 | firstEntry = false |
158 | } | |
c50b93fb | 159 | this.taskFunctions.set(name, boundFn) |
a86b6df1 | 160 | } |
630f0acf JB |
161 | if (firstEntry) { |
162 | throw new Error('taskFunctions parameter object is empty') | |
163 | } | |
a86b6df1 | 164 | } else { |
f34fdabe JB |
165 | throw new TypeError( |
166 | 'taskFunctions parameter is not a function or a plain object' | |
167 | ) | |
41aa7dcd JB |
168 | } |
169 | } | |
170 | ||
968a2e8c JB |
171 | /** |
172 | * Checks if the worker has a task function with the given name. | |
173 | * | |
174 | * @param name - The name of the task function to check. | |
175 | * @returns Whether the worker has a task function with the given name or not. | |
968a2e8c | 176 | */ |
6703b9f4 JB |
177 | public hasTaskFunction (name: string): TaskFunctionOperationReturnType { |
178 | try { | |
179 | this.checkTaskFunctionName(name) | |
180 | } catch (error) { | |
181 | return { status: false, error: error as Error } | |
182 | } | |
183 | return { status: this.taskFunctions.has(name) } | |
968a2e8c JB |
184 | } |
185 | ||
186 | /** | |
187 | * Adds a task function to the worker. | |
188 | * If a task function with the same name already exists, it is replaced. | |
189 | * | |
190 | * @param name - The name of the task function to add. | |
191 | * @param fn - The task function to add. | |
192 | * @returns Whether the task function was added or not. | |
968a2e8c JB |
193 | */ |
194 | public addTaskFunction ( | |
195 | name: string, | |
82ea6492 | 196 | fn: TaskFunction<Data, Response> |
6703b9f4 | 197 | ): TaskFunctionOperationReturnType { |
968a2e8c | 198 | try { |
6703b9f4 JB |
199 | this.checkTaskFunctionName(name) |
200 | if (name === DEFAULT_TASK_NAME) { | |
201 | throw new Error( | |
202 | 'Cannot add a task function with the default reserved name' | |
203 | ) | |
204 | } | |
205 | if (typeof fn !== 'function') { | |
206 | throw new TypeError('fn parameter is not a function') | |
207 | } | |
646d040a | 208 | const boundFn = fn.bind(this) |
968a2e8c JB |
209 | if ( |
210 | this.taskFunctions.get(name) === | |
211 | this.taskFunctions.get(DEFAULT_TASK_NAME) | |
212 | ) { | |
2a69b8c5 | 213 | this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) |
968a2e8c | 214 | } |
2a69b8c5 | 215 | this.taskFunctions.set(name, boundFn) |
e81c38f2 | 216 | this.sendTaskFunctionNamesToMainWorker() |
6703b9f4 JB |
217 | return { status: true } |
218 | } catch (error) { | |
219 | return { status: false, error: error as Error } | |
968a2e8c JB |
220 | } |
221 | } | |
222 | ||
223 | /** | |
224 | * Removes a task function from the worker. | |
225 | * | |
226 | * @param name - The name of the task function to remove. | |
227 | * @returns Whether the task function existed and was removed or not. | |
968a2e8c | 228 | */ |
6703b9f4 JB |
229 | public removeTaskFunction (name: string): TaskFunctionOperationReturnType { |
230 | try { | |
231 | this.checkTaskFunctionName(name) | |
232 | if (name === DEFAULT_TASK_NAME) { | |
233 | throw new Error( | |
234 | 'Cannot remove the task function with the default reserved name' | |
235 | ) | |
236 | } | |
237 | if ( | |
238 | this.taskFunctions.get(name) === | |
239 | this.taskFunctions.get(DEFAULT_TASK_NAME) | |
240 | ) { | |
241 | throw new Error( | |
242 | 'Cannot remove the task function used as the default task function' | |
243 | ) | |
244 | } | |
245 | const deleteStatus = this.taskFunctions.delete(name) | |
e81c38f2 | 246 | this.sendTaskFunctionNamesToMainWorker() |
6703b9f4 JB |
247 | return { status: deleteStatus } |
248 | } catch (error) { | |
249 | return { status: false, error: error as Error } | |
968a2e8c | 250 | } |
968a2e8c JB |
251 | } |
252 | ||
253 | /** | |
c50b93fb JB |
254 | * Lists the names of the worker's task functions. |
255 | * | |
256 | * @returns The names of the worker's task functions. | |
257 | */ | |
6703b9f4 | 258 | public listTaskFunctionNames (): string[] { |
b558f6b5 JB |
259 | const names: string[] = [...this.taskFunctions.keys()] |
260 | let defaultTaskFunctionName: string = DEFAULT_TASK_NAME | |
261 | for (const [name, fn] of this.taskFunctions) { | |
262 | if ( | |
263 | name !== DEFAULT_TASK_NAME && | |
264 | fn === this.taskFunctions.get(DEFAULT_TASK_NAME) | |
265 | ) { | |
266 | defaultTaskFunctionName = name | |
267 | break | |
268 | } | |
269 | } | |
270 | return [ | |
271 | names[names.indexOf(DEFAULT_TASK_NAME)], | |
272 | defaultTaskFunctionName, | |
273 | ...names.filter( | |
041dc05b | 274 | name => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName |
b558f6b5 JB |
275 | ) |
276 | ] | |
c50b93fb JB |
277 | } |
278 | ||
279 | /** | |
280 | * Sets the default task function to use in the worker. | |
968a2e8c JB |
281 | * |
282 | * @param name - The name of the task function to use as default task function. | |
283 | * @returns Whether the default task function was set or not. | |
968a2e8c | 284 | */ |
6703b9f4 | 285 | public setDefaultTaskFunction (name: string): TaskFunctionOperationReturnType { |
968a2e8c | 286 | try { |
6703b9f4 JB |
287 | this.checkTaskFunctionName(name) |
288 | if (name === DEFAULT_TASK_NAME) { | |
289 | throw new Error( | |
290 | 'Cannot set the default task function reserved name as the default task function' | |
291 | ) | |
292 | } | |
293 | if (!this.taskFunctions.has(name)) { | |
294 | throw new Error( | |
295 | 'Cannot set the default task function to a non-existing task function' | |
296 | ) | |
297 | } | |
968a2e8c JB |
298 | this.taskFunctions.set( |
299 | DEFAULT_TASK_NAME, | |
82ea6492 | 300 | this.taskFunctions.get(name) as TaskFunction<Data, Response> |
968a2e8c | 301 | ) |
6703b9f4 JB |
302 | return { status: true } |
303 | } catch (error) { | |
304 | return { status: false, error: error as Error } | |
968a2e8c JB |
305 | } |
306 | } | |
307 | ||
d5e3c4ff JB |
308 | private checkTaskFunctionName (name: string): void { |
309 | if (typeof name !== 'string') { | |
310 | throw new TypeError('name parameter is not a string') | |
311 | } | |
312 | if (typeof name === 'string' && name.trim().length === 0) { | |
313 | throw new TypeError('name parameter is an empty string') | |
314 | } | |
315 | } | |
316 | ||
a038b517 JB |
317 | /** |
318 | * Handles the ready message sent by the main worker. | |
319 | * | |
320 | * @param message - The ready message. | |
321 | */ | |
322 | protected abstract handleReadyMessage (message: MessageValue<Data>): void | |
323 | ||
aee46736 JB |
324 | /** |
325 | * Worker message listener. | |
326 | * | |
6b813701 | 327 | * @param message - The received message. |
aee46736 | 328 | */ |
85aeb3f3 | 329 | protected messageListener (message: MessageValue<Data>): void { |
9e746eec | 330 | this.checkMessageWorkerId(message) |
310de0aa JB |
331 | if (message.statistics != null) { |
332 | // Statistics message received | |
333 | this.statistics = message.statistics | |
334 | } else if (message.checkActive != null) { | |
335 | // Check active message received | |
336 | message.checkActive ? this.startCheckActive() : this.stopCheckActive() | |
6703b9f4 JB |
337 | } else if (message.taskFunctionOperation != null) { |
338 | // Task function operation message received | |
339 | this.handleTaskFunctionOperationMessage(message) | |
310de0aa JB |
340 | } else if (message.taskId != null && message.data != null) { |
341 | // Task message received | |
342 | this.run(message) | |
343 | } else if (message.kill === true) { | |
344 | // Kill message received | |
345 | this.handleKillMessage(message) | |
cf597bc5 JB |
346 | } |
347 | } | |
348 | ||
6703b9f4 JB |
349 | protected handleTaskFunctionOperationMessage ( |
350 | message: MessageValue<Data> | |
351 | ): void { | |
352 | const { taskFunctionOperation, taskFunction, taskFunctionName } = message | |
353 | let response!: TaskFunctionOperationReturnType | |
edbc15c6 | 354 | if (taskFunctionOperation === 'add') { |
6703b9f4 JB |
355 | response = this.addTaskFunction( |
356 | taskFunctionName as string, | |
357 | // eslint-disable-next-line @typescript-eslint/no-implied-eval, no-new-func | |
358 | new Function(`return ${taskFunction as string}`)() as TaskFunction< | |
359 | Data, | |
360 | Response | |
361 | > | |
362 | ) | |
363 | } else if (taskFunctionOperation === 'remove') { | |
364 | response = this.removeTaskFunction(taskFunctionName as string) | |
365 | } else if (taskFunctionOperation === 'default') { | |
366 | response = this.setDefaultTaskFunction(taskFunctionName as string) | |
367 | } | |
368 | this.sendToMainWorker({ | |
369 | taskFunctionOperation, | |
370 | taskFunctionOperationStatus: response.status, | |
371 | workerError: { | |
372 | name: taskFunctionName as string, | |
373 | message: this.handleError(response.error as Error | string) | |
895b5341 | 374 | } |
6703b9f4 JB |
375 | }) |
376 | } | |
377 | ||
984dc9c8 JB |
378 | /** |
379 | * Handles a kill message sent by the main worker. | |
380 | * | |
381 | * @param message - The kill message. | |
382 | */ | |
383 | protected handleKillMessage (message: MessageValue<Data>): void { | |
29d8b961 | 384 | this.stopCheckActive() |
07588f30 | 385 | if (isAsyncFunction(this.opts.killHandler)) { |
041dc05b | 386 | (this.opts.killHandler?.() as Promise<void>) |
1e3214b6 | 387 | .then(() => { |
895b5341 | 388 | this.sendToMainWorker({ kill: 'success' }) |
1e3214b6 JB |
389 | return null |
390 | }) | |
391 | .catch(() => { | |
895b5341 | 392 | this.sendToMainWorker({ kill: 'failure' }) |
1e3214b6 JB |
393 | }) |
394 | .finally(() => { | |
395 | this.emitDestroy() | |
396 | }) | |
07588f30 JB |
397 | .catch(EMPTY_FUNCTION) |
398 | } else { | |
1e3214b6 JB |
399 | try { |
400 | // eslint-disable-next-line @typescript-eslint/no-invalid-void-type | |
401 | this.opts.killHandler?.() as void | |
895b5341 | 402 | this.sendToMainWorker({ kill: 'success' }) |
7c8ac84e | 403 | } catch { |
895b5341 | 404 | this.sendToMainWorker({ kill: 'failure' }) |
1e3214b6 JB |
405 | } finally { |
406 | this.emitDestroy() | |
407 | } | |
07588f30 | 408 | } |
984dc9c8 JB |
409 | } |
410 | ||
9e746eec JB |
411 | /** |
412 | * Check if the message worker id is set and matches the worker id. | |
413 | * | |
414 | * @param message - The message to check. | |
415 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id. | |
416 | */ | |
417 | private checkMessageWorkerId (message: MessageValue<Data>): void { | |
418 | if (message.workerId == null) { | |
419 | throw new Error('Message worker id is not set') | |
420 | } else if (message.workerId != null && message.workerId !== this.id) { | |
421 | throw new Error( | |
422 | `Message worker id ${message.workerId} does not match the worker id ${this.id}` | |
423 | ) | |
424 | } | |
425 | } | |
426 | ||
48487131 | 427 | /** |
b0a4db63 | 428 | * Starts the worker check active interval. |
48487131 | 429 | */ |
b0a4db63 | 430 | private startCheckActive (): void { |
75d3401a | 431 | this.lastTaskTimestamp = performance.now() |
b0a4db63 JB |
432 | this.activeInterval = setInterval( |
433 | this.checkActive.bind(this), | |
75d3401a | 434 | (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 |
984dc9c8 | 435 | ) |
75d3401a JB |
436 | } |
437 | ||
48487131 | 438 | /** |
b0a4db63 | 439 | * Stops the worker check active interval. |
48487131 | 440 | */ |
b0a4db63 | 441 | private stopCheckActive (): void { |
c3f498b5 JB |
442 | if (this.activeInterval != null) { |
443 | clearInterval(this.activeInterval) | |
444 | delete this.activeInterval | |
445 | } | |
48487131 JB |
446 | } |
447 | ||
448 | /** | |
449 | * Checks if the worker should be terminated, because its living too long. | |
450 | */ | |
b0a4db63 | 451 | private checkActive (): void { |
48487131 JB |
452 | if ( |
453 | performance.now() - this.lastTaskTimestamp > | |
454 | (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) | |
455 | ) { | |
895b5341 | 456 | this.sendToMainWorker({ kill: this.opts.killBehavior }) |
48487131 JB |
457 | } |
458 | } | |
459 | ||
729c563d S |
460 | /** |
461 | * Returns the main worker. | |
838898f1 S |
462 | * |
463 | * @returns Reference to the main worker. | |
155bb3de | 464 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set. |
729c563d | 465 | */ |
838898f1 | 466 | protected getMainWorker (): MainWorker { |
78cea37e | 467 | if (this.mainWorker == null) { |
e102732c | 468 | throw new Error('Main worker not set') |
838898f1 S |
469 | } |
470 | return this.mainWorker | |
471 | } | |
c97c7edb | 472 | |
729c563d | 473 | /** |
aa9eede8 | 474 | * Sends a message to main worker. |
729c563d | 475 | * |
38e795c1 | 476 | * @param message - The response message. |
729c563d | 477 | */ |
82f36766 JB |
478 | protected abstract sendToMainWorker ( |
479 | message: MessageValue<Response, Data> | |
480 | ): void | |
c97c7edb | 481 | |
90d7d101 | 482 | /** |
e81c38f2 | 483 | * Sends task function names to the main worker. |
90d7d101 | 484 | */ |
e81c38f2 | 485 | protected sendTaskFunctionNamesToMainWorker (): void { |
90d7d101 | 486 | this.sendToMainWorker({ |
895b5341 | 487 | taskFunctionNames: this.listTaskFunctionNames() |
90d7d101 JB |
488 | }) |
489 | } | |
490 | ||
729c563d | 491 | /** |
8accb8d5 | 492 | * Handles an error and convert it to a string so it can be sent back to the main worker. |
729c563d | 493 | * |
6703b9f4 | 494 | * @param error - The error raised by the worker. |
ab80dc46 | 495 | * @returns The error message. |
729c563d | 496 | */ |
6703b9f4 JB |
497 | protected handleError (error: Error | string): string { |
498 | return error instanceof Error ? error.message : error | |
c97c7edb S |
499 | } |
500 | ||
5c4d16da JB |
501 | /** |
502 | * Runs the given task. | |
503 | * | |
504 | * @param task - The task to execute. | |
505 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found. | |
506 | */ | |
507 | protected run (task: Task<Data>): void { | |
9d2d0da1 JB |
508 | const { name, taskId, data } = task |
509 | const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME) | |
510 | if (fn == null) { | |
511 | this.sendToMainWorker({ | |
6703b9f4 | 512 | workerError: { |
9d2d0da1 JB |
513 | name: name as string, |
514 | message: `Task function '${name as string}' not found`, | |
515 | data | |
516 | }, | |
9d2d0da1 JB |
517 | taskId |
518 | }) | |
519 | return | |
520 | } | |
5c4d16da JB |
521 | if (isAsyncFunction(fn)) { |
522 | this.runInAsyncScope(this.runAsync.bind(this), this, fn, task) | |
523 | } else { | |
524 | this.runInAsyncScope(this.runSync.bind(this), this, fn, task) | |
525 | } | |
526 | } | |
527 | ||
729c563d | 528 | /** |
4dd93fcf | 529 | * Runs the given task function synchronously. |
729c563d | 530 | * |
5c4d16da JB |
531 | * @param fn - Task function that will be executed. |
532 | * @param task - Input data for the task function. | |
729c563d | 533 | */ |
70a4f5ea | 534 | protected runSync ( |
82ea6492 | 535 | fn: TaskSyncFunction<Data, Response>, |
5c4d16da | 536 | task: Task<Data> |
c97c7edb | 537 | ): void { |
310de0aa | 538 | const { name, taskId, data } = task |
c97c7edb | 539 | try { |
310de0aa JB |
540 | let taskPerformance = this.beginTaskPerformance(name) |
541 | const res = fn(data) | |
d715b7bc | 542 | taskPerformance = this.endTaskPerformance(taskPerformance) |
3fafb1b2 JB |
543 | this.sendToMainWorker({ |
544 | data: res, | |
d715b7bc | 545 | taskPerformance, |
310de0aa | 546 | taskId |
3fafb1b2 | 547 | }) |
6703b9f4 | 548 | } catch (error) { |
91ee39ed | 549 | this.sendToMainWorker({ |
6703b9f4 | 550 | workerError: { |
0628755c | 551 | name: name as string, |
6703b9f4 | 552 | message: this.handleError(error as Error | string), |
310de0aa | 553 | data |
82f36766 | 554 | }, |
310de0aa | 555 | taskId |
91ee39ed | 556 | }) |
6e9d10db | 557 | } finally { |
c3f498b5 | 558 | this.updateLastTaskTimestamp() |
c97c7edb S |
559 | } |
560 | } | |
561 | ||
729c563d | 562 | /** |
4dd93fcf | 563 | * Runs the given task function asynchronously. |
729c563d | 564 | * |
5c4d16da JB |
565 | * @param fn - Task function that will be executed. |
566 | * @param task - Input data for the task function. | |
729c563d | 567 | */ |
c97c7edb | 568 | protected runAsync ( |
82ea6492 | 569 | fn: TaskAsyncFunction<Data, Response>, |
5c4d16da | 570 | task: Task<Data> |
c97c7edb | 571 | ): void { |
310de0aa JB |
572 | const { name, taskId, data } = task |
573 | let taskPerformance = this.beginTaskPerformance(name) | |
574 | fn(data) | |
041dc05b | 575 | .then(res => { |
d715b7bc | 576 | taskPerformance = this.endTaskPerformance(taskPerformance) |
3fafb1b2 JB |
577 | this.sendToMainWorker({ |
578 | data: res, | |
d715b7bc | 579 | taskPerformance, |
310de0aa | 580 | taskId |
3fafb1b2 | 581 | }) |
c97c7edb S |
582 | return null |
583 | }) | |
6703b9f4 | 584 | .catch(error => { |
91ee39ed | 585 | this.sendToMainWorker({ |
6703b9f4 | 586 | workerError: { |
0628755c | 587 | name: name as string, |
6703b9f4 | 588 | message: this.handleError(error as Error | string), |
310de0aa | 589 | data |
82f36766 | 590 | }, |
310de0aa | 591 | taskId |
91ee39ed | 592 | }) |
6e9d10db JB |
593 | }) |
594 | .finally(() => { | |
c3f498b5 | 595 | this.updateLastTaskTimestamp() |
c97c7edb | 596 | }) |
6e9d10db | 597 | .catch(EMPTY_FUNCTION) |
c97c7edb | 598 | } |
ec8fd331 | 599 | |
197b4aa5 | 600 | private beginTaskPerformance (name?: string): TaskPerformance { |
8a970421 | 601 | this.checkStatistics() |
62c15a68 | 602 | return { |
ff128cc9 | 603 | name: name ?? DEFAULT_TASK_NAME, |
1c6fe997 | 604 | timestamp: performance.now(), |
b6b32453 | 605 | ...(this.statistics.elu && { elu: performance.eventLoopUtilization() }) |
62c15a68 JB |
606 | } |
607 | } | |
608 | ||
d9d31201 JB |
609 | private endTaskPerformance ( |
610 | taskPerformance: TaskPerformance | |
611 | ): TaskPerformance { | |
8a970421 | 612 | this.checkStatistics() |
62c15a68 JB |
613 | return { |
614 | ...taskPerformance, | |
b6b32453 JB |
615 | ...(this.statistics.runTime && { |
616 | runTime: performance.now() - taskPerformance.timestamp | |
617 | }), | |
618 | ...(this.statistics.elu && { | |
62c15a68 | 619 | elu: performance.eventLoopUtilization(taskPerformance.elu) |
b6b32453 | 620 | }) |
62c15a68 JB |
621 | } |
622 | } | |
8a970421 JB |
623 | |
624 | private checkStatistics (): void { | |
625 | if (this.statistics == null) { | |
626 | throw new Error('Performance statistics computation requirements not set') | |
627 | } | |
628 | } | |
c3f498b5 JB |
629 | |
630 | private updateLastTaskTimestamp (): void { | |
29d8b961 | 631 | if (this.activeInterval != null) { |
c3f498b5 JB |
632 | this.lastTaskTimestamp = performance.now() |
633 | } | |
634 | } | |
c97c7edb | 635 | } |