X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=40e06b158fe3af59ec49527a6cc170822520657f;hb=11df35903da6f581c45e8b42e1d4fbd342bddc3c;hp=b3198af3750252a738dca6b08d85da91ee94c599;hpb=5c5a1fb79906f18560012263239e7bd611ee8d2b;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index b3198af3..40e06b15 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,144 +1,234 @@ -import EventEmitter from 'events' -import type { MessageValue } from '../utility-types' -import type { IPool } from './pool' +import type { + MessageValue, + PromiseWorkerResponseWrapper +} from '../utility-types' +import { EMPTY_FUNCTION } from '../utils' +import { isKillBehavior, KillBehaviors } from '../worker/worker-options' +import type { PoolOptions } from './pool' +import type { IPoolInternal, TasksUsage } from './pool-internal' +import { PoolEmitter, 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' -/** - * Callback invoked if the worker raised an error. - */ -export type ErrorHandler = (this: Worker, e: Error) => void +const WORKER_NOT_FOUND_TASKS_USAGE_MAP = + 'Worker could not be found in worker tasks usage map' /** - * Callback invoked when the worker has started successfully. - */ -export type OnlineHandler = (this: Worker) => void - -/** - * Callback invoked when the worker exits successfully. - */ -export type ExitHandler = (this: Worker, code: number) => void - -/** - * Basic interface that describes the minimum required implementation of listener events for a pool-worker. - */ -export interface IWorker { - on(event: 'error', handler: ErrorHandler): void - on(event: 'online', handler: OnlineHandler): void - on(event: 'exit', handler: ExitHandler): void -} - -/** - * Options for a poolifier pool. - */ -export interface PoolOptions { - /** - * A function that will listen for error event on each worker. - */ - errorHandler?: ErrorHandler - /** - * A function that will listen for online event on each worker. - */ - onlineHandler?: OnlineHandler - /** - * A function that will listen for exit event on each worker. - */ - exitHandler?: ExitHandler - /** - * This is just to avoid non-useful warning messages. - * - * Will be used to set `maxListeners` on event emitters (workers are event emitters). - * - * @default 1000 - * @see [Node events emitter.setMaxListeners(n)](https://nodejs.org/api/events.html#events_emitter_setmaxlisteners_n) - */ - maxTasks?: number -} - -/** - * Internal poolifier pool emitter. - */ -class PoolEmitter extends EventEmitter {} - -/** - * 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. - * @template Response Type of response of execution. + * @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 IWorker, + Worker extends IPoolWorker, Data = unknown, Response = unknown -> implements IPool { - /** - * List of currently available workers. - */ +> implements IPoolInternal { + /** @inheritDoc */ public readonly workers: Worker[] = [] - /** - * ID for the next worker. - */ - public nextWorker: number = 0 + /** @inheritDoc */ + public readonly workersTasksUsage: Map = new Map< + Worker, + TasksUsage + >() - /** - * - `key`: The `Worker` - * - `value`: Number of tasks that has been assigned to that worker since it started - */ - public readonly tasks: Map = new Map() + /** @inheritDoc */ + public readonly emitter?: PoolEmitter + + /** @inheritDoc */ + public readonly max?: number /** - * Emitter on which events can be listened to. + * The promise map. * - * Events that can currently be listened to: + * - `key`: This is the message Id of each submitted task. + * - `value`: An object that contains the worker, the resolve function and the reject function. * - * - `'FullPool'` + * 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. */ - public readonly emitter: PoolEmitter + protected nextMessageId: number = 0 /** - * ID of the next message. + * Worker choice strategy instance implementing the worker choice algorithm. + * + * Default to a strategy implementing a round robin algorithm. */ - protected id: number = 0 + protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< + 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. Default: `{ maxTasks: 1000 }` + * @param opts Options for the pool. */ public constructor ( public readonly numberOfWorkers: number, public readonly filePath: string, - public readonly opts: PoolOptions = { maxTasks: 1000 } + public readonly opts: PoolOptions ) { if (!this.isMain()) { throw new Error('Cannot start a pool from a worker!') } - // TODO christopher 2021-02-07: Improve this check e.g. with a pattern or blank check - if (!this.filePath) { + this.checkNumberOfWorkers(this.numberOfWorkers) + this.checkFilePath(this.filePath) + this.checkPoolOptions(this.opts) + this.setupHook() + + for (let i = 1; i <= this.numberOfWorkers; i++) { + this.createAndSetupWorker() + } + + if (this.opts.enableEvents) { + this.emitter = new PoolEmitter() + } + this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( + this, + () => { + const workerCreated = this.createAndSetupWorker() + this.registerWorkerMessageListener(workerCreated, message => { + if ( + isKillBehavior(KillBehaviors.HARD, message.kill) || + 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 + } + }) + return workerCreated + }, + this.opts.workerChoiceStrategy + ) + } + + private checkFilePath (filePath: string): void { + if (!filePath) { throw new Error('Please specify a file with a worker implementation') } + } - this.setupHook() + private checkNumberOfWorkers (numberOfWorkers: number): void { + if (numberOfWorkers == null) { + throw new Error( + 'Cannot instantiate a pool without specifying the number of workers' + ) + } else if (Number.isSafeInteger(numberOfWorkers) === false) { + throw new Error( + 'Cannot instantiate a pool with a non integer number of workers' + ) + } else if (numberOfWorkers < 0) { + throw new Error( + 'Cannot instantiate a pool with a negative number of workers' + ) + } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { + throw new Error('Cannot instantiate a fixed pool with no worker') + } + } - for (let i = 1; i <= this.numberOfWorkers; i++) { - this.internalNewWorker() + private checkPoolOptions (opts: PoolOptions): void { + this.opts.workerChoiceStrategy = + opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + 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 + } + + /** @inheritDoc */ + public getWorkerAverageTasksRunTime (worker: Worker): number | undefined { + return this.workersTasksUsage.get(worker)?.avgRunTime + } + + /** @inheritDoc */ + public setWorkerChoiceStrategy ( + workerChoiceStrategy: WorkerChoiceStrategy + ): void { + this.opts.workerChoiceStrategy = workerChoiceStrategy + for (const worker of this.workers) { + this.resetWorkerTasksUsage(worker) + } + this.workerChoiceStrategyContext.setWorkerChoiceStrategy( + workerChoiceStrategy + ) + } + + /** @inheritDoc */ + public abstract get busy (): boolean + + protected internalGetBusyStatus (): boolean { + return ( + this.numberOfRunningTasks >= this.numberOfWorkers && + this.findFreeWorker() === false + ) + } + + /** @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 + } + + /** @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) + this.checkAndEmitBusy() + data = data ?? ({} as Data) + this.sendToWorker(worker, { data, id: messageId }) + return res + } - this.emitter = new PoolEmitter() + /** @inheritDoc */ + public async destroy (): Promise { + await Promise.all(this.workers.map(worker => this.destroyWorker(worker))) } /** - * Number of workers that this pool should manage. + * Shutdowns given worker. * - * @returns Number of workers that this pool manages. - * @deprecated Only here for backward compatibility. + * @param worker A worker within `workers`. */ - // eslint-disable-next-line spellcheck/spell-checker - public get numWorkers (): number { - return this.numberOfWorkers - } + protected abstract destroyWorker (worker: Worker): void | Promise /** * Setup hook that can be overridden by a Poolifier pool implementation @@ -153,21 +243,56 @@ export abstract class AbstractPool< */ protected abstract isMain (): boolean - public async destroy (): Promise { - for (const worker of this.workers) { - await this.destroyWorker(worker) - } + /** + * Hook executed before the worker task promise resolution. + * Can be overridden. + * + * @param worker The worker. + */ + protected beforePromiseWorkerResponseHook (worker: Worker): void { + this.increaseWorkerRunningTasks(worker) } /** - * Shut down given worker. + * Hook executed after the worker task promise resolution. + * Can be overridden. * - * @param worker A worker within `workers`. + * @param message The received message. + * @param promise The Promise response. */ - protected abstract destroyWorker (worker: Worker): void | Promise + 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 The 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) + } + + /** + * Chooses a worker for the next task. + * + * The default implementation uses a round robin algorithm to distribute the load. + * + * @returns Worker. + */ + protected chooseWorker (): Worker { + return this.workerChoiceStrategyContext.execute() + } /** - * 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. @@ -178,107 +303,195 @@ export abstract class AbstractPool< ): void /** - * Adds the given worker to the pool. + * Registers a listener callback on a given worker. * - * @param worker Worker that will be added. + * @param worker The worker which should register a listener. + * @param listener The message listener callback. */ - protected addWorker (worker: Worker): void { - const previousWorkerIndex = this.tasks.get(worker) - if (previousWorkerIndex !== undefined) { - this.tasks.set(worker, previousWorkerIndex + 1) - } else { - throw Error('Worker could not be found in tasks map') - } + 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 }) + }) } /** - * Removes the given worker from the pool. + * Returns a newly created worker. + */ + protected abstract createWorker (): Worker + + /** + * Function that can be hooked up when a worker has been newly created and moved to the workers registry. * - * @param worker Worker that will be removed. + * 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. */ - protected removeWorker (worker: Worker): void { - // Clean worker from data structure - const workerIndex = this.workers.indexOf(worker) - this.workers.splice(workerIndex, 1) - this.tasks.delete(worker) - } + protected abstract afterWorkerSetup (worker: Worker): void - public execute (data: Data): Promise { - // Configure worker to handle message with the specified task - const worker = this.chooseWorker() - this.addWorker(worker) - const id = ++this.id - const res = this.internalExecute(worker, id) - this.sendToWorker(worker, { data: data || ({} as Data), id: id }) - return res - } + /** + * Creates a new worker for this pool and sets it up completely. + * + * @returns New, completely set up worker. + */ + protected createAndSetupWorker (): Worker { + const worker = this.createWorker() - protected abstract registerWorkerMessageListener ( - port: Worker, - listener: (message: MessageValue) => void - ): void + worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION) + 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)) - protected abstract unregisterWorkerMessageListener ( - port: Worker, - listener: (message: MessageValue) => void - ): void + this.workers.push(worker) - protected internalExecute (worker: Worker, id: number): Promise { - return new Promise((resolve, reject) => { - const listener: (message: MessageValue) => void = message => { - if (message.id === id) { - this.unregisterWorkerMessageListener(worker, listener) - this.addWorker(worker) - if (message.error) reject(message.error) - else resolve(message.data as Response) + // Init worker tasks usage map + this.initWorkerTasksUsage(worker) + + this.afterWorkerSetup(worker) + + return worker + } + + /** + * This function is the listener registered for each worker. + * + * @returns The listener function to execute when a message is received from a worker. + */ + 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) } } - this.registerWorkerMessageListener(worker, listener) - }) + } + } + + private checkAndEmitBusy (): void { + if (this.opts.enableEvents && this.busy) { + this.emitter?.emit('busy') + } } /** - * Choose a worker for the next task. + * Increases the number of tasks that the given worker has applied. * - * The default implementation uses a round robin algorithm to distribute the load. + * @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. * - * @returns Worker. + * @param worker Worker which running tasks is decreased. */ - protected chooseWorker (): Worker { - this.nextWorker = - this.nextWorker === this.workers.length - 1 ? 0 : this.nextWorker + 1 - return this.workers[this.nextWorker] + private decreaseWorkerRunningTasks (worker: Worker): void { + this.stepWorkerRunningTasks(worker, -1) } /** - * Returns a newly created worker. + * 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. */ - protected abstract newWorker (): Worker + 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) + } + } /** - * Function that can be hooked up when a worker has been newly created and moved to the workers registry. + * Steps the number of tasks that the given worker has run. * - * Can be used to update the `maxListeners` or binding the `main-worker`<->`worker` connection if not bind by default. + * @param worker Worker which has run tasks. + * @param step Number of run tasks step. + */ + 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) + } + } + + /** + * Updates tasks runtime for the given worker. * - * @param worker The newly created worker. + * @param worker Worker which run the task. + * @param taskRunTime Worker task runtime. */ - protected abstract afterNewWorkerPushed (worker: Worker): void + private updateWorkerTasksRunTime ( + worker: Worker, + taskRunTime: number | undefined + ): void { + if ( + this.workerChoiceStrategyContext.getWorkerChoiceStrategy() + .requiredStatistics.runTime === true + ) { + 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) + } + } + } /** - * Creates a new worker for this pool and sets it up completely. + * Initializes tasks usage statistics. * - * @returns New, completely set up worker. + * @param worker The worker. */ - protected internalNewWorker (): Worker { - const worker: Worker = this.newWorker() - worker.on('error', this.opts.errorHandler ?? (() => {})) - worker.on('online', this.opts.onlineHandler ?? (() => {})) - // TODO handle properly when a worker exit - worker.on('exit', this.opts.exitHandler ?? (() => {})) - this.workers.push(worker) - this.afterNewWorkerPushed(worker) - // init tasks map - this.tasks.set(worker, 0) - return worker + 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) } }