isAsyncFunction,
isPlainObject
} from '../utils'
-import {
- type KillBehavior,
- KillBehaviors,
- type WorkerOptions
-} from './worker-options'
+import { KillBehaviors, type WorkerOptions } from './worker-options'
import type {
+ TaskAsyncFunction,
+ TaskFunction,
TaskFunctions,
- WorkerAsyncFunction,
- WorkerFunction,
- WorkerSyncFunction
-} from './worker-functions'
+ TaskSyncFunction
+} from './task-functions'
const DEFAULT_MAX_INACTIVE_TIME = 60000
-const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
+const DEFAULT_WORKER_OPTIONS: WorkerOptions = {
+ /**
+ * The kill behavior option on this worker or its default value.
+ */
+ killBehavior: KillBehaviors.SOFT,
+ /**
+ * 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,
+ /**
+ * The function to call when the worker is killed.
+ */
+ killHandler: EMPTY_FUNCTION
+}
/**
* Base class that implements some shared logic for all poolifier workers.
/**
* Task function(s) processed by the worker when the pool's `execution` function is invoked.
*/
- protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
+ protected taskFunctions!: Map<string, TaskFunction<Data, Response>>
/**
* Timestamp of the last task processed by this worker.
*/
*/
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,
- 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 pool automatically checks and terminates this worker when the time expires.
- */
- maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME
- }
+ private readonly mainWorker: MainWorker,
+ taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
+ protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
) {
super(type)
- this.checkWorkerOptions(this.opts)
+ if (this.isMain == null) {
+ throw new Error('isMain parameter is mandatory')
+ }
this.checkTaskFunctions(taskFunctions)
+ this.checkWorkerOptions(this.opts)
if (!this.isMain) {
- this.mainWorker?.on('message', this.messageListener.bind(this))
+ this.getMainWorker().on('message', this.handleReadyMessage.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 = { ...DEFAULT_WORKER_OPTIONS, ...opts }
delete this.opts.async
}
+ private checkValidTaskFunction (
+ name: string,
+ fn: TaskFunction<Data, Response>
+ ): void {
+ if (typeof name !== 'string') {
+ throw new TypeError(
+ 'A taskFunctions parameter object key is not a string'
+ )
+ }
+ if (typeof name === 'string' && name.trim().length === 0) {
+ throw new TypeError(
+ 'A taskFunctions parameter object key is an empty string'
+ )
+ }
+ if (typeof fn !== 'function') {
+ throw new TypeError(
+ 'A taskFunctions parameter object value is not a function'
+ )
+ }
+ }
+
/**
* 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>
+ taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
): void {
if (taskFunctions == null) {
throw new Error('taskFunctions parameter is mandatory')
}
- this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
+ this.taskFunctions = new Map<string, TaskFunction<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))
+ this.checkValidTaskFunction(name, fn)
+ 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')
*
* @param name - The name of the task function to check.
* @returns Whether the worker has a task function with the given name or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+ * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
*/
public hasTaskFunction (name: string): boolean {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
+ this.checkTaskFunctionName(name)
return this.taskFunctions.has(name)
}
* @param name - The name of the task function to add.
* @param fn - The task function to add.
* @returns Whether the task function was added or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+ * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
* @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
*/
public addTaskFunction (
name: string,
- fn: WorkerFunction<Data, Response>
+ fn: TaskFunction<Data, Response>
): boolean {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
+ this.checkTaskFunctionName(name)
if (name === DEFAULT_TASK_NAME) {
throw new Error(
'Cannot add a task function with the default reserved name'
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)
+ this.sendTaskFunctionsListToMainWorker()
return true
} catch {
return false
*
* @param name - The name of the task function to remove.
* @returns Whether the task function existed and was removed or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+ * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function.
*/
public removeTaskFunction (name: string): boolean {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
+ this.checkTaskFunctionName(name)
if (name === DEFAULT_TASK_NAME) {
throw new Error(
'Cannot remove the task function with the default reserved name'
'Cannot remove the task function used as the default task function'
)
}
- return this.taskFunctions.delete(name)
+ const deleteStatus = this.taskFunctions.delete(name)
+ this.sendTaskFunctionsListToMainWorker()
+ return deleteStatus
+ }
+
+ /**
+ * Lists the names of the worker's task functions.
+ *
+ * @returns The names of the worker's task functions.
+ */
+ public listTaskFunctions (): string[] {
+ const names: string[] = [...this.taskFunctions.keys()]
+ let defaultTaskFunctionName: string = DEFAULT_TASK_NAME
+ for (const [name, fn] of this.taskFunctions) {
+ if (
+ name !== DEFAULT_TASK_NAME &&
+ fn === this.taskFunctions.get(DEFAULT_TASK_NAME)
+ ) {
+ defaultTaskFunctionName = name
+ break
+ }
+ }
+ return [
+ names[names.indexOf(DEFAULT_TASK_NAME)],
+ defaultTaskFunctionName,
+ ...names.filter(
+ (name) => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName
+ )
+ ]
}
/**
- * Sets the default task function to use when no task function name is specified.
+ * 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.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+ * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is a non-existing task function.
*/
public setDefaultTaskFunction (name: string): boolean {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
+ this.checkTaskFunctionName(name)
if (name === DEFAULT_TASK_NAME) {
throw new Error(
'Cannot set the default task function reserved name as the default task function'
try {
this.taskFunctions.set(
DEFAULT_TASK_NAME,
- this.taskFunctions.get(name)?.bind(this) as WorkerFunction<
- Data,
- Response
- >
+ this.taskFunctions.get(name) as TaskFunction<Data, Response>
)
return true
} catch {
}
}
+ private checkTaskFunctionName (name: string): void {
+ if (typeof name !== 'string') {
+ throw new TypeError('name parameter is not a string')
+ }
+ if (typeof name === 'string' && name.trim().length === 0) {
+ throw new TypeError('name parameter is an empty string')
+ }
+ }
+
+ /**
+ * 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 - The received 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
- this.run(message)
- } else if (message.kill === true) {
- // Kill message received
- this.stopCheckAlive()
+ protected messageListener (message: MessageValue<Data>): void {
+ this.checkMessageWorkerId(message)
+ if (message.statistics != null) {
+ // Statistics message received
+ this.statistics = message.statistics
+ } else if (message.checkActive != null) {
+ // Check active message received
+ message.checkActive ? this.startCheckActive() : this.stopCheckActive()
+ } else if (message.taskId != null && message.data != null) {
+ // Task message received
+ this.run(message)
+ } else if (message.kill === true) {
+ // Kill message received
+ this.handleKillMessage(message)
+ }
+ }
+
+ /**
+ * Handles a kill message sent by the main worker.
+ *
+ * @param message - The kill message.
+ */
+ protected handleKillMessage (message: MessageValue<Data>): void {
+ this.stopCheckActive()
+ if (isAsyncFunction(this.opts.killHandler)) {
+ ;(this.opts.killHandler?.() as Promise<void>)
+ .then(() => {
+ this.sendToMainWorker({ kill: 'success', workerId: this.id })
+ return null
+ })
+ .catch(() => {
+ this.sendToMainWorker({ kill: 'failure', workerId: this.id })
+ })
+ .finally(() => {
+ this.emitDestroy()
+ })
+ .catch(EMPTY_FUNCTION)
+ } else {
+ try {
+ // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+ this.opts.killHandler?.() as void
+ this.sendToMainWorker({ kill: 'success', workerId: this.id })
+ } catch {
+ this.sendToMainWorker({ kill: 'failure', workerId: this.id })
+ } finally {
this.emitDestroy()
}
}
}
/**
- * Notifies the main worker that this worker is ready to process tasks.
+ * Check if the message worker id is set and matches the worker id.
+ *
+ * @param message - The message to check.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id.
*/
- protected workerReady (): void {
- !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
+ private checkMessageWorkerId (message: MessageValue<Data>): void {
+ if (message.workerId == null) {
+ throw new Error('Message worker id is not set')
+ } else if (message.workerId != null && message.workerId !== this.id) {
+ throw new Error(
+ `Message worker id ${message.workerId} does not match the worker id ${this.id}`
+ )
+ }
}
/**
- * Starts the worker aliveness 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
)
}
/**
- * Stops the worker aliveness 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)
* Returns the main worker.
*
* @returns Reference to the main worker.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set.
*/
protected getMainWorker (): MainWorker {
if (this.mainWorker == null) {
}
/**
- * Sends a message to the main worker.
+ * Sends a message to main worker.
*
* @param message - The response message.
*/
message: MessageValue<Response, Data>
): void
+ /**
+ * Sends the list of task function names to the main worker.
+ */
+ protected sendTaskFunctionsListToMainWorker (): void {
+ this.sendToMainWorker({
+ taskFunctions: this.listTaskFunctions(),
+ workerId: this.id
+ })
+ }
+
/**
* Handles an error and convert it to a string so it can be sent back to the main worker.
*
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
*/
protected run (task: Task<Data>): void {
- const fn = this.getTaskFunction(task.name)
+ const { name, taskId, data } = task
+ const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME)
+ if (fn == null) {
+ this.sendToMainWorker({
+ taskError: {
+ name: name as string,
+ message: `Task function '${name as string}' not found`,
+ data
+ },
+ workerId: this.id,
+ taskId
+ })
+ return
+ }
if (isAsyncFunction(fn)) {
this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
} else {
* @param task - Input data for the task function.
*/
protected runSync (
- fn: WorkerSyncFunction<Data, Response>,
+ fn: TaskSyncFunction<Data, Response>,
task: Task<Data>
): void {
+ const { name, taskId, data } = task
try {
- let taskPerformance = this.beginTaskPerformance(task.name)
- const res = fn(task.data)
+ let taskPerformance = this.beginTaskPerformance(name)
+ const res = fn(data)
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
taskPerformance,
workerId: this.id,
- id: task.id
+ taskId
})
} catch (e) {
const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
taskError: {
- name: task.name ?? DEFAULT_TASK_NAME,
+ name: name as string,
message: errorMessage,
- data: task.data
+ data
},
workerId: this.id,
- id: task.id
+ taskId
})
} finally {
- if (!this.isMain && this.aliveInterval != null) {
- this.lastTaskTimestamp = performance.now()
- }
+ this.updateLastTaskTimestamp()
}
}
* @param task - Input data for the task function.
*/
protected runAsync (
- fn: WorkerAsyncFunction<Data, Response>,
+ fn: TaskAsyncFunction<Data, Response>,
task: Task<Data>
): void {
- let taskPerformance = this.beginTaskPerformance(task.name)
- fn(task.data)
- .then(res => {
+ const { name, taskId, data } = task
+ let taskPerformance = this.beginTaskPerformance(name)
+ fn(data)
+ .then((res) => {
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
taskPerformance,
workerId: this.id,
- id: task.id
+ taskId
})
return null
})
- .catch(e => {
+ .catch((e) => {
const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
taskError: {
- name: task.name ?? DEFAULT_TASK_NAME,
+ name: name as string,
message: errorMessage,
- data: task.data
+ data
},
workerId: this.id,
- id: task.id
+ taskId
})
})
.finally(() => {
- if (!this.isMain && this.aliveInterval != null) {
- this.lastTaskTimestamp = performance.now()
- }
+ this.updateLastTaskTimestamp()
})
.catch(EMPTY_FUNCTION)
}
- /**
- * 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
- const fn = this.taskFunctions.get(name)
- if (fn == null) {
- throw new Error(`Task function '${name}' not found`)
- }
- return fn
- }
-
private beginTaskPerformance (name?: string): TaskPerformance {
this.checkStatistics()
return {
throw new Error('Performance statistics computation requirements not set')
}
}
+
+ private updateLastTaskTimestamp (): void {
+ if (this.activeInterval != null) {
+ this.lastTaskTimestamp = performance.now()
+ }
+ }
}
repositories / poolifier.git / blobdiff