X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=6b12c2f99b6b986d822668c2648e0ff0ec59bd33;hb=d15211d4a844f29140004fc2814316e62547aee0;hp=ab6c094094a29da154b6321e80d0567f675ff802;hpb=23135a899846318ad8c093ee03ae5301782bc011;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index ab6c0940..6b12c2f9 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -2,53 +2,43 @@ 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 { PoolEmitter } from './pool' import type { IPoolInternal, TasksUsage } from './pool-internal' -import { PoolEmitter, PoolType } from './pool-internal' +import { PoolType } from './pool-internal' +import type { IPoolWorker } from './pool-worker' import { WorkerChoiceStrategies, 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. */ 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 + /** @inheritDoc */ + public readonly workersTasksUsage: Map = new Map< + Worker, + TasksUsage >() /** @inheritDoc */ public readonly emitter?: PoolEmitter - /** @inheritDoc */ - public readonly max?: number - /** * The promise map. * @@ -58,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>() /** @@ -73,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 > /** @@ -102,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( @@ -115,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 @@ -125,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') } } @@ -135,12 +125,12 @@ export abstract class AbstractPool< throw new Error( 'Cannot instantiate a pool without specifying the number of workers' ) - } else if (Number.isSafeInteger(numberOfWorkers) === false) { - throw new Error( + } else if (!Number.isSafeInteger(numberOfWorkers)) { + 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) { @@ -182,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 ) @@ -209,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 } @@ -274,7 +270,7 @@ export abstract class AbstractPool< /** * 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 @@ -305,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.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. @@ -355,12 +341,7 @@ export abstract class AbstractPool< this.workers.push(worker) // Init worker tasks usage map - this.workersTasksUsage.set(worker, { - run: 0, - running: 0, - runTime: 0, - avgRunTime: 0 - }) + this.initWorkerTasksUsage(worker) this.afterWorkerSetup(worker) @@ -377,17 +358,30 @@ export abstract class AbstractPool< if (message.id !== undefined) { const promise = this.promiseMap.get(message.id) if (promise !== undefined) { + if (message.error != null) { + promise.reject(message.error) + } else { + promise.resolve(message.data as Response) + } this.afterPromiseWorkerResponseHook(message, promise) - if (message.error) promise.reject(message.error) - else promise.resolve(message.data as Response) 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') } } @@ -417,12 +411,10 @@ export abstract class AbstractPool< * @param step Number of running tasks step. */ private stepWorkerRunningTasks (worker: Worker, step: number): void { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined) { + if (this.checkWorkerTasksUsage(worker)) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage tasksUsage.running = tasksUsage.running + step this.workersTasksUsage.set(worker, tasksUsage) - } else { - throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) } } @@ -433,12 +425,10 @@ export abstract class AbstractPool< * @param step Number of run tasks step. */ private stepWorkerRunTasks (worker: Worker, step: number): void { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined) { + if (this.checkWorkerTasksUsage(worker)) { + const tasksUsage = this.workersTasksUsage.get(worker) as TasksUsage tasksUsage.run = tasksUsage.run + step this.workersTasksUsage.set(worker, tasksUsage) - } else { - throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) } } @@ -454,19 +444,44 @@ export abstract class AbstractPool< ): void { if ( this.workerChoiceStrategyContext.getWorkerChoiceStrategy() - .requiredStatistics.runTime === true + .requiredStatistics.runTime && + this.checkWorkerTasksUsage(worker) ) { - const tasksUsage = this.workersTasksUsage.get(worker) - if (tasksUsage !== undefined) { - tasksUsage.runTime += taskRunTime ?? 0 - if (tasksUsage.run !== 0) { - tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run - } - this.workersTasksUsage.set(worker, tasksUsage) - } else { - throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP) + 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 + }) } /** @@ -477,4 +492,14 @@ export abstract class AbstractPool< 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) + } }