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 type { MessageValue, WorkerStatistics } from '../utility-types'
-import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import { performance } from 'node:perf_hooks'
+import type {
+ MessageValue,
+ TaskPerformance,
+ WorkerStatistics
+} from '../utility-types'
+import {
+ DEFAULT_TASK_NAME,
+ EMPTY_FUNCTION,
+ isAsyncFunction,
+ isPlainObject
+} from '../utils'
import {
type KillBehavior,
KillBehaviors,
WorkerSyncFunction
} from './worker-functions'
-const DEFAULT_FUNCTION_NAME = 'default'
const DEFAULT_MAX_INACTIVE_TIME = 60000
const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
-/**
- * Task performance.
- */
-export interface TaskPerformance {
- timestamp: number
- waitTime?: number
- runTime?: number
- elu?: EventLoopUtilization
-}
-
/**
* Base class that implements some shared logic for all poolifier workers.
*
* @typeParam MainWorker - Type of main worker.
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data.
- * @typeParam Response - Type of response the worker sends back to the main worker. This can only be serializable data.
+ * @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 lastTaskTimestamp!: number
/**
- * Performance statistics computation.
+ * Performance statistics computation requirements.
*/
protected statistics!: WorkerStatistics
/**
* Handler id of the `aliveInterval` worker alive check.
*/
- protected readonly aliveInterval?: NodeJS.Timeout
+ protected aliveInterval?: NodeJS.Timeout
/**
* Constructs a new poolifier worker.
*
taskFunctions:
| WorkerFunction<Data, Response>
| TaskFunctions<Data, Response>,
- protected mainWorker: MainWorker | undefined | null,
+ protected readonly mainWorker: MainWorker,
protected readonly opts: WorkerOptions = {
/**
* The kill behavior option on this worker or its default value.
this.checkWorkerOptions(this.opts)
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', this.messageListener.bind(this))
}
- this.mainWorker?.on('message', this.messageListener.bind(this))
}
private checkWorkerOptions (opts: WorkerOptions): void {
}
this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
if (typeof taskFunctions === 'function') {
- this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+ this.taskFunctions.set(DEFAULT_TASK_NAME, taskFunctions.bind(this))
} else if (isPlainObject(taskFunctions)) {
let firstEntry = true
for (const [name, fn] of Object.entries(taskFunctions)) {
}
this.taskFunctions.set(name, fn.bind(this))
if (firstEntry) {
- this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
+ this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
firstEntry = false
}
}
*
* @param message - Message received.
*/
- protected messageListener (message: MessageValue<Data, MainWorker>): void {
- if (message.id != null && message.data != null) {
- // 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.runSync.bind(this), this, fn, message)
+ protected messageListener (message: MessageValue<Data, Data>): void {
+ if (message.workerId === this.id) {
+ if (message.ready != null) {
+ // Startup message received
+ this.workerReady()
+ } else if (message.statistics != null) {
+ // Statistics message received
+ this.statistics = message.statistics
+ } else if (message.checkAlive != null) {
+ // Check alive message received
+ message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive()
+ } else 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.kill === true) {
+ // Kill message received
+ this.stopCheckAlive()
+ this.emitDestroy()
}
- } else if (message.parent != null) {
- // Main worker reference message received
- this.mainWorker = message.parent
- } else if (message.kill != null) {
- // Kill message received
- this.aliveInterval != null && clearInterval(this.aliveInterval)
- this.emitDestroy()
- } else if (message.statistics != null) {
- // Statistics message received
- this.statistics = message.statistics
}
}
/**
- * Returns the main worker.
- *
- * @returns Reference to the main worker.
+ * Notifies the main worker that this worker is ready to process tasks.
*/
- protected getMainWorker (): MainWorker {
- if (this.mainWorker == null) {
- throw new Error('Main worker was not set')
- }
- return this.mainWorker
+ protected workerReady (): void {
+ !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
}
/**
- * Sends a message to the main worker.
- *
- * @param message - The response message.
+ * Starts the worker alive check interval.
+ */
+ private startCheckAlive (): void {
+ this.lastTaskTimestamp = performance.now()
+ this.aliveInterval = setInterval(
+ this.checkAlive.bind(this),
+ (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
+ )
+ this.checkAlive.bind(this)()
+ }
+
+ /**
+ * Stops the worker alive check interval.
*/
- protected abstract sendToMainWorker (message: MessageValue<Response>): void
+ private stopCheckAlive (): void {
+ this.aliveInterval != null && clearInterval(this.aliveInterval)
+ }
/**
* Checks if the worker should be terminated, because its living too long.
*/
- protected checkAlive (): void {
+ private checkAlive (): void {
if (
performance.now() - this.lastTaskTimestamp >
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
) {
- this.sendToMainWorker({ kill: this.opts.killBehavior })
+ this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
+ }
+ }
+
+ /**
+ * Returns the main worker.
+ *
+ * @returns Reference to the main worker.
+ */
+ protected getMainWorker (): MainWorker {
+ if (this.mainWorker == null) {
+ throw new Error('Main worker not set')
}
+ return this.mainWorker
}
+ /**
+ * Sends a message to the main worker.
+ *
+ * @param message - The response message.
+ */
+ protected abstract sendToMainWorker (
+ message: MessageValue<Response, Data>
+ ): void
+
/**
* 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.
+ * @returns The error message.
*/
protected handleError (e: Error | string): string {
- return e as string
+ return e instanceof Error ? e.message : e
}
/**
message: MessageValue<Data>
): void {
try {
- const taskPerformance = this.beginTaskPerformance(message)
+ let taskPerformance = this.beginTaskPerformance(message.name)
const res = fn(message.data)
- const { runTime, waitTime, elu } =
- this.endTaskPerformance(taskPerformance)
+ taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
- runTime,
- waitTime,
- elu,
+ taskPerformance,
+ workerId: this.id,
id: message.id
})
} catch (e) {
- const err = this.handleError(e as Error)
+ const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
- error: err,
- errorData: message.data,
+ taskError: {
+ name: message.name ?? DEFAULT_TASK_NAME,
+ message: errorMessage,
+ data: message.data
+ },
+ workerId: this.id,
id: message.id
})
} finally {
- !this.isMain && (this.lastTaskTimestamp = performance.now())
+ if (!this.isMain && this.aliveInterval != null) {
+ this.lastTaskTimestamp = performance.now()
+ }
}
}
fn: WorkerAsyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
- const taskPerformance = this.beginTaskPerformance(message)
+ let taskPerformance = this.beginTaskPerformance(message.name)
fn(message.data)
.then(res => {
- const { runTime, waitTime, elu } =
- this.endTaskPerformance(taskPerformance)
+ taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
- runTime,
- waitTime,
- elu,
+ taskPerformance,
+ workerId: this.id,
id: message.id
})
return null
})
.catch(e => {
- const err = this.handleError(e as Error)
+ const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
- error: err,
- errorData: message.data,
+ taskError: {
+ name: message.name ?? DEFAULT_TASK_NAME,
+ message: errorMessage,
+ data: message.data
+ },
+ workerId: this.id,
id: message.id
})
})
.finally(() => {
- !this.isMain && (this.lastTaskTimestamp = performance.now())
+ if (!this.isMain && this.aliveInterval != null) {
+ 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.
+ * @param name - Name of the task function that will be returned.
*/
private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
- name = name ?? DEFAULT_FUNCTION_NAME
+ name = name ?? DEFAULT_TASK_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()
+ private beginTaskPerformance (name?: string): TaskPerformance {
+ this.checkStatistics()
return {
- timestamp,
- ...(this.statistics.waitTime && {
- waitTime: timestamp - (message.timestamp ?? timestamp)
- }),
+ name: name ?? DEFAULT_TASK_NAME,
+ timestamp: performance.now(),
...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
}
}
private endTaskPerformance (
taskPerformance: TaskPerformance
): TaskPerformance {
+ this.checkStatistics()
return {
...taskPerformance,
...(this.statistics.runTime && {
})
}
}
+
+ private checkStatistics (): void {
+ if (this.statistics == null) {
+ throw new Error('Performance statistics computation requirements not set')
+ }
+ }
}
repositories / poolifier.git / blobdiff