X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=176a5893caeeec7cb9d82095840b97498b3822b0;hb=09a6305fb250c17cb2565f8cbe3d9afbb33f307c;hp=fd163547a78eb08c7ca0c0a93519374530ed5c8f;hpb=729c563db85562dd7d0f7733b1a3e2d98467134b;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index fd163547..176a5893 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,137 +1,273 @@ -import { AsyncResource } from 'async_hooks' -import type { MessageValue } from '../utility-types' -import type { WorkerOptions } from './worker-options' +import { AsyncResource } from 'node:async_hooks' +import type { Worker } from 'node:cluster' +import type { MessagePort } from 'node:worker_threads' +import type { + MessageValue, + TaskFunctions, + WorkerAsyncFunction, + WorkerFunction, + WorkerSyncFunction +} from '../utility-types' +import { EMPTY_FUNCTION, isPlainObject } from '../utils' +import type { KillBehavior, WorkerOptions } from './worker-options' +import { KillBehaviors } from './worker-options' + +const DEFAULT_FUNCTION_NAME = 'default' +const DEFAULT_MAX_INACTIVE_TIME = 60000 +const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT /** - * Base class containing some shared logic for all poolifier workers. + * 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. - * @template Response Type of response the worker sends back to the main worker. + * @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. */ export abstract class AbstractWorker< - MainWorker, + MainWorker extends Worker | MessagePort, Data = unknown, Response = unknown > extends AsyncResource { /** - * The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires. - */ - protected readonly maxInactiveTime: number - /** - * Whether the worker is working asynchronously or not. + * Task function(s) processed by the worker when the pool's `execution` function is invoked. */ - protected readonly async: boolean + protected taskFunctions!: Map> /** * Timestamp of the last task processed by this worker. */ - protected lastTask: number + protected lastTaskTimestamp!: number /** - * Handler ID of the `interval` alive check. + * Handler id of the `aliveInterval` worker alive check. */ - protected readonly interval?: NodeJS.Timeout - + 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 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, - public readonly opts: WorkerOptions = {} + protected readonly isMain: boolean, + taskFunctions: + | WorkerFunction + | TaskFunctions, + protected mainWorker: MainWorker | undefined | null, + 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 + } ) { super(type) - - this.maxInactiveTime = this.opts.maxInactiveTime ?? 1000 * 60 - this.async = !!this.opts.async - this.lastTask = Date.now() - if (!fn) throw new Error('fn parameter is mandatory') - // keep the worker active - if (!isMain) { - this.interval = setInterval( + this.checkWorkerOptions(this.opts) + this.checkTaskFunctions(taskFunctions) + if (!this.isMain) { + this.lastTaskTimestamp = performance.now() + this.aliveInterval = setInterval( this.checkAlive.bind(this), - this.maxInactiveTime / 2 + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 ) this.checkAlive.bind(this)() } + + this.mainWorker?.on('message', this.messageListener.bind(this)) + } + + 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 + | TaskFunctions + ): void { + if (taskFunctions == null) { + throw new Error('taskFunctions parameter is mandatory') + } + this.taskFunctions = new Map>() + 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): 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) + } + } 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() + } } /** * Returns the main worker. + * + * @returns Reference to the main worker. */ - protected abstract getMainWorker (): MainWorker + protected getMainWorker (): MainWorker { + if (this.mainWorker == null) { + throw new Error('Main worker was not set') + } + return this.mainWorker + } /** - * Send a message to the main worker. + * Sends a message to the main worker. * - * @param message The response message. + * @param message - The response message. */ protected abstract sendToMainWorker (message: MessageValue): void /** - * Check to see if the worker should be terminated, because its living too long. + * Checks if the worker should be terminated, because its living too long. */ protected checkAlive (): void { - if (Date.now() - this.lastTask > this.maxInactiveTime) { - this.sendToMainWorker({ kill: 1 }) + if ( + performance.now() - this.lastTaskTimestamp > + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) + ) { + this.sendToMainWorker({ kill: this.opts.killBehavior }) } } /** - * Handle an error and convert it to a string so it can be sent back to the main worker. + * 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. + * @param e - The error raised by the worker. + * @returns Message of the error. */ protected handleError (e: Error | string): string { - return (e as unknown) as string + return e as string } /** - * Run the given function synchronously. + * 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 + protected runSync ( + fn: WorkerSyncFunction, + message: MessageValue ): void { try { - const res = fn(value.data) - this.sendToMainWorker({ data: res, id: value.id }) - this.lastTask = Date.now() + const startTimestamp = performance.now() + const waitTime = startTimestamp - (message.submissionTimestamp ?? 0) + const res = fn(message.data) + const runTime = performance.now() - startTimestamp + this.sendToMainWorker({ + data: res, + id: message.id, + runTime, + waitTime + }) } catch (e) { - const err = this.handleError(e) - this.sendToMainWorker({ error: err, id: value.id }) - this.lastTask = Date.now() + const err = this.handleError(e as Error) + this.sendToMainWorker({ error: err, id: message.id }) + } finally { + !this.isMain && (this.lastTaskTimestamp = performance.now()) } } /** - * Run the given function asynchronously. + * 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, - value: MessageValue + fn: WorkerAsyncFunction, + message: MessageValue ): void { - fn(value.data) + const startTimestamp = performance.now() + const waitTime = startTimestamp - (message.submissionTimestamp ?? 0) + fn(message.data) .then(res => { - this.sendToMainWorker({ data: res, id: value.id }) - this.lastTask = Date.now() + const runTime = performance.now() - startTimestamp + this.sendToMainWorker({ + data: res, + id: message.id, + runTime, + waitTime + }) return null }) .catch(e => { - const err = this.handleError(e) - this.sendToMainWorker({ error: err, id: value.id }) - this.lastTask = Date.now() + const err = this.handleError(e as Error) + this.sendToMainWorker({ error: err, 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 { + name = name ?? DEFAULT_FUNCTION_NAME + const fn = this.taskFunctions.get(name) + if (fn == null) { + throw new Error(`Task function "${name}" not found`) + } + return fn } }