X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=ddf4cbccd64f0f29e70b7f2994b4c2cc543626f3;hb=a038b5175071af7c51dae9e25c7423c7572f3949;hp=6047b2f78fe842cc6550ed653382d1b81951ce8d;hpb=b97d82d8304962979d02da4ac29f997b454c7d84;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 6047b2f7..ddf4cbcc 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -13,7 +13,8 @@ import { isKillBehavior, isPlainObject, median, - round + round, + updateMeasurementStatistics } from '../utils' import { KillBehaviors } from '../worker/worker-options' import { @@ -29,12 +30,12 @@ import { import type { IWorker, IWorkerNode, - MessageHandler, WorkerInfo, WorkerType, WorkerUsage } from './worker' import { + type MeasurementStatisticsRequirements, Measurements, WorkerChoiceStrategies, type WorkerChoiceStrategy, @@ -84,6 +85,10 @@ export abstract class AbstractPool< Response > + /** + * Whether the pool is starting or not. + */ + private readonly starting: boolean /** * The start timestamp of the pool. */ @@ -128,15 +133,9 @@ export abstract class AbstractPool< this.setupHook() - while ( - this.workerNodes.reduce( - (accumulator, workerNode) => - !workerNode.info.dynamic ? accumulator + 1 : accumulator, - 0 - ) < this.numberOfWorkers - ) { - this.createAndSetupWorker() - } + this.starting = true + this.startPool() + this.starting = false this.startTimestamp = performance.now() } @@ -279,6 +278,18 @@ export abstract class AbstractPool< } } + private startPool (): void { + while ( + this.workerNodes.reduce( + (accumulator, workerNode) => + !workerNode.info.dynamic ? accumulator + 1 : accumulator, + 0 + ) < this.numberOfWorkers + ) { + this.createAndSetupWorker() + } + } + /** @inheritDoc */ public get info (): PoolInfo { return { @@ -416,16 +427,6 @@ export abstract class AbstractPool< } } - private get starting (): boolean { - return ( - this.workerNodes.reduce( - (accumulator, workerNode) => - !workerNode.info.dynamic ? accumulator + 1 : accumulator, - 0 - ) < this.minSize - ) - } - private get ready (): boolean { return ( this.workerNodes.reduce( @@ -747,38 +748,12 @@ export abstract class AbstractPool< workerUsage: WorkerUsage, message: MessageValue ): void { - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime - .aggregate - ) { - const taskRunTime = message.taskPerformance?.runTime ?? 0 - workerUsage.runTime.aggregate = - (workerUsage.runTime.aggregate ?? 0) + taskRunTime - workerUsage.runTime.minimum = Math.min( - taskRunTime, - workerUsage.runTime?.minimum ?? Infinity - ) - workerUsage.runTime.maximum = Math.max( - taskRunTime, - workerUsage.runTime?.maximum ?? -Infinity - ) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime - .average && - workerUsage.tasks.executed !== 0 - ) { - workerUsage.runTime.average = - workerUsage.runTime.aggregate / workerUsage.tasks.executed - } - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime - .median && - message.taskPerformance?.runTime != null - ) { - workerUsage.runTime.history.push(message.taskPerformance.runTime) - workerUsage.runTime.median = median(workerUsage.runTime.history) - } - } + updateMeasurementStatistics( + workerUsage.runTime, + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime, + message.taskPerformance?.runTime ?? 0, + workerUsage.tasks.executed + ) } private updateWaitTimeWorkerUsage ( @@ -787,53 +762,34 @@ export abstract class AbstractPool< ): void { const timestamp = performance.now() const taskWaitTime = timestamp - (task.timestamp ?? timestamp) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime - .aggregate - ) { - workerUsage.waitTime.aggregate = - (workerUsage.waitTime?.aggregate ?? 0) + taskWaitTime - workerUsage.waitTime.minimum = Math.min( - taskWaitTime, - workerUsage.waitTime?.minimum ?? Infinity - ) - workerUsage.waitTime.maximum = Math.max( - taskWaitTime, - workerUsage.waitTime?.maximum ?? -Infinity - ) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements() - .waitTime.average && - workerUsage.tasks.executed !== 0 - ) { - workerUsage.waitTime.average = - workerUsage.waitTime.aggregate / workerUsage.tasks.executed - } - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements() - .waitTime.median - ) { - workerUsage.waitTime.history.push(taskWaitTime) - workerUsage.waitTime.median = median(workerUsage.waitTime.history) - } - } + updateMeasurementStatistics( + workerUsage.waitTime, + this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime, + taskWaitTime, + workerUsage.tasks.executed + ) } private updateEluWorkerUsage ( workerUsage: WorkerUsage, message: MessageValue ): void { - if ( + const eluTaskStatisticsRequirements: MeasurementStatisticsRequirements = this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu - .aggregate - ) { + updateMeasurementStatistics( + workerUsage.elu.active, + eluTaskStatisticsRequirements, + message.taskPerformance?.elu?.active ?? 0, + workerUsage.tasks.executed + ) + updateMeasurementStatistics( + workerUsage.elu.idle, + eluTaskStatisticsRequirements, + message.taskPerformance?.elu?.idle ?? 0, + workerUsage.tasks.executed + ) + if (eluTaskStatisticsRequirements.aggregate) { if (message.taskPerformance?.elu != null) { - workerUsage.elu.idle.aggregate = - (workerUsage.elu.idle?.aggregate ?? 0) + - message.taskPerformance.elu.idle - workerUsage.elu.active.aggregate = - (workerUsage.elu.active?.aggregate ?? 0) + - message.taskPerformance.elu.active if (workerUsage.elu.utilization != null) { workerUsage.elu.utilization = (workerUsage.elu.utilization + @@ -842,43 +798,6 @@ export abstract class AbstractPool< } else { workerUsage.elu.utilization = message.taskPerformance.elu.utilization } - workerUsage.elu.idle.minimum = Math.min( - message.taskPerformance.elu.idle, - workerUsage.elu.idle?.minimum ?? Infinity - ) - workerUsage.elu.idle.maximum = Math.max( - message.taskPerformance.elu.idle, - workerUsage.elu.idle?.maximum ?? -Infinity - ) - workerUsage.elu.active.minimum = Math.min( - message.taskPerformance.elu.active, - workerUsage.elu.active?.minimum ?? Infinity - ) - workerUsage.elu.active.maximum = Math.max( - message.taskPerformance.elu.active, - workerUsage.elu.active?.maximum ?? -Infinity - ) - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu - .average && - workerUsage.tasks.executed !== 0 - ) { - workerUsage.elu.idle.average = - workerUsage.elu.idle.aggregate / workerUsage.tasks.executed - workerUsage.elu.active.average = - workerUsage.elu.active.aggregate / workerUsage.tasks.executed - } - if ( - this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu - .median - ) { - workerUsage.elu.idle.history.push(message.taskPerformance.elu.idle) - workerUsage.elu.active.history.push( - message.taskPerformance.elu.active - ) - workerUsage.elu.idle.median = median(workerUsage.elu.idle.history) - workerUsage.elu.active.median = median(workerUsage.elu.active.history) - } } } } @@ -943,9 +862,7 @@ export abstract class AbstractPool< const workerNodeKey = this.getWorkerNodeKey(worker) const workerInfo = this.getWorkerInfo(workerNodeKey) workerInfo.ready = false - if (this.emitter != null) { - this.emitter.emit(PoolEvents.error, error) - } + this.emitter?.emit(PoolEvents.error, error) if (this.opts.restartWorkerOnError === true && !this.starting) { if (workerInfo.dynamic) { this.createAndSetupDynamicWorker() @@ -960,10 +877,15 @@ export abstract class AbstractPool< worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) worker.once('exit', () => { + const workerInfo = this.getWorkerInfoByWorker(worker) + if (workerInfo.messageChannel != null) { + workerInfo.messageChannel?.port1.close() + workerInfo.messageChannel?.port1.close() + } this.removeWorkerNode(worker) }) - this.pushWorkerNode(worker) + this.addWorkerNode(worker) this.afterWorkerSetup(worker) @@ -992,13 +914,13 @@ export abstract class AbstractPool< void (this.destroyWorker(worker) as Promise) } }) - const workerInfo = this.getWorkerInfo(this.getWorkerNodeKey(worker)) + const workerInfo = this.getWorkerInfoByWorker(worker) + workerInfo.dynamic = true if (this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker) { workerInfo.ready = true } - workerInfo.dynamic = true this.sendToWorker(worker, { - checkAlive: true, + checkActive: true, workerId: workerInfo.id as number }) return worker @@ -1010,12 +932,9 @@ export abstract class AbstractPool< * @param worker - The worker which should register a listener. * @param listener - The message listener callback. */ - private registerWorkerMessageListener( - worker: Worker, - listener: (message: MessageValue) => void - ): void { - worker.on('message', listener as MessageHandler) - } + protected abstract registerWorkerMessageListener< + Message extends Data | Response + >(worker: Worker, listener: (message: MessageValue) => void): void /** * Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. @@ -1026,18 +945,18 @@ export abstract class AbstractPool< protected afterWorkerSetup (worker: Worker): void { // Listen to worker messages. this.registerWorkerMessageListener(worker, this.workerListener()) - // Send startup message to worker. - this.sendWorkerStartupMessage(worker) + // Send the startup message to worker. + this.sendStartupMessageToWorker(worker) // Setup worker task statistics computation. this.setWorkerStatistics(worker) } - private sendWorkerStartupMessage (worker: Worker): void { - this.sendToWorker(worker, { - ready: false, - workerId: this.getWorkerInfo(this.getWorkerNodeKey(worker)).id as number - }) - } + /** + * Sends the startup message to the given worker. + * + * @param worker - The worker which should receive the startup message. + */ + protected abstract sendStartupMessageToWorker (worker: Worker): void private redistributeQueuedTasks (workerNodeKey: number): void { while (this.tasksQueueSize(workerNodeKey) > 0) { @@ -1078,8 +997,8 @@ export abstract class AbstractPool< return message => { this.checkMessageWorkerId(message) if (message.ready != null) { - // Worker ready message received - this.handleWorkerReadyMessage(message) + // Worker ready response received + this.handleWorkerReadyResponse(message) } else if (message.id != null) { // Task execution response received this.handleTaskExecutionResponse(message) @@ -1087,10 +1006,10 @@ export abstract class AbstractPool< } } - private handleWorkerReadyMessage (message: MessageValue): void { - const worker = this.getWorkerById(message.workerId) - this.getWorkerInfo(this.getWorkerNodeKey(worker as Worker)).ready = - message.ready as boolean + private handleWorkerReadyResponse (message: MessageValue): void { + this.getWorkerInfoByWorker( + this.getWorkerById(message.workerId) as Worker + ).ready = message.ready as boolean if (this.emitter != null && this.ready) { this.emitter.emit(PoolEvents.ready, this.info) } @@ -1100,9 +1019,7 @@ export abstract class AbstractPool< const promiseResponse = this.promiseResponseMap.get(message.id as string) if (promiseResponse != null) { if (message.taskError != null) { - if (this.emitter != null) { - this.emitter.emit(PoolEvents.taskError, message.taskError) - } + this.emitter?.emit(PoolEvents.taskError, message.taskError) promiseResponse.reject(message.taskError.message) } else { promiseResponse.resolve(message.data as Response) @@ -1135,7 +1052,7 @@ export abstract class AbstractPool< } /** - * Gets the worker information. + * Gets the worker information from the given worker node key. * * @param workerNodeKey - The worker node key. */ @@ -1144,12 +1061,21 @@ export abstract class AbstractPool< } /** - * Pushes the given worker in the pool worker nodes. + * Gets the worker information from the given worker. + * + * @param worker - The worker. + */ + protected getWorkerInfoByWorker (worker: Worker): WorkerInfo { + return this.workerNodes[this.getWorkerNodeKey(worker)].info + } + + /** + * Adds the given worker in the pool worker nodes. * * @param worker - The worker. * @returns The worker nodes length. */ - private pushWorkerNode (worker: Worker): number { + private addWorkerNode (worker: Worker): number { const workerNode = new WorkerNode(worker, this.worker) // Flag the worker node as ready at pool startup. if (this.starting) { @@ -1171,6 +1097,12 @@ export abstract class AbstractPool< } } + /** + * Executes the given task on the given worker. + * + * @param worker - The worker. + * @param task - The task to execute. + */ private executeTask (workerNodeKey: number, task: Task): void { this.beforeTaskExecutionHook(workerNodeKey, task) this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) @@ -1213,7 +1145,7 @@ export abstract class AbstractPool< elu: this.workerChoiceStrategyContext.getTaskStatisticsRequirements() .elu.aggregate }, - workerId: this.getWorkerInfo(this.getWorkerNodeKey(worker)).id as number + workerId: this.getWorkerInfoByWorker(worker).id as number }) } }