X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=23739270b3a9863c20ea1a212004b2a94e982335;hb=4fe5947ed052e344500491261c2eb7dc0686480f;hp=2aca9e914b2f4f296624f842ccbee9e159790815;hpb=c7c046988e2b4d93ce7998ebf39e5ad5ab92fec1;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 2aca9e91..23739270 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,18 +1,30 @@ import { AsyncResource } from 'node:async_hooks' import type { Worker } from 'node:cluster' import type { MessagePort } from 'node:worker_threads' -import { - type MessageValue, - type TaskFunctions, - type WorkerAsyncFunction, - type WorkerFunction, - type WorkerSyncFunction +import { performance } from 'node:perf_hooks' +import type { + MessageValue, + TaskPerformance, + WorkerStatistics } from '../utility-types' -import { EMPTY_FUNCTION } from '../utils' -import type { KillBehavior, WorkerOptions } from './worker-options' -import { KillBehaviors } from './worker-options' +import { + DEFAULT_TASK_NAME, + EMPTY_FUNCTION, + isAsyncFunction, + isPlainObject +} from '../utils' +import { + type KillBehavior, + KillBehaviors, + type WorkerOptions +} from './worker-options' +import type { + TaskFunctions, + WorkerAsyncFunction, + WorkerFunction, + WorkerSyncFunction +} from './worker-functions' -const DEFAULT_FUNCTION_NAME = 'default' const DEFAULT_MAX_INACTIVE_TIME = 60000 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT @@ -20,14 +32,18 @@ const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT * Base class that implements some shared logic for all poolifier workers. * * @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. + * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data. + * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data. */ export abstract class AbstractWorker< MainWorker extends Worker | MessagePort, Data = unknown, Response = unknown > extends AsyncResource { + /** + * Worker id. + */ + protected abstract id: number /** * Task function(s) processed by the worker when the pool's `execution` function is invoked. */ @@ -36,16 +52,20 @@ export abstract class AbstractWorker< * Timestamp of the last task processed by this worker. */ protected lastTaskTimestamp!: number + /** + * Performance statistics computation requirements. + */ + protected statistics!: WorkerStatistics /** * Handler id of the `aliveInterval` worker alive check. */ - protected readonly aliveInterval?: NodeJS.Timeout + protected 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 taskFunctions - Task function(s) 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. */ @@ -55,7 +75,7 @@ export abstract class AbstractWorker< taskFunctions: | WorkerFunction | TaskFunctions, - protected mainWorker: MainWorker | undefined | null, + protected readonly mainWorker: MainWorker, protected readonly opts: WorkerOptions = { /** * The kill behavior option on this worker or its default value. @@ -72,33 +92,21 @@ export abstract class AbstractWorker< this.checkWorkerOptions(this.opts) 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 - ) - this.checkAlive.bind(this)() + this.mainWorker?.on('message', this.messageListener.bind(this)) } - - this.mainWorker?.on( - 'message', - (message: MessageValue) => { - this.messageListener(message) - } - ) } 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) that should be defined. + * @param taskFunctions - The task function(s) parameter that should be checked. */ private checkTaskFunctions ( taskFunctions: @@ -108,31 +116,30 @@ export abstract class AbstractWorker< if (taskFunctions == null) { throw new Error('taskFunctions parameter is mandatory') } - if ( - typeof taskFunctions !== 'function' && - typeof taskFunctions !== 'object' - ) { - throw new Error('taskFunctions parameter is not a function or an object') - } - if ( - typeof taskFunctions === 'object' && - taskFunctions.constructor !== Object && - Object.prototype.toString.call(taskFunctions) !== '[object Object]' - ) { - throw new Error('taskFunctions parameter is not an object literal') - } this.taskFunctions = new Map>() - if (typeof taskFunctions !== 'function') { + if (typeof taskFunctions === 'function') { + this.taskFunctions.set(DEFAULT_TASK_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 Error( + 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_TASK_NAME, fn.bind(this)) + firstEntry = false + } + } + if (firstEntry) { + throw new Error('taskFunctions parameter object is empty') } } else { - this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this)) + throw new TypeError( + 'taskFunctions parameter is not a function or a plain object' + ) } } @@ -141,64 +148,100 @@ export abstract class AbstractWorker< * * @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.run.bind(this), this, fn, message) + protected messageListener (message: MessageValue): 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 + 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) + } + } else if (message.kill === true) { + // Kill message received + this.stopCheckAlive() + this.emitDestroy() } - } 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. + * Notifies the main worker that this worker is ready to process tasks. */ - protected getMainWorker (): MainWorker { - if (this.mainWorker == null) { - throw new Error('Main worker was not set') - } - return this.mainWorker + protected workerReady (): void { + !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id }) } /** - * Sends a message to the main worker. - * - * @param message - The response message. + * Starts the worker alive check interval. */ - protected abstract sendToMainWorker (message: MessageValue): void + private startCheckAlive (): void { + this.lastTaskTimestamp = performance.now() + this.aliveInterval = setInterval( + this.checkAlive.bind(this), + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 + ) + this.checkAlive.bind(this)() + } + + /** + * Stops the worker alive check interval. + */ + private stopCheckAlive (): void { + this.aliveInterval != null && clearInterval(this.aliveInterval) + } /** * Checks if the worker should be terminated, because its living too long. */ - protected checkAlive (): void { + private checkAlive (): void { if ( performance.now() - this.lastTaskTimestamp > (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) ) { - this.sendToMainWorker({ kill: this.opts.killBehavior }) + this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id }) } } + /** + * Returns the main worker. + * + * @returns Reference to the main worker. + */ + protected getMainWorker (): MainWorker { + if (this.mainWorker == null) { + throw new Error('Main worker not set') + } + return this.mainWorker + } + + /** + * Sends a message to the main worker. + * + * @param message - The response message. + */ + protected abstract sendToMainWorker ( + message: MessageValue + ): void + /** * 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. - * @returns Message of the error. + * @returns The error message. */ protected handleError (e: Error | string): string { - return e as string + return e instanceof Error ? e.message : e } /** @@ -207,24 +250,35 @@ export abstract class AbstractWorker< * @param fn - Function that will be executed. * @param message - Input data for the given function. */ - protected run ( + protected runSync ( fn: WorkerSyncFunction, message: MessageValue ): void { try { - const startTimestamp = performance.now() + let taskPerformance = this.beginTaskPerformance(message.name) const res = fn(message.data) - const runTime = performance.now() - startTimestamp + taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, - id: message.id, - runTime + taskPerformance, + workerId: this.id, + id: message.id }) } catch (e) { - const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: message.id }) + const errorMessage = this.handleError(e as Error | string) + this.sendToMainWorker({ + taskError: { + name: message.name ?? DEFAULT_TASK_NAME, + message: errorMessage, + data: message.data + }, + workerId: this.id, + id: message.id + }) } finally { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } } } @@ -238,33 +292,79 @@ export abstract class AbstractWorker< fn: WorkerAsyncFunction, message: MessageValue ): void { - const startTimestamp = performance.now() + let taskPerformance = this.beginTaskPerformance(message.name) fn(message.data) .then(res => { - const runTime = performance.now() - startTimestamp + taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, - id: message.id, - runTime + taskPerformance, + workerId: this.id, + id: message.id }) return null }) .catch(e => { - const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: message.id }) + const errorMessage = this.handleError(e as Error | string) + this.sendToMainWorker({ + taskError: { + name: message.name ?? DEFAULT_TASK_NAME, + message: errorMessage, + data: message.data + }, + workerId: this.id, + id: message.id + }) }) .finally(() => { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } }) .catch(EMPTY_FUNCTION) } + /** + * Gets the task function in the given scope. + * + * @param name - Name of the task function that will be returned. + */ private getTaskFunction (name?: string): WorkerFunction { - name = name ?? DEFAULT_FUNCTION_NAME + name = name ?? DEFAULT_TASK_NAME const fn = this.taskFunctions.get(name) if (fn == null) { - throw new Error(`Task function "${name}" not found`) + throw new Error(`Task function '${name}' not found`) } return fn } + + private beginTaskPerformance (name?: string): TaskPerformance { + this.checkStatistics() + return { + name: name ?? DEFAULT_TASK_NAME, + timestamp: performance.now(), + ...(this.statistics.elu && { elu: performance.eventLoopUtilization() }) + } + } + + private endTaskPerformance ( + taskPerformance: TaskPerformance + ): TaskPerformance { + this.checkStatistics() + return { + ...taskPerformance, + ...(this.statistics.runTime && { + runTime: performance.now() - taskPerformance.timestamp + }), + ...(this.statistics.elu && { + elu: performance.eventLoopUtilization(taskPerformance.elu) + }) + } + } + + private checkStatistics (): void { + if (this.statistics == null) { + throw new Error('Performance statistics computation requirements not set') + } + } }