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