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