-import { AsyncResource } from 'async_hooks'
-import type { Worker } from 'cluster'
-import type { MessagePort } from '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 { 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,
+ TaskPerformance,
+ WorkerStatistics
+} from '../utility-types'
+import { EMPTY_FUNCTION, isAsyncFunction, 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
/**
* Base class that implements some shared logic for all poolifier workers.
*
- * @template MainWorker Type of main worker.
- * @template Data Type of data this worker receives from pool's execution. This can only be serializable data.
- * @template Response Type of response the worker sends back to the main worker. This can only be serializable data.
+ * @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, WorkerFunction<Data, Response>>
/**
* Timestamp of the last task processed by this worker.
*/
- protected lastTaskTimestamp: number
+ protected lastTaskTimestamp!: number
/**
- * Handler Id of the `aliveInterval` worker alive check.
+ * Performance statistics computation requirements.
*/
- protected readonly aliveInterval?: NodeJS.Timeout
+ protected statistics!: WorkerStatistics
/**
- * Options for the worker.
+ * Handler id of the `aliveInterval` worker alive check.
*/
- public readonly opts: WorkerOptions
+ protected readonly aliveInterval?: 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 fn Function processed by the worker when the pool's `execution` function is invoked.
- * @param mainWorker Reference to main worker.
- * @param opts Options for the worker.
+ * @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. The first function is the default function.
+ * @param mainWorker - Reference to main worker.
+ * @param opts - Options for the worker.
*/
public constructor (
type: string,
- isMain: boolean,
- fn: (data: Data) => Response,
- protected mainWorker: MainWorker | undefined | null,
- opts: WorkerOptions = {
+ protected readonly isMain: boolean,
+ taskFunctions:
+ | WorkerFunction<Data, Response>
+ | TaskFunctions<Data, Response>,
+ protected readonly mainWorker: MainWorker,
+ protected readonly opts: WorkerOptions = {
/**
- * The kill behavior option on this Worker or its default value.
+ * The kill behavior option on this worker or its default value.
*/
killBehavior: DEFAULT_KILL_BEHAVIOR,
/**
}
) {
super(type)
- this.opts = opts
- this.checkFunctionInput(fn)
this.checkWorkerOptions(this.opts)
- this.lastTaskTimestamp = Date.now()
- // Keep the worker active
- if (!isMain) {
+ this.checkTaskFunctions(taskFunctions)
+ if (!this.isMain) {
+ this.lastTaskTimestamp = performance.now()
this.aliveInterval = setInterval(
this.checkAlive.bind(this),
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
)
this.checkAlive.bind(this)()
- }
-
- this.mainWorker?.on('message', (value: MessageValue<Data, MainWorker>) => {
- this.messageListener(value, fn)
- })
- }
-
- protected messageListener (
- value: MessageValue<Data, MainWorker>,
- fn: (data: Data) => Response
- ): void {
- if (value.data !== undefined && value.id !== undefined) {
- // Here you will receive messages
- if (this.opts.async === true) {
- this.runInAsyncScope(this.runAsync.bind(this), this, fn, value)
- } else {
- this.runInAsyncScope(this.run.bind(this), this, fn, value)
- }
- } else if (value.parent !== undefined) {
- // Save a reference of the main worker to communicate with it
- // This will be received once
- this.mainWorker = value.parent
- } else if (value.kill !== undefined) {
- // Here is time to kill this worker, just clearing the interval
- if (this.aliveInterval != null) clearInterval(this.aliveInterval)
- this.emitDestroy()
+ this.mainWorker?.on('message', this.messageListener.bind(this))
}
}
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 `fn` parameter is passed to the constructor.
+ * Checks if the `taskFunctions` parameter is passed to the constructor.
*
- * @param fn The function that should be defined.
+ * @param taskFunctions - The task function(s) parameter that should be checked.
*/
- 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') }
+ 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.
+ */
+ protected messageListener (message: MessageValue<Data, Data>): void {
+ if (message.id != null && message.data != null) {
+ // Task message received
+ const fn = this.getTaskFunction(message.name)
+ if (isAsyncFunction(fn)) {
+ this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
+ } else {
+ this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
+ }
+ } else if (message.statistics != null) {
+ // Statistics message received
+ this.statistics = message.statistics
+ } else if (message.kill != null) {
+ // Kill message received
+ this.aliveInterval != null && clearInterval(this.aliveInterval)
+ this.emitDestroy()
+ }
}
/**
*/
protected getMainWorker (): MainWorker {
if (this.mainWorker == null) {
- throw new Error('Main worker was not set')
+ throw new Error('Main worker not set')
}
return this.mainWorker
}
/**
* Sends a message to the main worker.
*
- * @param message The response message.
+ * @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.
*/
protected checkAlive (): void {
if (
- Date.now() - this.lastTaskTimestamp >
+ performance.now() - this.lastTaskTimestamp >
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
) {
this.sendToMainWorker({ kill: this.opts.killBehavior })
/**
* 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 Message of the error.
+ * @param e - The error raised by the worker.
+ * @returns The error message.
*/
protected handleError (e: Error | string): string {
- return e as string
+ return e instanceof Error ? e.message : e
}
/**
* Runs the given function synchronously.
*
- * @param fn Function that will be executed.
- * @param value Input data for the given function.
+ * @param fn - Function that will be executed.
+ * @param message - Input data for the given function.
*/
- protected run (
- fn: (data?: Data) => Response,
- value: MessageValue<Data>
+ protected runSync (
+ fn: WorkerSyncFunction<Data, Response>,
+ message: MessageValue<Data>
): void {
try {
- const startTaskTimestamp = Date.now()
- const res = fn(value.data)
- const taskRunTime = Date.now() - startTaskTimestamp
- this.sendToMainWorker({ data: res, id: value.id, taskRunTime })
+ let taskPerformance = this.beginTaskPerformance()
+ const res = fn(message.data)
+ taskPerformance = this.endTaskPerformance(taskPerformance)
+ this.sendToMainWorker({
+ data: res,
+ taskPerformance,
+ workerId: this.id,
+ id: message.id
+ })
} catch (e) {
- const err = this.handleError(e as Error)
- this.sendToMainWorker({ error: err, id: value.id })
+ const errorMessage = this.handleError(e as Error | string)
+ this.sendToMainWorker({
+ taskError: {
+ workerId: this.id,
+ message: errorMessage,
+ data: message.data
+ },
+ id: message.id
+ })
} finally {
- this.lastTaskTimestamp = Date.now()
+ !this.isMain && (this.lastTaskTimestamp = performance.now())
}
}
/**
* Runs the given function asynchronously.
*
- * @param fn Function that will be executed.
- * @param value Input data for the given function.
+ * @param fn - Function that will be executed.
+ * @param message - Input data for the given function.
*/
protected runAsync (
- fn: (data?: Data) => Promise<Response>,
- value: MessageValue<Data>
+ fn: WorkerAsyncFunction<Data, Response>,
+ message: MessageValue<Data>
): void {
- const startTaskTimestamp = Date.now()
- fn(value.data)
+ let taskPerformance = this.beginTaskPerformance()
+ fn(message.data)
.then(res => {
- const taskRunTime = Date.now() - startTaskTimestamp
- this.sendToMainWorker({ data: res, id: value.id, taskRunTime })
+ taskPerformance = this.endTaskPerformance(taskPerformance)
+ this.sendToMainWorker({
+ data: res,
+ taskPerformance,
+ workerId: this.id,
+ id: message.id
+ })
return null
})
.catch(e => {
- const err = this.handleError(e as Error)
- this.sendToMainWorker({ error: err, id: value.id })
+ const errorMessage = this.handleError(e as Error | string)
+ this.sendToMainWorker({
+ taskError: {
+ workerId: this.id,
+ message: errorMessage,
+ data: message.data
+ },
+ id: message.id
+ })
})
.finally(() => {
- this.lastTaskTimestamp = Date.now()
+ !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 (): TaskPerformance {
+ this.checkStatistics()
+ return {
+ 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')
+ }
+ }
}
repositories / poolifier.git / blobdiff