X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=176a5893caeeec7cb9d82095840b97498b3822b0;hb=09a6305fb250c17cb2565f8cbe3d9afbb33f307c;hp=0ea3fa6253103292775550bfb2d13fa329f19079;hpb=73cff87e755a06f6d01ba4be320aa92bfe0da7e4;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 0ea3fa62..176a5893 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,15 +1,18 @@ 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 { - isKillBehavior, - type KillBehavior, - type WorkerOptions -} from './worker-options' +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 @@ -25,35 +28,37 @@ 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 - /** - * Options for the worker. - */ - public readonly opts: WorkerOptions /** * 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 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, + protected readonly isMain: boolean, + taskFunctions: + | WorkerFunction + | TaskFunctions, protected mainWorker: MainWorker | undefined | null, - opts: WorkerOptions = { + 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, /** @@ -64,11 +69,10 @@ export abstract class AbstractWorker< } ) { super(type) - this.opts = opts - this.checkFunctionInput(fn) this.checkWorkerOptions(this.opts) - if (!isMain && isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior)) { - this.lastTaskTimestamp = Date.now() + 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 @@ -76,49 +80,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 !== undefined && value.id !== undefined) { - // 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 !== undefined) { - // Save a reference of the main worker to communicate with it - // This will be received once - this.mainWorker = value.parent - } else if (value.kill !== undefined) { - // 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 `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' + ) + } } /** - * Checks if the `fn` parameter is passed to the constructor. + * Worker message listener. * - * @param fn - The function that should be defined. + * @param message - Message received. */ - 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') + 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() } } @@ -146,7 +178,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 }) @@ -167,23 +199,28 @@ 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, + id: message.id, + runTime, + waitTime + }) } catch (e) { const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: value.id }) + this.sendToMainWorker({ error: err, id: message.id }) } finally { - isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior) && - (this.lastTaskTimestamp = Date.now()) + !this.isMain && (this.lastTaskTimestamp = performance.now()) } } @@ -191,27 +228,46 @@ 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, + id: message.id, + runTime, + waitTime + }) return null }) .catch(e => { const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: value.id }) + this.sendToMainWorker({ error: err, id: message.id }) }) .finally(() => { - isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior) && - (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 + } }