import { AsyncResource } from 'node:async_hooks'
import type { Worker } from 'node:cluster'
import type { MessagePort } from 'node:worker_threads'
-import {
- type MessageValue,
- type TaskFunctions,
- type WorkerAsyncFunction,
- type WorkerFunction,
- type WorkerSyncFunction
+import { type EventLoopUtilization, performance } from 'node:perf_hooks'
+import type {
+ MessageValue,
+ TaskFunctions,
+ WorkerAsyncFunction,
+ WorkerFunction,
+ WorkerSyncFunction
} from '../utility-types'
-import { EMPTY_FUNCTION } from '../utils'
-import type { KillBehavior, WorkerOptions } from './worker-options'
-import { KillBehaviors } from './worker-options'
+import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import {
+ type KillBehavior,
+ KillBehaviors,
+ type WorkerOptions
+} from './worker-options'
+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.
*
*
* @param type - The type of async event.
* @param isMain - Whether this is the main worker or not.
- * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
+ * @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 mainWorker - Reference to main worker.
* @param opts - Options for the worker.
*/
this.checkAlive.bind(this)()
}
- this.mainWorker?.on(
- 'message',
- (message: MessageValue<Data, MainWorker>) => {
- this.messageListener(message)
- }
- )
+ this.mainWorker?.on('message', this.messageListener.bind(this))
}
private checkWorkerOptions (opts: WorkerOptions): void {
this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
this.opts.maxInactiveTime =
opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
- this.opts.async = opts.async ?? false
+ delete this.opts.async
}
/**
* Checks if the `taskFunctions` parameter is passed to the constructor.
*
- * @param taskFunctions - The task function(s) that should be defined.
+ * @param taskFunctions - The task function(s) parameter that should be checked.
*/
private checkTaskFunctions (
taskFunctions:
| WorkerFunction<Data, Response>
| TaskFunctions<Data, Response>
): void {
- if (taskFunctions == null) { throw new Error('taskFunctions parameter is mandatory') }
- if (
- typeof taskFunctions !== 'function' &&
- typeof taskFunctions !== 'object'
- ) {
- throw new Error('taskFunctions parameter is not a function or an object')
- }
- if (
- typeof taskFunctions === 'object' &&
- taskFunctions.constructor !== Object &&
- Object.prototype.toString.call(taskFunctions) !== '[object Object]'
- ) {
- throw new Error('taskFunctions parameter is not an object literal')
+ if (taskFunctions == null) {
+ throw new Error('taskFunctions parameter is mandatory')
}
this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
- if (typeof taskFunctions !== 'function') {
+ if (typeof taskFunctions === 'function') {
+ this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+ } else if (isPlainObject(taskFunctions)) {
+ let firstEntry = true
for (const [name, fn] of Object.entries(taskFunctions)) {
if (typeof fn !== 'function') {
- throw new Error(
+ throw new TypeError(
'A taskFunctions parameter object value is not a function'
)
}
this.taskFunctions.set(name, fn.bind(this))
+ if (firstEntry) {
+ this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
+ firstEntry = false
+ }
+ }
+ if (firstEntry) {
+ throw new Error('taskFunctions parameter object is empty')
}
} else {
- this.taskFunctions.set('default', taskFunctions.bind(this))
+ throw new TypeError(
+ 'taskFunctions parameter is not a function or a plain object'
+ )
}
}
*/
protected messageListener (message: MessageValue<Data, MainWorker>): void {
if (message.id != null && message.data != null) {
- let fn: WorkerFunction<Data, Response> | undefined
- if (message.name == null) {
- fn = this.taskFunctions.get('default')
- } else {
- fn = this.taskFunctions.get(message.name)
- }
// Task message received
+ const fn = this.getTaskFunction(message.name)
if (fn?.constructor.name === 'AsyncFunction') {
this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
} else {
- this.runInAsyncScope(this.run.bind(this), this, fn, message)
+ this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
}
} else if (message.parent != null) {
// Main worker reference message received
* @param fn - Function that will be executed.
* @param message - Input data for the given function.
*/
- protected run (
+ protected runSync (
fn: WorkerSyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
try {
- const startTimestamp = performance.now()
+ const taskPerformance = this.beforeTaskRunHook(message)
const res = fn(message.data)
- const runTime = performance.now() - startTimestamp
+ const { runTime, waitTime, elu } = this.afterTaskRunHook(taskPerformance)
this.sendToMainWorker({
data: res,
- id: message.id,
- runTime
+ runTime,
+ waitTime,
+ elu,
+ id: message.id
})
} catch (e) {
const err = this.handleError(e as Error)
- this.sendToMainWorker({ error: err, id: message.id })
+ this.sendToMainWorker({
+ error: err,
+ errorData: message.data,
+ id: message.id
+ })
} finally {
!this.isMain && (this.lastTaskTimestamp = performance.now())
}
fn: WorkerAsyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
- const startTimestamp = performance.now()
+ const taskPerformance = this.beforeTaskRunHook(message)
fn(message.data)
.then(res => {
- const runTime = performance.now() - startTimestamp
+ const { runTime, waitTime, elu } =
+ this.afterTaskRunHook(taskPerformance)
this.sendToMainWorker({
data: res,
- id: message.id,
- runTime
+ runTime,
+ waitTime,
+ elu,
+ id: message.id
})
return null
})
.catch(e => {
const err = this.handleError(e as Error)
- this.sendToMainWorker({ error: err, id: message.id })
+ this.sendToMainWorker({
+ error: err,
+ errorData: message.data,
+ id: message.id
+ })
})
.finally(() => {
!this.isMain && (this.lastTaskTimestamp = performance.now())
})
.catch(EMPTY_FUNCTION)
}
+
+ /**
+ * Gets the task function in the given scope.
+ *
+ * @param name - Name of the function that will be returned.
+ */
+ private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
+ name = name ?? DEFAULT_FUNCTION_NAME
+ const fn = this.taskFunctions.get(name)
+ if (fn == null) {
+ throw new Error(`Task function '${name}' not found`)
+ }
+ return fn
+ }
+
+ private beforeTaskRunHook (message: MessageValue<Data>): TaskPerformance {
+ // TODO: conditional accounting
+ const timestamp = performance.now()
+ return {
+ timestamp,
+ waitTime: timestamp - (message.submissionTimestamp ?? 0),
+ elu: performance.eventLoopUtilization()
+ }
+ }
+
+ private afterTaskRunHook (taskPerformance: TaskPerformance): TaskPerformance {
+ return {
+ ...taskPerformance,
+ ...{
+ runTime: performance.now() - taskPerformance.timestamp,
+ elu: performance.eventLoopUtilization(taskPerformance.elu)
+ }
+ }
+ }
}
repositories / poolifier.git / blobdiff