X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=8122f909af89d93e76d5a0c1730e19323b3391da;hb=21f710aa73abbb5d90328cfb199adfc0f7a70406;hp=8a38b4e576464ecb88078540cc8604d7b3ad323f;hpb=ace229a1b5029d3acaeeb4e8abdab415de5318f1;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 8a38b4e5..8122f909 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,16 +1,24 @@ import { AsyncResource } from 'node:async_hooks' import type { Worker } from 'node:cluster' import type { MessagePort } from 'node:worker_threads' +import { performance } from 'node:perf_hooks' import type { MessageValue, + TaskPerformance, + WorkerStatistics +} from '../utility-types' +import { EMPTY_FUNCTION, isAsyncFunction, isPlainObject } from '../utils' +import { + type KillBehavior, + KillBehaviors, + type WorkerOptions +} from './worker-options' +import type { 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' +} from './worker-functions' const DEFAULT_FUNCTION_NAME = 'default' const DEFAULT_MAX_INACTIVE_TIME = 60000 @@ -20,14 +28,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,10 +48,14 @@ 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. * @@ -55,7 +71,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,15 +88,8 @@ 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', this.messageListener.bind(this)) } private checkWorkerOptions (opts: WorkerOptions): void { @@ -135,64 +144,102 @@ export abstract class AbstractWorker< * * @param message - Message received. */ - protected messageListener (message: MessageValue): void { - if (message.id != null && message.data != null) { + protected messageListener (message: MessageValue): void { + if (message.ready != null && message.workerId === this.id) { + // Startup message received + this.workerReady() + } else if (message.statistics != null && message.workerId === this.id) { + // Statistics message received + this.statistics = message.statistics + } else if (message.checkAlive != null && message.workerId === this.id) { + // Check alive message received + message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive() + } else if ( + message.id != null && + message.data != null && + message.workerId === this.id + ) { // Task message received const fn = this.getTaskFunction(message.name) - if (fn?.constructor.name === 'AsyncFunction') { + 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.parent != null) { - // Main worker reference message received - this.mainWorker = message.parent - } else if (message.kill != null) { + } else if (message.kill === true && message.workerId === this.id) { // Kill message received - this.aliveInterval != null && clearInterval(this.aliveInterval) + this.stopCheckAlive() 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. + */ + 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. */ - protected abstract sendToMainWorker (message: MessageValue): void + 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 } /** @@ -206,21 +253,29 @@ export abstract class AbstractWorker< message: MessageValue ): void { try { - const startTimestamp = performance.now() - const waitTime = startTimestamp - (message.submissionTimestamp ?? 0) + let taskPerformance = this.beginTaskPerformance() const res = fn(message.data) - const runTime = performance.now() - startTimestamp + taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, - id: message.id, - runTime, - waitTime + 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: { + 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() + } } } @@ -234,25 +289,33 @@ export abstract class AbstractWorker< fn: WorkerAsyncFunction, message: MessageValue ): void { - const startTimestamp = performance.now() - const waitTime = startTimestamp - (message.submissionTimestamp ?? 0) + let taskPerformance = this.beginTaskPerformance() fn(message.data) .then(res => { - const runTime = performance.now() - startTimestamp + taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, - id: message.id, - runTime, - waitTime + 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: { + 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) } @@ -270,4 +333,33 @@ export abstract class AbstractWorker< } return fn } + + private beginTaskPerformance (): TaskPerformance { + this.checkStatistics() + return { + 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') + } + } }