import { AsyncResource } from 'node:async_hooks'
import type { Worker } from 'node:cluster'
import type { MessagePort } from 'node:worker_threads'
-import { type EventLoopUtilization, performance } from 'node:perf_hooks'
+import { performance } from 'node:perf_hooks'
import type {
MessageValue,
- TaskFunctions,
- WorkerAsyncFunction,
- WorkerFunction,
- WorkerSyncFunction
+ TaskPerformance,
+ WorkerStatistics
} from '../utility-types'
import { EMPTY_FUNCTION, isPlainObject } from '../utils'
import {
KillBehaviors,
type WorkerOptions
} from './worker-options'
+import type {
+ TaskFunctions,
+ WorkerAsyncFunction,
+ WorkerFunction,
+ WorkerSyncFunction
+} from './worker-functions'
const DEFAULT_FUNCTION_NAME = 'default'
const DEFAULT_MAX_INACTIVE_TIME = 60000
const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
-interface TaskPerformance {
- timestamp: number
- waitTime: number
- runTime?: number
- elu: EventLoopUtilization
-}
-
/**
* Base class that implements some shared logic for all poolifier workers.
*
* Timestamp of the last task processed by this worker.
*/
protected lastTaskTimestamp!: number
+ /**
+ * Performance statistics computation.
+ */
+ protected statistics!: WorkerStatistics
/**
* Handler id of the `aliveInterval` worker alive check.
*/
)
this.checkAlive.bind(this)()
}
-
this.mainWorker?.on('message', this.messageListener.bind(this))
}
*
* @param message - Message received.
*/
- protected messageListener (message: MessageValue<Data, MainWorker>): void {
+ protected messageListener (
+ message: MessageValue<Data, Data, MainWorker>
+ ): void {
if (message.id != null && message.data != null) {
// Task message received
const fn = this.getTaskFunction(message.name)
// Kill message received
this.aliveInterval != null && clearInterval(this.aliveInterval)
this.emitDestroy()
+ } else if (message.statistics != null) {
+ // Statistics message received
+ this.statistics = message.statistics
}
}
*
* @param message - The response message.
*/
- protected abstract sendToMainWorker (message: MessageValue<Response>): void
+ protected abstract sendToMainWorker (
+ message: MessageValue<Response, Data>
+ ): void
/**
* Checks if the worker should be terminated, because its living too long.
message: MessageValue<Data>
): void {
try {
- const taskPerformance = this.beforeTaskRunHook(message)
+ let taskPerformance = this.beginTaskPerformance(message)
const res = fn(message.data)
- const { runTime, waitTime, elu } = this.afterTaskRunHook(taskPerformance)
+ taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
- runTime,
- waitTime,
- elu,
+ taskPerformance,
id: message.id
})
} catch (e) {
const err = this.handleError(e as Error)
this.sendToMainWorker({
- error: err,
- errorData: message.data,
+ taskError: {
+ message: err,
+ data: message.data
+ },
id: message.id
})
} finally {
fn: WorkerAsyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
- const taskPerformance = this.beforeTaskRunHook(message)
+ let taskPerformance = this.beginTaskPerformance(message)
fn(message.data)
.then(res => {
- const { runTime, waitTime, elu } =
- this.afterTaskRunHook(taskPerformance)
+ taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
- runTime,
- waitTime,
- elu,
+ taskPerformance,
id: message.id
})
return null
.catch(e => {
const err = this.handleError(e as Error)
this.sendToMainWorker({
- error: err,
- errorData: message.data,
+ taskError: {
+ message: err,
+ data: message.data
+ },
id: message.id
})
})
return fn
}
- private beforeTaskRunHook (message: MessageValue<Data>): TaskPerformance {
- // TODO: conditional accounting
+ private beginTaskPerformance (message: MessageValue<Data>): TaskPerformance {
const timestamp = performance.now()
return {
timestamp,
- waitTime: timestamp - (message.submissionTimestamp ?? 0),
- elu: performance.eventLoopUtilization()
+ ...(this.statistics.waitTime && {
+ waitTime: timestamp - (message.timestamp ?? timestamp)
+ }),
+ ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
}
}
- private afterTaskRunHook (taskPerformance: TaskPerformance): TaskPerformance {
+ private endTaskPerformance (
+ taskPerformance: TaskPerformance
+ ): TaskPerformance {
return {
...taskPerformance,
- ...{
- runTime: performance.now() - taskPerformance.timestamp,
+ ...(this.statistics.runTime && {
+ runTime: performance.now() - taskPerformance.timestamp
+ }),
+ ...(this.statistics.elu && {
elu: performance.eventLoopUtilization(taskPerformance.elu)
- }
+ })
}
}
}