X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=25be4820a0e8c59faa8917e0a809633c0d97de83;hb=3749facbef3139d185918f89b1e29c69fc02015f;hp=a484dce12927c1cd29721e9529aa08a822c37b43;hpb=a3ae469eebfcc990a251133beb01378599313233;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index a484dce1..25be4820 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,13 +1,11 @@ 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 { @@ -15,24 +13,23 @@ import { 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, @@ -47,6 +44,10 @@ 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. */ @@ -66,7 +67,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. @@ -89,9 +90,8 @@ export abstract class AbstractWorker< (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,7 +146,7 @@ export abstract class AbstractWorker< * * @param message - Message received. */ - protected messageListener (message: MessageValue): void { + protected messageListener (message: MessageValue): void { if (message.id != null && message.data != null) { // Task message received const fn = this.getTaskFunction(message.name) @@ -155,9 +155,9 @@ export abstract class AbstractWorker< } 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.statistics != null) { + // Statistics message received + this.statistics = message.statistics } else if (message.kill != null) { // Kill message received this.aliveInterval != null && clearInterval(this.aliveInterval) @@ -172,7 +172,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 +182,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. @@ -217,21 +219,21 @@ 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, id: message.id }) } catch (e) { const err = this.handleError(e as Error) this.sendToMainWorker({ - error: err, - errorData: message.data, + taskError: { + message: err, + data: message.data + }, id: message.id }) } finally { @@ -249,16 +251,13 @@ 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, id: message.id }) return null @@ -266,8 +265,10 @@ export abstract class AbstractWorker< .catch(e => { const err = this.handleError(e as Error) this.sendToMainWorker({ - error: err, - errorData: message.data, + taskError: { + message: err, + data: message.data + }, id: message.id }) }) @@ -291,23 +292,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') } } }