X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=6b12c2f99b6b986d822668c2648e0ff0ec59bd33;hb=d25a8ffcc8447163ac52832bd9a4f8819983f819;hp=10fe128170b5363b0b04d58b82e451369a0f9d3d;hpb=a76fac14098cf2138cf8d6997ac7c89d8c3ae508;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 10fe1281..6b12c2f9 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -2,12 +2,13 @@ import type { MessageValue, PromiseWorkerResponseWrapper } from '../utility-types' -import { EMPTY_FUNCTION } from '../utils' +import { EMPTY_FUNCTION, EMPTY_LITERAL } from '../utils' import { isKillBehavior, KillBehaviors } from '../worker/worker-options' -import type { AbstractPoolWorker } from './abstract-pool-worker' import type { PoolOptions } from './pool' -import type { IPoolInternal } from './pool-internal' -import { PoolEmitter, PoolType } from './pool-internal' +import { PoolEmitter } from './pool' +import type { IPoolInternal, TasksUsage } from './pool-internal' +import { PoolType } from './pool-internal' +import type { IPoolWorker } from './pool-worker' import { WorkerChoiceStrategies, WorkerChoiceStrategy @@ -15,14 +16,14 @@ import { import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' /** - * Base class containing some shared logic for all poolifier pools. + * Base class that implements some shared logic for all poolifier pools. * * @template Worker Type of worker which manages this pool. * @template Data Type of data sent to the worker. This can only be serializable data. * @template Response Type of response of execution. This can only be serializable data. */ export abstract class AbstractPool< - Worker extends AbstractPoolWorker, + Worker extends IPoolWorker, Data = unknown, Response = unknown > implements IPoolInternal { @@ -30,14 +31,14 @@ export abstract class AbstractPool< public readonly workers: Worker[] = [] /** @inheritDoc */ - public readonly tasks: Map = new Map() + public readonly workersTasksUsage: Map = new Map< + Worker, + TasksUsage + >() /** @inheritDoc */ public readonly emitter?: PoolEmitter - /** @inheritDoc */ - public readonly max?: number - /** * The promise map. * @@ -47,8 +48,8 @@ export abstract class AbstractPool< * When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message. */ protected promiseMap: Map< - number, - PromiseWorkerResponseWrapper + number, + PromiseWorkerResponseWrapper > = new Map>() /** @@ -62,9 +63,9 @@ export abstract class AbstractPool< * Default to a strategy implementing a round robin algorithm. */ protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< - Worker, - Data, - Response + Worker, + Data, + Response > /** @@ -91,7 +92,7 @@ export abstract class AbstractPool< this.createAndSetupWorker() } - if (this.opts.enableEvents) { + if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( @@ -104,7 +105,7 @@ export abstract class AbstractPool< this.getWorkerRunningTasks(workerCreated) === 0 ) { // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) - this.destroyWorker(workerCreated) as void + void (this.destroyWorker(workerCreated) as Promise) } }) return workerCreated @@ -114,7 +115,7 @@ export abstract class AbstractPool< } private checkFilePath (filePath: string): void { - if (!filePath) { + if (filePath == null || filePath.length === 0) { throw new Error('Please specify a file with a worker implementation') } } @@ -125,11 +126,11 @@ export abstract class AbstractPool< 'Cannot instantiate a pool without specifying the number of workers' ) } else if (!Number.isSafeInteger(numberOfWorkers)) { - throw new Error( + throw new TypeError( 'Cannot instantiate a pool with a non integer number of workers' ) } else if (numberOfWorkers < 0) { - throw new Error( + throw new RangeError( 'Cannot instantiate a pool with a negative number of workers' ) } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { @@ -151,14 +152,19 @@ export abstract class AbstractPool< return this.promiseMap.size } + /** @inheritDoc */ + public getWorkerIndex (worker: Worker): number { + return this.workers.indexOf(worker) + } + /** @inheritDoc */ public getWorkerRunningTasks (worker: Worker): number | undefined { - return this.tasks.get(worker) + return this.workersTasksUsage.get(worker)?.running } /** @inheritDoc */ - public getWorkerIndex (worker: Worker): number { - return this.workers.indexOf(worker) + public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { + return this.workersTasksUsage.get(worker)?.avgRunTime } /** @inheritDoc */ @@ -166,6 +172,9 @@ export abstract class AbstractPool< workerChoiceStrategy: WorkerChoiceStrategy ): void { this.opts.workerChoiceStrategy = workerChoiceStrategy + for (const worker of this.workers) { + this.resetWorkerTasksUsage(worker) + } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( workerChoiceStrategy ) @@ -193,14 +202,17 @@ export abstract class AbstractPool< } /** @inheritDoc */ - public execute (data: Data): Promise { + public async execute (data: Data): Promise { // Configure worker to handle message with the specified task const worker = this.chooseWorker() - const messageId = ++this.nextMessageId - const res = this.internalExecute(worker, messageId) + const res = this.internalExecute(worker, this.nextMessageId) this.checkAndEmitBusy() - data = data ?? ({} as Data) - this.sendToWorker(worker, { data, id: messageId }) + this.sendToWorker(worker, { + data: data ?? (EMPTY_LITERAL as Data), + id: this.nextMessageId + }) + ++this.nextMessageId + // eslint-disable-next-line @typescript-eslint/return-await return res } @@ -210,7 +222,7 @@ export abstract class AbstractPool< } /** - * Shut down given worker. + * Shutdowns given worker. * * @param worker A worker within `workers`. */ @@ -230,51 +242,44 @@ export abstract class AbstractPool< protected abstract isMain (): boolean /** - * Increase the number of tasks that the given worker has applied. + * Hook executed before the worker task promise resolution. + * Can be overridden. * - * @param worker Worker whose tasks are increased. + * @param worker The worker. */ - protected increaseWorkersTask (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, 1) + protected beforePromiseWorkerResponseHook (worker: Worker): void { + this.increaseWorkerRunningTasks(worker) } /** - * Decrease the number of tasks that the given worker has applied. + * Hook executed after the worker task promise resolution. + * Can be overridden. * - * @param worker Worker whose tasks are decreased. + * @param message The received message. + * @param promise The Promise response. */ - protected decreaseWorkersTasks (worker: Worker): void { - this.stepWorkerNumberOfTasks(worker, -1) - } - - /** - * Step the number of tasks that the given worker has applied. - * - * @param worker Worker whose tasks are set. - * @param step Worker number of tasks step. - */ - private stepWorkerNumberOfTasks (worker: Worker, step: number): void { - const numberOfTasksInProgress = this.tasks.get(worker) - if (numberOfTasksInProgress !== undefined) { - this.tasks.set(worker, numberOfTasksInProgress + step) - } else { - throw Error('Worker could not be found in tasks map') - } + protected afterPromiseWorkerResponseHook ( + message: MessageValue, + promise: PromiseWorkerResponseWrapper + ): void { + this.decreaseWorkerRunningTasks(promise.worker) + this.stepWorkerRunTasks(promise.worker, 1) + this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime) } /** * Removes the given worker from the pool. * - * @param worker Worker that will be removed. + * @param worker The worker that will be removed. */ protected removeWorker (worker: Worker): void { // Clean worker from data structure this.workers.splice(this.getWorkerIndex(worker), 1) - this.tasks.delete(worker) + this.removeWorkerTasksUsage(worker) } /** - * Choose a worker for the next task. + * Chooses a worker for the next task. * * The default implementation uses a round robin algorithm to distribute the load. * @@ -285,7 +290,7 @@ export abstract class AbstractPool< } /** - * Send a message to the given worker. + * Sends a message to the given worker. * * @param worker The worker which should receive the message. * @param message The message. @@ -296,24 +301,14 @@ export abstract class AbstractPool< ): void /** - * Register a listener callback on a given worker. + * Registers a listener callback on a given worker. * - * @param worker A worker. - * @param listener A message listener callback. + * @param worker The worker which should register a listener. + * @param listener The message listener callback. */ protected abstract registerWorkerMessageListener< Message extends Data | Response - > (worker: Worker, listener: (message: MessageValue) => void): void - - protected internalExecute ( - worker: Worker, - messageId: number - ): Promise { - this.increaseWorkersTask(worker) - return new Promise((resolve, reject) => { - this.promiseMap.set(messageId, { resolve, reject, worker }) - }) - } + >(worker: Worker, listener: (message: MessageValue) => void): void /** * Returns a newly created worker. @@ -345,8 +340,8 @@ export abstract class AbstractPool< this.workers.push(worker) - // Init tasks map - this.tasks.set(worker, 0) + // Init worker tasks usage map + this.initWorkerTasksUsage(worker) this.afterWorkerSetup(worker) @@ -363,18 +358,148 @@ export abstract class AbstractPool< if (message.id !== undefined) { const promise = this.promiseMap.get(message.id) if (promise !== undefined) { - this.decreaseWorkersTasks(promise.worker) - if (message.error) promise.reject(message.error) - else promise.resolve(message.data as Response) + if (message.error != null) { + promise.reject(message.error) + } else { + promise.resolve(message.data as Response) + } + this.afterPromiseWorkerResponseHook(message, promise) this.promiseMap.delete(message.id) } } } } + private async internalExecute ( + worker: Worker, + messageId: number + ): Promise { + this.beforePromiseWorkerResponseHook(worker) + return await new Promise((resolve, reject) => { + this.promiseMap.set(messageId, { resolve, reject, worker }) + }) + } + private checkAndEmitBusy (): void { - if (this.opts.enableEvents && this.busy) { + if (this.opts.enableEvents === true && this.busy) { this.emitter?.emit('busy') } } + + /** + * Increases the number of tasks that the given worker has applied. + * + * @param worker Worker which running tasks is increased. + */ + private increaseWorkerRunningTasks (worker: Worker): void { + this.stepWorkerRunningTasks(worker, 1) + } + + /** + * Decreases the number of tasks that the given worker has applied. + * + * @param worker Worker which running tasks is decreased. + */ + private decreaseWorkerRunningTasks (worker: Worker): void { + this.stepWorkerRunningTasks(worker, -1) + } + + /** + * Steps the number of tasks that the given worker has applied. + * + * @param worker Worker which running tasks are stepped. + * @param step Number of running tasks step. + */ + private stepWorkerRunningTasks (worker: Worker, step: number): void { + if (this.checkWorkerTasksUsage(worker)) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage + tasksUsage.running = tasksUsage.running + step + this.workersTasksUsage.set(worker, tasksUsage) + } + } + + /** + * Steps the number of tasks that the given worker has run. + * + * @param worker Worker which has run tasks. + * @param step Number of run tasks step. + */ + private stepWorkerRunTasks (worker: Worker, step: number): void { + if (this.checkWorkerTasksUsage(worker)) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage + tasksUsage.run = tasksUsage.run + step + this.workersTasksUsage.set(worker, tasksUsage) + } + } + + /** + * Updates tasks runtime for the given worker. + * + * @param worker Worker which run the task. + * @param taskRunTime Worker task runtime. + */ + private updateWorkerTasksRunTime ( + worker: Worker, + taskRunTime: number | undefined + ): void { + if ( + this.workerChoiceStrategyContext.getWorkerChoiceStrategy() + .requiredStatistics.runTime && + this.checkWorkerTasksUsage(worker) + ) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage + tasksUsage.runTime += taskRunTime ?? 0 + if (tasksUsage.run !== 0) { + tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run + } + this.workersTasksUsage.set(worker, tasksUsage) + } + } + + /** + * Checks if the given worker is registered in the workers tasks usage map. + * + * @param worker Worker to check. + * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise. + */ + private checkWorkerTasksUsage (worker: Worker): boolean { + const hasTasksUsage = this.workersTasksUsage.has(worker) + if (!hasTasksUsage) { + throw new Error('Worker could not be found in workers tasks usage map') + } + return hasTasksUsage + } + + /** + * Initializes tasks usage statistics. + * + * @param worker The worker. + */ + private initWorkerTasksUsage (worker: Worker): void { + this.workersTasksUsage.set(worker, { + run: 0, + running: 0, + runTime: 0, + avgRunTime: 0 + }) + } + + /** + * Removes worker tasks usage statistics. + * + * @param worker The worker. + */ + private removeWorkerTasksUsage (worker: Worker): void { + this.workersTasksUsage.delete(worker) + } + + /** + * Resets worker tasks usage statistics. + * + * @param worker The worker. + */ + private resetWorkerTasksUsage (worker: Worker): void { + this.removeWorkerTasksUsage(worker) + this.initWorkerTasksUsage(worker) + } }