import { AsyncResource } from 'node:async_hooks'
import type { Worker } from 'node:cluster'
import type { MessagePort } from 'node:worker_threads'
-import type { MessageValue } from '../utility-types'
-import { EMPTY_FUNCTION } from '../utils'
-import type { KillBehavior, WorkerOptions } from './worker-options'
-import { KillBehaviors } from './worker-options'
+import { performance } from 'node:perf_hooks'
+import type {
+ MessageValue,
+ TaskPerformance,
+ WorkerStatistics
+} from '../utility-types'
+import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import {
+ type KillBehavior,
+ 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
Data = unknown,
Response = unknown
> extends AsyncResource {
+ /**
+ * Task function(s) processed by the worker when the pool's `execution` function is invoked.
+ */
+ protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
/**
* 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.
*/
*
* @param type - The type of async event.
* @param isMain - Whether this is the main worker or not.
- * @param fn - Function 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.
*/
public constructor (
type: string,
protected readonly isMain: boolean,
- fn: (data: Data) => Response,
+ taskFunctions:
+ | WorkerFunction<Data, Response>
+ | TaskFunctions<Data, Response>,
protected mainWorker: MainWorker | undefined | null,
protected readonly opts: WorkerOptions = {
/**
}
) {
super(type)
- this.checkFunctionInput(fn)
this.checkWorkerOptions(this.opts)
+ this.checkTaskFunctions(taskFunctions)
if (!this.isMain) {
this.lastTaskTimestamp = performance.now()
this.aliveInterval = setInterval(
)
this.checkAlive.bind(this)()
}
+ this.mainWorker?.on('message', this.messageListener.bind(this))
+ }
- this.mainWorker?.on(
- 'message',
- (message: MessageValue<Data, MainWorker>) => {
- this.messageListener(message, fn)
+ private checkWorkerOptions (opts: WorkerOptions): void {
+ this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
+ this.opts.maxInactiveTime =
+ opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
+ 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:
+ | WorkerFunction<Data, Response>
+ | TaskFunctions<Data, Response>
+ ): void {
+ if (taskFunctions == null) {
+ throw new Error('taskFunctions parameter is mandatory')
+ }
+ this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
+ 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 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 {
+ throw new TypeError(
+ 'taskFunctions parameter is not a function or a plain object'
+ )
+ }
}
/**
* Worker message listener.
*
* @param message - Message received.
- * @param fn - Function processed by the worker when the pool's `execution` function is invoked.
*/
- protected messageListener (
- message: MessageValue<Data, MainWorker>,
- fn: (data: Data) => Response
- ): void {
- if (message.data != null && message.id != null) {
+ protected messageListener (message: MessageValue<Data, MainWorker>): void {
+ if (message.id != null && message.data != null) {
// Task message received
- if (this.opts.async === true) {
+ 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
// Kill message received
this.aliveInterval != null && clearInterval(this.aliveInterval)
this.emitDestroy()
- }
- }
-
- 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
- }
-
- /**
- * Checks if the `fn` parameter is passed to the constructor.
- *
- * @param fn - The function that should be defined.
- */
- private checkFunctionInput (fn: (data: Data) => Response): void {
- if (fn == null) throw new Error('fn parameter is mandatory')
- if (typeof fn !== 'function') {
- throw new TypeError('fn parameter is not a function')
+ } else if (message.statistics != null) {
+ // Statistics message received
+ this.statistics = message.statistics
}
}
* @param fn - Function that will be executed.
* @param message - Input data for the given function.
*/
- protected run (
- fn: (data?: Data) => Response,
+ protected runSync (
+ fn: WorkerSyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
try {
- const startTimestamp = performance.now()
+ let taskPerformance = this.beginTaskPerformance(message)
const res = fn(message.data)
- const runTime = performance.now() - startTimestamp
+ taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
- id: message.id,
- runTime
+ taskPerformance,
+ 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())
}
* @param message - Input data for the given function.
*/
protected runAsync (
- fn: (data?: Data) => Promise<Response>,
+ fn: WorkerAsyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
- const startTimestamp = performance.now()
+ let taskPerformance = this.beginTaskPerformance(message)
fn(message.data)
.then(res => {
- const runTime = performance.now() - startTimestamp
+ taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
- id: message.id,
- runTime
+ taskPerformance,
+ 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 beginTaskPerformance (message: MessageValue<Data>): TaskPerformance {
+ const timestamp = performance.now()
+ return {
+ timestamp,
+ ...(this.statistics.waitTime && {
+ waitTime: timestamp - (message.timestamp ?? timestamp)
+ }),
+ ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
+ }
+ }
+
+ private endTaskPerformance (
+ taskPerformance: TaskPerformance
+ ): TaskPerformance {
+ return {
+ ...taskPerformance,
+ ...(this.statistics.runTime && {
+ runTime: performance.now() - taskPerformance.timestamp
+ }),
+ ...(this.statistics.elu && {
+ elu: performance.eventLoopUtilization(taskPerformance.elu)
+ })
+ }
+ }
}
repositories / poolifier.git / blobdiff