X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=91a45e94b0f36c568326460891332d61d7de0731;hb=241f23c2f9cfec2259c11f0a223116aca357317b;hp=475595eccf5f2e2c85b4eac8ba251f306f472c5d;hpb=d99ba5a8a292772965b5027272a8dc677a6ad008;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 475595ec..91a45e94 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,11 +1,21 @@ import { AsyncResource } from 'node:async_hooks' import type { Worker } from 'node:cluster' import type { MessagePort } from 'node: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 type { + MessageValue, + TaskFunctions, + WorkerAsyncFunction, + WorkerFunction, + WorkerSyncFunction +} from '../utility-types' +import { EMPTY_FUNCTION, isPlainObject } from '../utils' +import { + type KillBehavior, + KillBehaviors, + type WorkerOptions +} from './worker-options' +const DEFAULT_FUNCTION_NAME = 'default' const DEFAULT_MAX_INACTIVE_TIME = 60000 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT @@ -21,12 +31,16 @@ export abstract class AbstractWorker< Data = unknown, Response = unknown > extends AsyncResource { + /** + * Task function(s) processed by the worker when the pool's `execution` function is invoked. + */ + protected taskFunctions!: Map> /** * Timestamp of the last task processed by this worker. */ protected lastTaskTimestamp!: number /** - * Handler Id of the `aliveInterval` worker alive check. + * Handler id of the `aliveInterval` worker alive check. */ protected readonly aliveInterval?: NodeJS.Timeout /** @@ -34,18 +48,20 @@ export abstract class AbstractWorker< * * @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 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, protected readonly isMain: boolean, - fn: (data: Data) => Response, + taskFunctions: + | WorkerFunction + | TaskFunctions, protected mainWorker: MainWorker | undefined | null, 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, /** @@ -56,10 +72,10 @@ export abstract class AbstractWorker< } ) { super(type) - this.checkFunctionInput(fn) this.checkWorkerOptions(this.opts) + this.checkTaskFunctions(taskFunctions) if (!this.isMain) { - this.lastTaskTimestamp = Date.now() + this.lastTaskTimestamp = performance.now() this.aliveInterval = setInterval( this.checkAlive.bind(this), (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 @@ -67,49 +83,77 @@ export abstract class AbstractWorker< this.checkAlive.bind(this)() } - this.mainWorker?.on('message', (value: MessageValue) => { - this.messageListener(value, fn) - }) - } - - protected messageListener ( - value: MessageValue, - fn: (data: Data) => Response - ): void { - if (value.data != null && value.id != null) { - // 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 != null) { - // Save a reference of the main worker to communicate with it - // This will be received once - this.mainWorker = value.parent - } else if (value.kill != null) { - // Here is time to kill this worker, just clearing the interval - this.aliveInterval != null && clearInterval(this.aliveInterval) - this.emitDestroy() - } + 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 - 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 + | 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() } } @@ -137,7 +181,7 @@ export abstract class AbstractWorker< */ 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 }) @@ -158,22 +202,32 @@ export abstract class AbstractWorker< * Runs the given function synchronously. * * @param fn - Function that will be executed. - * @param value - Input data for the given function. + * @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 startTaskTimestamp = Date.now() - const res = fn(value.data) - const taskRunTime = Date.now() - startTaskTimestamp - this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) + const startTimestamp = performance.now() + const waitTime = startTimestamp - (message.submissionTimestamp ?? 0) + const res = fn(message.data) + const runTime = performance.now() - startTimestamp + this.sendToMainWorker({ + data: res, + runTime, + waitTime, + id: message.id + }) } catch (e) { const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: value.id }) + this.sendToMainWorker({ + error: err, + errorData: message.data, + id: message.id + }) } finally { - !this.isMain && (this.lastTaskTimestamp = Date.now()) + !this.isMain && (this.lastTaskTimestamp = performance.now()) } } @@ -181,26 +235,50 @@ export abstract class AbstractWorker< * Runs the given function asynchronously. * * @param fn - Function that will be executed. - * @param value - Input data for the given function. + * @param message - Input data for the given function. */ protected runAsync ( - fn: (data?: Data) => Promise, - value: MessageValue + fn: WorkerAsyncFunction, + message: MessageValue ): void { - const startTaskTimestamp = Date.now() - fn(value.data) + const startTimestamp = performance.now() + const waitTime = startTimestamp - (message.submissionTimestamp ?? 0) + fn(message.data) .then(res => { - const taskRunTime = Date.now() - startTaskTimestamp - this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) + const runTime = performance.now() - startTimestamp + this.sendToMainWorker({ + data: res, + runTime, + waitTime, + id: message.id + }) return null }) .catch(e => { const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: value.id }) + this.sendToMainWorker({ + error: err, + errorData: message.data, + id: message.id + }) }) .finally(() => { - !this.isMain && (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 { + name = name ?? DEFAULT_FUNCTION_NAME + const fn = this.taskFunctions.get(name) + if (fn == null) { + throw new Error(`Task function '${name}' not found`) + } + return fn + } }