-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
worker.ts
397 lines (379 loc) · 8.5 KB
/
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
import type { EventEmitter } from 'node:events'
import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
import type { CircularArray } from '../circular-array.js'
import type { Task, TaskFunctionProperties } from '../utility-types.js'
/**
* Callback invoked when the worker has started successfully.
*
* @typeParam Worker - Type of worker.
*/
export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
/**
* Callback invoked if the worker has received a message.
*
* @typeParam Worker - Type of worker.
*/
export type MessageHandler<Worker extends IWorker> = (
this: Worker,
message: unknown
) => void
/**
* Callback invoked if the worker raised an error.
*
* @typeParam Worker - Type of worker.
*/
export type ErrorHandler<Worker extends IWorker> = (
this: Worker,
error: Error
) => void
/**
* Callback invoked when the worker exits successfully.
*
* @typeParam Worker - Type of worker.
*/
export type ExitHandler<Worker extends IWorker> = (
this: Worker,
exitCode: number
) => void
/**
* Worker event handler.
*
* @typeParam Worker - Type of worker.
*/
export type EventHandler<Worker extends IWorker> =
| OnlineHandler<Worker>
| MessageHandler<Worker>
| ErrorHandler<Worker>
| ExitHandler<Worker>
/**
* Measurement statistics.
*
* @internal
*/
export interface MeasurementStatistics {
/**
* Measurement aggregate.
*/
aggregate?: number
/**
* Measurement minimum.
*/
minimum?: number
/**
* Measurement maximum.
*/
maximum?: number
/**
* Measurement average.
*/
average?: number
/**
* Measurement median.
*/
median?: number
/**
* Measurement history.
*/
readonly history: CircularArray<number>
}
/**
* Event loop utilization measurement statistics.
*
* @internal
*/
export interface EventLoopUtilizationMeasurementStatistics {
readonly idle: MeasurementStatistics
readonly active: MeasurementStatistics
utilization?: number
}
/**
* Task statistics.
*
* @internal
*/
export interface TaskStatistics {
/**
* Number of executed tasks.
*/
executed: number
/**
* Number of executing tasks.
*/
executing: number
/**
* Number of queued tasks.
*/
readonly queued: number
/**
* Maximum number of queued tasks.
*/
readonly maxQueued?: number
/**
* Number of sequentially stolen tasks.
*/
sequentiallyStolen: number
/**
* Number of stolen tasks.
*/
stolen: number
/**
* Number of failed tasks.
*/
failed: number
}
/**
* Enumeration of worker types.
*/
export const WorkerTypes: Readonly<{ thread: 'thread', cluster: 'cluster' }> =
Object.freeze({
thread: 'thread',
cluster: 'cluster'
} as const)
/**
* Worker type.
*/
export type WorkerType = keyof typeof WorkerTypes
/**
* Worker information.
*
* @internal
*/
export interface WorkerInfo {
/**
* Worker id.
*/
readonly id: number | undefined
/**
* Worker type.
*/
readonly type: WorkerType
/**
* Dynamic flag.
*/
dynamic: boolean
/**
* Ready flag.
*/
ready: boolean
/**
* Stealing flag.
* This flag is set to `true` when worker node is stealing tasks from another worker node.
*/
stealing: boolean
/**
* Back pressure flag.
* This flag is set to `true` when worker node tasks queue has back pressure.
*/
backPressure: boolean
/**
* Task functions properties.
*/
taskFunctionsProperties?: TaskFunctionProperties[]
}
/**
* Worker usage statistics.
*
* @internal
*/
export interface WorkerUsage {
/**
* Tasks statistics.
*/
readonly tasks: TaskStatistics
/**
* Tasks runtime statistics.
*/
readonly runTime: MeasurementStatistics
/**
* Tasks wait time statistics.
*/
readonly waitTime: MeasurementStatistics
/**
* Tasks event loop utilization statistics.
*/
readonly elu: EventLoopUtilizationMeasurementStatistics
}
/**
* Worker choice strategy data.
*
* @internal
*/
export interface StrategyData {
virtualTaskEndTimestamp?: number
}
/**
* Worker interface.
*/
export interface IWorker extends EventEmitter {
/**
* Cluster worker id.
*/
readonly id?: number
/**
* Worker thread worker id.
*/
readonly threadId?: number
/**
* Registers an event handler.
*
* @param event - The event.
* @param handler - The event handler.
*/
readonly on: (event: string, handler: EventHandler<this>) => this
/**
* Registers once an event handler.
*
* @param event - The event.
* @param handler - The event handler.
*/
readonly once: (event: string, handler: EventHandler<this>) => this
/**
* Calling `unref()` on a worker allows the thread to exit if this is the only
* active handle in the event system. If the worker is already `unref()`ed calling`unref()` again has no effect.
* @since v10.5.0
*/
readonly unref?: () => void
/**
* Stop all JavaScript execution in the worker thread as soon as possible.
* Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted.
*/
readonly terminate?: () => Promise<number>
/**
* Cluster worker disconnect.
*/
readonly disconnect?: () => void
/**
* Cluster worker kill.
*/
readonly kill?: (signal?: string) => void
}
/**
* Worker node options.
*
* @internal
*/
export interface WorkerNodeOptions {
workerOptions?: WorkerOptions
env?: Record<string, unknown>
tasksQueueBackPressureSize: number | undefined
tasksQueueBucketSize: number | undefined
}
/**
* Worker node interface.
*
* @typeParam Worker - Type of worker.
* @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
* @internal
*/
export interface IWorkerNode<Worker extends IWorker, Data = unknown>
extends EventEmitter {
/**
* Worker.
*/
readonly worker: Worker
/**
* Worker info.
*/
readonly info: WorkerInfo
/**
* Worker usage statistics.
*/
readonly usage: WorkerUsage
/**
* Worker choice strategy data.
* This is used to store data that are specific to the worker choice strategy.
*/
strategyData?: StrategyData
/**
* Message channel (worker thread only).
*/
readonly messageChannel?: MessageChannel
/**
* Tasks queue back pressure size.
* This is the number of tasks that can be enqueued before the worker node has back pressure.
*/
tasksQueueBackPressureSize: number
/**
* Tasks queue size.
*
* @returns The tasks queue size.
*/
readonly tasksQueueSize: () => number
/**
* Enqueue task.
*
* @param task - The task to queue.
* @returns The tasks queue size.
*/
readonly enqueueTask: (task: Task<Data>) => number
/**
* Dequeue task.
*
* @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
* @returns The dequeued task.
*/
readonly dequeueTask: (bucket?: number) => Task<Data> | undefined
/**
* Dequeue last prioritized task.
*
* @returns The dequeued task.
*/
readonly dequeueLastPrioritizedTask: () => Task<Data> | undefined
/**
* Clears tasks queue.
*/
readonly clearTasksQueue: () => void
/**
* Whether the worker node has back pressure (i.e. its tasks queue is full).
*
* @returns `true` if the worker node has back pressure, `false` otherwise.
*/
readonly hasBackPressure: () => boolean
/**
* Terminates the worker node.
*/
readonly terminate: () => Promise<void>
/**
* Registers a worker event handler.
*
* @param event - The event.
* @param handler - The event handler.
*/
readonly registerWorkerEventHandler: (
event: string,
handler: EventHandler<Worker>
) => void
/**
* Registers once a worker event handler.
*
* @param event - The event.
* @param handler - The event handler.
*/
readonly registerOnceWorkerEventHandler: (
event: string,
handler: EventHandler<Worker>
) => void
/**
* Gets task function worker usage statistics.
*
* @param name - The task function name.
* @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
*/
readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
/**
* Deletes task function worker usage statistics.
*
* @param name - The task function name.
* @returns `true` if the task function worker usage statistics were deleted, `false` otherwise.
*/
readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean
}
/**
* Worker node event detail.
*
* @internal
*/
export interface WorkerNodeEventDetail {
workerId?: number
workerNodeKey?: number
}