import { performance } from 'node:perf_hooks'
import type {
MessageValue,
+ Task,
TaskPerformance,
WorkerStatistics
} from '../utility-types'
*/
protected statistics!: WorkerStatistics
/**
- * Handler id of the `aliveInterval` worker alive check.
+ * Handler id of the `activeInterval` worker activity check.
*/
- protected aliveInterval?: NodeJS.Timeout
+ protected activeInterval?: 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 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 taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
* @param opts - Options for the worker.
*/
public constructor (
type: string,
protected readonly isMain: boolean,
+ private readonly mainWorker: MainWorker,
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.
*/
killBehavior: DEFAULT_KILL_BEHAVIOR,
/**
- * The maximum time to keep this worker alive while idle.
+ * The maximum time to keep this worker active while idle.
* The pool automatically checks and terminates this worker when the time expires.
*/
maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME
this.checkWorkerOptions(this.opts)
this.checkTaskFunctions(taskFunctions)
if (!this.isMain) {
- this.mainWorker?.on('message', this.messageListener.bind(this))
+ this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this))
}
}
}
this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
if (typeof taskFunctions === 'function') {
- this.taskFunctions.set(DEFAULT_TASK_NAME, taskFunctions.bind(this))
+ const boundFn = taskFunctions.bind(this)
+ this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
+ this.taskFunctions.set(
+ typeof taskFunctions.name === 'string' &&
+ taskFunctions.name.trim().length > 0
+ ? taskFunctions.name
+ : 'fn1',
+ boundFn
+ )
} else if (isPlainObject(taskFunctions)) {
let firstEntry = true
for (const [name, fn] of Object.entries(taskFunctions)) {
+ if (typeof name !== 'string') {
+ throw new TypeError(
+ 'A taskFunctions parameter object key is not a string'
+ )
+ }
if (typeof fn !== 'function') {
throw new TypeError(
'A taskFunctions parameter object value is not a function'
)
}
- this.taskFunctions.set(name, fn.bind(this))
+ const boundFn = fn.bind(this)
if (firstEntry) {
- this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
+ this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
firstEntry = false
}
+ this.taskFunctions.set(name, boundFn)
}
if (firstEntry) {
throw new Error('taskFunctions parameter object is empty')
throw new TypeError('fn parameter is not a function')
}
try {
+ const boundFn = fn.bind(this)
if (
this.taskFunctions.get(name) ===
this.taskFunctions.get(DEFAULT_TASK_NAME)
) {
- this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
+ this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
}
- this.taskFunctions.set(name, fn.bind(this))
+ this.taskFunctions.set(name, boundFn)
return true
} catch {
return false
}
/**
- * Sets the default task function to use when no task function name is specified.
+ * Lists the names of the worker's task functions.
+ *
+ * @returns The names of the worker's task functions.
+ */
+ public listTaskFunctions (): string[] {
+ return Array.from(this.taskFunctions.keys())
+ }
+
+ /**
+ * Sets the default task function to use in the worker.
*
* @param name - The name of the task function to use as default task function.
* @returns Whether the default task function was set or not.
try {
this.taskFunctions.set(
DEFAULT_TASK_NAME,
- this.taskFunctions.get(name)?.bind(this) as WorkerFunction<
- Data,
- Response
- >
+ this.taskFunctions.get(name) as WorkerFunction<Data, Response>
)
return true
} catch {
}
}
+ /**
+ * Handles the ready message sent by the main worker.
+ *
+ * @param message - The ready message.
+ */
+ protected abstract handleReadyMessage (message: MessageValue<Data>): void
+
/**
* Worker message listener.
*
- * @param message - Message received.
+ * @param message - The received message.
*/
- protected messageListener (message: MessageValue<Data, Data>): void {
+ protected messageListener (message: MessageValue<Data>): void {
if (message.workerId === this.id) {
- if (message.ready != null) {
- // Startup message received
- this.workerReady()
- } else if (message.statistics != null) {
+ 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.checkActive != null) {
+ // Check active message received
+ !this.isMain && message.checkActive
+ ? this.startCheckActive()
+ : this.stopCheckActive()
} 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)
- }
+ this.run(message)
} else if (message.kill === true) {
// Kill message received
- this.stopCheckAlive()
- this.emitDestroy()
+ this.handleKillMessage(message)
}
}
}
/**
- * Notifies the main worker that this worker is ready to process tasks.
+ * Handles a kill message sent by the main worker.
+ *
+ * @param message - The kill message.
*/
- protected workerReady (): void {
- !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
+ protected handleKillMessage (message: MessageValue<Data>): void {
+ !this.isMain && this.stopCheckActive()
+ this.emitDestroy()
}
/**
- * Starts the worker alive check interval.
+ * Starts the worker check active interval.
*/
- private startCheckAlive (): void {
+ private startCheckActive (): void {
this.lastTaskTimestamp = performance.now()
- this.aliveInterval = setInterval(
- this.checkAlive.bind(this),
+ this.activeInterval = setInterval(
+ this.checkActive.bind(this),
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
)
- this.checkAlive.bind(this)()
}
/**
- * Stops the worker alive check interval.
+ * Stops the worker check active interval.
*/
- private stopCheckAlive (): void {
- this.aliveInterval != null && clearInterval(this.aliveInterval)
+ private stopCheckActive (): void {
+ if (this.activeInterval != null) {
+ clearInterval(this.activeInterval)
+ delete this.activeInterval
+ }
}
/**
* Checks if the worker should be terminated, because its living too long.
*/
- private checkAlive (): void {
+ private checkActive (): void {
if (
performance.now() - this.lastTaskTimestamp >
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
}
/**
- * Sends a message to the main worker.
+ * Sends a message to main worker.
*
* @param message - The response message.
*/
}
/**
- * Runs the given function synchronously.
+ * Runs the given task.
+ *
+ * @param task - The task to execute.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
+ */
+ protected run (task: Task<Data>): void {
+ if (this.isMain) {
+ throw new Error('Cannot run a task in the main worker')
+ }
+ const fn = this.getTaskFunction(task.name)
+ if (isAsyncFunction(fn)) {
+ this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
+ } else {
+ this.runInAsyncScope(this.runSync.bind(this), this, fn, task)
+ }
+ }
+
+ /**
+ * Runs the given task function synchronously.
*
- * @param fn - Function that will be executed.
- * @param message - Input data for the given function.
+ * @param fn - Task function that will be executed.
+ * @param task - Input data for the task function.
*/
protected runSync (
fn: WorkerSyncFunction<Data, Response>,
- message: MessageValue<Data>
+ task: Task<Data>
): void {
try {
- let taskPerformance = this.beginTaskPerformance(message.name)
- const res = fn(message.data)
+ let taskPerformance = this.beginTaskPerformance(task.name)
+ const res = fn(task.data)
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
taskPerformance,
workerId: this.id,
- id: message.id
+ id: task.id
})
} catch (e) {
const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
taskError: {
- name: message.name ?? DEFAULT_TASK_NAME,
+ name: task.name ?? DEFAULT_TASK_NAME,
message: errorMessage,
- data: message.data
+ data: task.data
},
workerId: this.id,
- id: message.id
+ id: task.id
})
} finally {
- if (!this.isMain && this.aliveInterval != null) {
- this.lastTaskTimestamp = performance.now()
- }
+ this.updateLastTaskTimestamp()
}
}
/**
- * Runs the given function asynchronously.
+ * Runs the given task function asynchronously.
*
- * @param fn - Function that will be executed.
- * @param message - Input data for the given function.
+ * @param fn - Task function that will be executed.
+ * @param task - Input data for the task function.
*/
protected runAsync (
fn: WorkerAsyncFunction<Data, Response>,
- message: MessageValue<Data>
+ task: Task<Data>
): void {
- let taskPerformance = this.beginTaskPerformance(message.name)
- fn(message.data)
+ let taskPerformance = this.beginTaskPerformance(task.name)
+ fn(task.data)
.then(res => {
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
taskPerformance,
workerId: this.id,
- id: message.id
+ id: task.id
})
return null
})
const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
taskError: {
- name: message.name ?? DEFAULT_TASK_NAME,
+ name: task.name ?? DEFAULT_TASK_NAME,
message: errorMessage,
- data: message.data
+ data: task.data
},
workerId: this.id,
- id: message.id
+ id: task.id
})
})
.finally(() => {
- if (!this.isMain && this.aliveInterval != null) {
- this.lastTaskTimestamp = performance.now()
- }
+ this.updateLastTaskTimestamp()
})
.catch(EMPTY_FUNCTION)
}
/**
- * Gets the task function in the given scope.
+ * Gets the task function with the given name.
*
* @param name - Name of the task function that will be returned.
+ * @returns The task function.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
*/
private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
name = name ?? DEFAULT_TASK_NAME
throw new Error('Performance statistics computation requirements not set')
}
}
+
+ private updateLastTaskTimestamp (): void {
+ if (!this.isMain && this.activeInterval != null) {
+ this.lastTaskTimestamp = performance.now()
+ }
+ }
}