X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=b8b442ecd2c0e2521a2c82b899620aa22197fbd7;hb=75d3401a50550a9fc53e2e7d107bc2d776df83e3;hp=a484dce12927c1cd29721e9529aa08a822c37b43;hpb=a3ae469eebfcc990a251133beb01378599313233;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index a484dce1..b8b442ec 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,44 +1,45 @@ import { AsyncResource } from 'node:async_hooks' import type { Worker } from 'node:cluster' import type { MessagePort } from 'node:worker_threads' -import { type EventLoopUtilization, performance } from 'node:perf_hooks' +import { performance } from 'node:perf_hooks' import type { MessageValue, - TaskFunctions, - WorkerAsyncFunction, - WorkerFunction, - WorkerSyncFunction + TaskPerformance, + WorkerStatistics } from '../utility-types' -import { EMPTY_FUNCTION, isPlainObject } from '../utils' +import { 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 -interface TaskPerformance { - timestamp: number - waitTime: number - runTime?: number - elu: EventLoopUtilization -} - /** * 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. */ @@ -47,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. * @@ -66,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. @@ -83,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 { @@ -146,18 +144,21 @@ 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.dynamic === true) { + // Worker dynamic message received + this.startCheckAlive() + } else if (message.statistics != null) { + // Statistics message received + this.statistics = message.statistics + } else if (message.id != null && message.data != null) { // 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) { // Kill message received this.aliveInterval != null && clearInterval(this.aliveInterval) @@ -165,6 +166,15 @@ export abstract class AbstractWorker< } } + 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)() + } + /** * Returns the main worker. * @@ -172,7 +182,7 @@ export abstract class AbstractWorker< */ protected getMainWorker (): MainWorker { if (this.mainWorker == null) { - throw new Error('Main worker was not set') + throw new Error('Main worker not set') } return this.mainWorker } @@ -182,7 +192,9 @@ export abstract class AbstractWorker< * * @param message - The response message. */ - protected abstract sendToMainWorker (message: MessageValue): void + protected abstract sendToMainWorker ( + message: MessageValue + ): void /** * Checks if the worker should be terminated, because its living too long. @@ -200,10 +212,10 @@ export abstract class AbstractWorker< * 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 } /** @@ -217,25 +229,29 @@ export abstract class AbstractWorker< message: MessageValue ): void { try { - const taskPerformance = this.beforeTaskRunHook(message) + let taskPerformance = this.beginTaskPerformance() const res = fn(message.data) - const { runTime, waitTime, elu } = this.afterTaskRunHook(taskPerformance) + taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, - runTime, - waitTime, - elu, + taskPerformance, + workerId: this.id, id: message.id }) } catch (e) { - const err = this.handleError(e as Error) + const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ - error: err, - errorData: message.data, + taskError: { + workerId: this.id, + message: errorMessage, + data: message.data + }, id: message.id }) } finally { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } } } @@ -249,30 +265,33 @@ export abstract class AbstractWorker< fn: WorkerAsyncFunction, message: MessageValue ): void { - const taskPerformance = this.beforeTaskRunHook(message) + let taskPerformance = this.beginTaskPerformance() fn(message.data) .then(res => { - const { runTime, waitTime, elu } = - this.afterTaskRunHook(taskPerformance) + taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, - runTime, - waitTime, - elu, + taskPerformance, + workerId: this.id, id: message.id }) return null }) .catch(e => { - const err = this.handleError(e as Error) + const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ - error: err, - errorData: message.data, + taskError: { + workerId: this.id, + message: errorMessage, + data: message.data + }, id: message.id }) }) .finally(() => { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } }) .catch(EMPTY_FUNCTION) } @@ -291,23 +310,32 @@ export abstract class AbstractWorker< return fn } - private beforeTaskRunHook (message: MessageValue): TaskPerformance { - // TODO: conditional accounting - const timestamp = performance.now() + private beginTaskPerformance (): TaskPerformance { + this.checkStatistics() return { - timestamp, - waitTime: timestamp - (message.submissionTimestamp ?? 0), - elu: performance.eventLoopUtilization() + timestamp: performance.now(), + ...(this.statistics.elu && { elu: performance.eventLoopUtilization() }) } } - private afterTaskRunHook (taskPerformance: TaskPerformance): TaskPerformance { + private endTaskPerformance ( + taskPerformance: TaskPerformance + ): TaskPerformance { + this.checkStatistics() return { ...taskPerformance, - ...{ - runTime: performance.now() - taskPerformance.timestamp, + ...(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') } } }