X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=97225246cde2e8baab84cd2a60968ca7d09aa079;hb=d99ba5a8a292772965b5027272a8dc677a6ad008;hp=e204e1241811c2c0279520706fdce39ad247e881;hpb=10fcfaf49c0b6d6f0e1d137eeba1e9d805c9a815;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index e204e124..97225246 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,89 +1,66 @@ -import type { - MessageValue, - PromiseWorkerResponseWrapper -} from '../utility-types' +import crypto from 'node:crypto' +import type { MessageValue, PromiseResponseWrapper } from '../utility-types' import { EMPTY_FUNCTION } from '../utils' -import { isKillBehavior, KillBehaviors } from '../worker/worker-options' -import type { AbstractPoolWorker } from './abstract-pool-worker' +import { KillBehaviors, isKillBehavior } from '../worker/worker-options' import type { PoolOptions } from './pool' -import type { IPoolInternal, TasksUsage } from './pool-internal' -import { PoolEmitter, PoolType } from './pool-internal' +import { PoolEmitter } from './pool' +import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal' +import { PoolType } from './pool-internal' +import type { IPoolWorker } from './pool-worker' import { WorkerChoiceStrategies, - WorkerChoiceStrategy + type WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types' import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' -const WORKER_NOT_FOUND_TASKS_USAGE_MAP = - 'Worker could not be found in worker tasks usage map' - /** - * 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. + * @typeParam Worker - Type of worker which manages this pool. + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam 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 { /** @inheritDoc */ - public readonly workers: Worker[] = [] - - /** - * The workers tasks usage map. - * - * `key`: The `Worker` - * `value`: Worker tasks usage statistics. - */ - protected workersTasksUsage: Map = new Map< - Worker, - TasksUsage - >() + public readonly workers: Array> = [] /** @inheritDoc */ public readonly emitter?: PoolEmitter - /** @inheritDoc */ - public readonly max?: number - /** - * The promise map. + * The promise response map. * - * - `key`: This is the message Id of each submitted task. - * - `value`: An object that contains the worker, the resolve function and the reject function. + * - `key`: The message id of each submitted task. + * - `value`: An object that contains the worker, the promise resolve and reject callbacks. * - * 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 - > = new Map>() - - /** - * Id of the next message. + * When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message. */ - protected nextMessageId: number = 0 + protected promiseResponseMap: Map< + string, + PromiseResponseWrapper + > = new Map>() /** - * Worker choice strategy instance implementing the worker choice algorithm. + * Worker choice strategy context referencing a worker choice algorithm implementation. * - * Default to a strategy implementing a round robin algorithm. + * Default to a round robin algorithm. */ protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< - Worker, - Data, - Response + Worker, + Data, + Response > /** * Constructs a new poolifier pool. * - * @param numberOfWorkers Number of workers that this pool should manage. - * @param filePath Path to the worker-file. - * @param opts Options for the pool. + * @param numberOfWorkers - Number of workers that this pool should manage. + * @param filePath - Path to the worker-file. + * @param opts - Options for the pool. */ public constructor ( public readonly numberOfWorkers: number, @@ -96,36 +73,50 @@ export abstract class AbstractPool< this.checkNumberOfWorkers(this.numberOfWorkers) this.checkFilePath(this.filePath) this.checkPoolOptions(this.opts) + + this.chooseWorker.bind(this) + this.internalExecute.bind(this) + this.checkAndEmitFull.bind(this) + this.checkAndEmitBusy.bind(this) + this.sendToWorker.bind(this) + this.setupHook() for (let i = 1; i <= this.numberOfWorkers; i++) { this.createAndSetupWorker() } - if (this.opts.enableEvents) { + if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } - this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( + this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext< + Worker, + Data, + Response + >( this, () => { - const workerCreated = this.createAndSetupWorker() - this.registerWorkerMessageListener(workerCreated, message => { + const createdWorker = this.createAndSetupWorker() + this.registerWorkerMessageListener(createdWorker, message => { if ( isKillBehavior(KillBehaviors.HARD, message.kill) || - this.getWorkerRunningTasks(workerCreated) === 0 + this.getWorkerTasksUsage(createdWorker)?.running === 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(createdWorker) } }) - return workerCreated + return this.getWorkerKey(createdWorker) }, this.opts.workerChoiceStrategy ) } private checkFilePath (filePath: string): void { - if (!filePath) { + if ( + filePath == null || + (typeof filePath === 'string' && filePath.trim().length === 0) + ) { throw new Error('Please specify a file with a worker implementation') } } @@ -136,11 +127,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,30 +142,36 @@ export abstract class AbstractPool< private checkPoolOptions (opts: PoolOptions): void { this.opts.workerChoiceStrategy = opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + if ( + !Object.values(WorkerChoiceStrategies).includes( + this.opts.workerChoiceStrategy + ) + ) { + throw new Error( + `Invalid worker choice strategy '${this.opts.workerChoiceStrategy}'` + ) + } this.opts.enableEvents = opts.enableEvents ?? true } /** @inheritDoc */ public abstract get type (): PoolType - /** @inheritDoc */ - public get numberOfRunningTasks (): number { - return this.promiseMap.size - } - - /** @inheritDoc */ - public getWorkerIndex (worker: Worker): number { - return this.workers.indexOf(worker) - } - - /** @inheritDoc */ - public getWorkerRunningTasks (worker: Worker): number | undefined { - return this.workersTasksUsage.get(worker)?.running + /** + * Number of tasks concurrently running in the pool. + */ + private get numberOfRunningTasks (): number { + return this.promiseResponseMap.size } - /** @inheritDoc */ - public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { - return this.workersTasksUsage.get(worker)?.avgRunTime + /** + * Gets the given worker key. + * + * @param worker - The worker. + * @returns The worker key if the worker is found in the pool, `-1` otherwise. + */ + private getWorkerKey (worker: Worker): number { + return this.workers.findIndex(workerItem => workerItem.worker === worker) } /** @inheritDoc */ @@ -182,62 +179,81 @@ export abstract class AbstractPool< workerChoiceStrategy: WorkerChoiceStrategy ): void { this.opts.workerChoiceStrategy = workerChoiceStrategy + for (const [index, workerItem] of this.workers.entries()) { + this.setWorker(index, workerItem.worker, { + run: 0, + running: 0, + runTime: 0, + avgRunTime: 0, + error: 0 + }) + } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( workerChoiceStrategy ) } + /** @inheritDoc */ + public abstract get full (): boolean + /** @inheritDoc */ public abstract get busy (): boolean - protected internalGetBusyStatus (): boolean { + protected internalBusy (): boolean { return ( this.numberOfRunningTasks >= this.numberOfWorkers && - this.findFreeWorker() === false + this.findFreeWorkerKey() === -1 ) } /** @inheritDoc */ - public findFreeWorker (): Worker | false { - for (const worker of this.workers) { - if (this.getWorkerRunningTasks(worker) === 0) { - // A worker is free, return the matching worker - return worker - } - } - return false + public findFreeWorkerKey (): number { + return this.workers.findIndex(workerItem => { + return workerItem.tasksUsage.running === 0 + }) } /** @inheritDoc */ - public 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) + public async execute (data: Data): Promise { + const [workerKey, worker] = this.chooseWorker() + const messageId = crypto.randomUUID() + const res = this.internalExecute(workerKey, worker, messageId) + this.checkAndEmitFull() this.checkAndEmitBusy() - data = data ?? ({} as Data) - this.sendToWorker(worker, { data, id: messageId }) + this.sendToWorker(worker, { + // eslint-disable-next-line @typescript-eslint/consistent-type-assertions + data: data ?? ({} as Data), + id: messageId + }) + // eslint-disable-next-line @typescript-eslint/return-await return res } /** @inheritDoc */ public async destroy (): Promise { - await Promise.all(this.workers.map(worker => this.destroyWorker(worker))) + await Promise.all( + this.workers.map(async workerItem => { + await this.destroyWorker(workerItem.worker) + }) + ) } /** - * Shut down given worker. + * Shutdowns given worker in the pool. * - * @param worker A worker within `workers`. + * @param worker - A worker within `workers`. */ protected abstract destroyWorker (worker: Worker): void | Promise /** * Setup hook that can be overridden by a Poolifier pool implementation * to run code before workers are created in the abstract constructor. + * Can be overridden + * + * @virtual */ protected setupHook (): void { - // Can be overridden + // Intentionally empty } /** @@ -249,55 +265,58 @@ export abstract class AbstractPool< * Hook executed before the worker task promise resolution. * Can be overridden. * - * @param worker The worker. + * @param workerKey - The worker key. */ - protected beforePromiseWorkerResponseHook (worker: Worker): void { - this.increaseWorkerRunningTasks(worker) + protected beforePromiseResponseHook (workerKey: number): void { + ++this.workers[workerKey].tasksUsage.running } /** * Hook executed after the worker task promise resolution. * Can be overridden. * - * @param message The received message. - * @param promise The Promise response. + * @param worker - The worker. + * @param message - The received message. */ - protected afterPromiseWorkerResponseHook ( - message: MessageValue, - promise: PromiseWorkerResponseWrapper + protected afterPromiseResponseHook ( + worker: Worker, + message: MessageValue ): 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. - */ - protected removeWorker (worker: Worker): void { - // Clean worker from data structure - this.workers.splice(this.getWorkerIndex(worker), 1) - this.removeWorkerTasksUsage(worker) + const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage + --workerTasksUsage.running + ++workerTasksUsage.run + if (message.error != null) { + ++workerTasksUsage.error + } + if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) { + workerTasksUsage.runTime += message.taskRunTime ?? 0 + if ( + this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime && + workerTasksUsage.run !== 0 + ) { + workerTasksUsage.avgRunTime = + workerTasksUsage.runTime / workerTasksUsage.run + } + } } /** - * 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. + * The default uses a round robin algorithm to distribute the load. * - * @returns Worker. + * @returns [worker key, worker]. */ - protected chooseWorker (): Worker { - return this.workerChoiceStrategyContext.execute() + protected chooseWorker (): [number, Worker] { + const workerKey = this.workerChoiceStrategyContext.execute() + return [workerKey, this.workers[workerKey].worker] } /** - * 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. + * @param worker - The worker which should receive the message. + * @param message - The message. */ protected abstract sendToWorker ( worker: Worker, @@ -305,24 +324,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.beforePromiseWorkerResponseHook(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. @@ -332,9 +341,10 @@ export abstract class AbstractPool< /** * Function that can be hooked up when a worker has been newly created and moved to the workers registry. * - * Can be used to update the `maxListeners` or binding the `main-worker`<->`worker` connection if not bind by default. + * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default. * - * @param worker The newly created worker. + * @param worker - The newly created worker. + * @virtual */ protected abstract afterWorkerSetup (worker: Worker): void @@ -350,16 +360,16 @@ export abstract class AbstractPool< worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) - worker.once('exit', () => this.removeWorker(worker)) - - this.workers.push(worker) + worker.once('exit', () => { + this.removeWorker(worker) + }) - // Init worker tasks usage map - this.workersTasksUsage.set(worker, { + this.pushWorker(worker, { run: 0, running: 0, runTime: 0, - avgRunTime: 0 + avgRunTime: 0, + error: 0 }) this.afterWorkerSetup(worker) @@ -374,105 +384,101 @@ export abstract class AbstractPool< */ protected workerListener (): (message: MessageValue) => void { return message => { - if (message.id !== undefined) { - const promise = this.promiseMap.get(message.id) - if (promise !== undefined) { - this.afterPromiseWorkerResponseHook(message, promise) - if (message.error) promise.reject(message.error) - else promise.resolve(message.data as Response) - this.promiseMap.delete(message.id) + if (message.id != null) { + const promiseResponse = this.promiseResponseMap.get(message.id) + if (promiseResponse != null) { + if (message.error != null) { + promiseResponse.reject(message.error) + } else { + promiseResponse.resolve(message.data as Response) + } + this.afterPromiseResponseHook(promiseResponse.worker, message) + this.promiseResponseMap.delete(message.id) } } } } + private async internalExecute ( + workerKey: number, + worker: Worker, + messageId: string + ): Promise { + this.beforePromiseResponseHook(workerKey) + return await new Promise((resolve, reject) => { + this.promiseResponseMap.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) + private checkAndEmitFull (): void { + if ( + this.type === PoolType.DYNAMIC && + this.opts.enableEvents === true && + this.full + ) { + this.emitter?.emit('full') + } } /** - * Steps the number of tasks that the given worker has applied. + * Gets the given worker tasks usage in the pool. * - * @param worker Worker which running tasks are stepped. - * @param step Number of running tasks step. + * @param worker - The worker. + * @returns The worker tasks usage. */ - private stepWorkerRunningTasks (worker: Worker, step: number): void { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined) { - tasksUsage.running = tasksUsage.running + step - this.workersTasksUsage.set(worker, tasksUsage) - } else { - throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) + private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { + const workerKey = this.getWorkerKey(worker) + if (workerKey !== -1) { + return this.workers[workerKey].tasksUsage } + throw new Error('Worker could not be found in the pool') } /** - * Steps the number of tasks that the given worker has run. + * Pushes the given worker in the pool. * - * @param worker Worker which has run tasks. - * @param step Number of run tasks step. + * @param worker - The worker. + * @param tasksUsage - The worker tasks usage. */ - private stepWorkerRunTasks (worker: Worker, step: number): void { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined) { - tasksUsage.run = tasksUsage.run + step - this.workersTasksUsage.set(worker, tasksUsage) - } else { - throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) - } + private pushWorker (worker: Worker, tasksUsage: TasksUsage): void { + this.workers.push({ + worker, + tasksUsage + }) } /** - * Updates tasks run time for the given worker. + * Sets the given worker in the pool. * - * @param worker Worker which run the task. - * @param taskRunTime Worker task run time. + * @param workerKey - The worker key. + * @param worker - The worker. + * @param tasksUsage - The worker tasks usage. */ - private updateWorkerTasksRunTime ( + private setWorker ( + workerKey: number, worker: Worker, - taskRunTime: number | undefined + tasksUsage: TasksUsage ): void { - if ( - this.workerChoiceStrategyContext.getWorkerChoiceStrategy() - .requiredStatistics.runTime === true - ) { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined && tasksUsage.run !== 0) { - tasksUsage.runTime += taskRunTime ?? 0 - tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run - this.workersTasksUsage.set(worker, tasksUsage) - } else { - throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) - } + this.workers[workerKey] = { + worker, + tasksUsage } } /** - * Removes worker tasks usage statistics. + * Removes the given worker from the pool. * - * @param worker The worker. + * @param worker - The worker that will be removed. */ - private removeWorkerTasksUsage (worker: Worker): void { - this.workersTasksUsage.delete(worker) + protected removeWorker (worker: Worker): void { + const workerKey = this.getWorkerKey(worker) + this.workers.splice(workerKey, 1) + this.workerChoiceStrategyContext.remove(workerKey) } }