-import type {
- MessageValue,
- PromiseWorkerResponseWrapper
-} from '../utility-types'
-import { EMPTY_FUNCTION, EMPTY_LITERAL } from '../utils'
-import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
-import type { PoolOptions } from './pool'
+import crypto from 'node:crypto'
+import type { MessageValue, PromiseResponseWrapper } from '../utility-types'
+import { EMPTY_FUNCTION } from '../utils'
+import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
+import { PoolEvents, type PoolOptions } from './pool'
import { PoolEmitter } from './pool'
-import type { IPoolInternal, TasksUsage } from './pool-internal'
+import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal'
import { PoolType } from './pool-internal'
import type { IPoolWorker } from './pool-worker'
import {
Data = unknown,
Response = unknown
> implements IPoolInternal<Worker, Data, Response> {
- /** {@inheritDoc} */
- public readonly workers: Worker[] = []
+ /** @inheritDoc */
+ public readonly workers: Array<WorkerType<Worker>> = []
- /** {@inheritDoc} */
- public readonly workersTasksUsage: Map<Worker, TasksUsage> = new Map<
- Worker,
- TasksUsage
- >()
-
- /** {@inheritDoc} */
+ /** @inheritDoc */
public readonly emitter?: PoolEmitter
/**
- * 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<Worker, Response>
- > = new Map<number, PromiseWorkerResponseWrapper<Worker, Response>>()
-
- /**
- * 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<Worker, Response>
+ > = new Map<string, PromiseResponseWrapper<Worker, Response>>()
/**
- * 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,
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++) {
if (this.opts.enableEvents === true) {
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)
- void (this.destroyWorker(workerCreated) as Promise<void>)
- }
- })
- return workerCreated
- },
- this.opts.workerChoiceStrategy
- )
+ this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext<
+ Worker,
+ Data,
+ Response
+ >(this, this.opts.workerChoiceStrategy)
}
private checkFilePath (filePath: string): void {
- if (filePath == null || filePath.length === 0) {
+ if (
+ filePath == null ||
+ (typeof filePath === 'string' && filePath.trim().length === 0)
+ ) {
throw new Error('Please specify a file with a worker implementation')
}
}
private checkPoolOptions (opts: PoolOptions<Worker>): void {
this.opts.workerChoiceStrategy =
opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
+ this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy)
this.opts.enableEvents = opts.enableEvents ?? true
}
- /** {@inheritDoc} */
- public abstract get type (): PoolType
-
- /** {@inheritDoc} */
- public get numberOfRunningTasks (): number {
- return this.promiseMap.size
+ private checkValidWorkerChoiceStrategy (
+ workerChoiceStrategy: WorkerChoiceStrategy
+ ): void {
+ if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) {
+ throw new Error(
+ `Invalid worker choice strategy '${workerChoiceStrategy}'`
+ )
+ }
}
- /** {@inheritDoc} */
- public getWorkerIndex (worker: Worker): number {
- return this.workers.indexOf(worker)
- }
+ /** @inheritDoc */
+ public abstract get type (): PoolType
- /** {@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} */
+ /** @inheritDoc */
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
+ this.checkValidWorkerChoiceStrategy(workerChoiceStrategy)
this.opts.workerChoiceStrategy = workerChoiceStrategy
- for (const worker of this.workers) {
- this.resetWorkerTasksUsage(worker)
+ 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} */
+ /** @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
+ /** @inheritDoc */
+ public findFreeWorkerKey (): number {
+ return this.workers.findIndex(workerItem => {
+ return workerItem.tasksUsage.running === 0
+ })
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public async execute (data: Data): Promise<Response> {
- // Configure worker to handle message with the specified task
- const worker = this.chooseWorker()
- const res = this.internalExecute(worker, this.nextMessageId)
+ const [workerKey, worker] = this.chooseWorker()
+ const messageId = crypto.randomUUID()
+ const res = this.internalExecute(workerKey, worker, messageId)
+ this.checkAndEmitFull()
this.checkAndEmitBusy()
this.sendToWorker(worker, {
- data: data ?? (EMPTY_LITERAL as Data),
- id: this.nextMessageId
+ // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+ data: data ?? ({} as Data),
+ id: messageId
})
- ++this.nextMessageId
// eslint-disable-next-line @typescript-eslint/return-await
return res
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public async destroy (): Promise<void> {
- await Promise.all(this.workers.map(worker => this.destroyWorker(worker)))
+ await Promise.all(
+ this.workers.map(async workerItem => {
+ await this.destroyWorker(workerItem.worker)
+ })
+ )
}
/**
- * Shutdowns given worker.
+ * Shutdowns given worker in the pool.
*
* @param worker - A worker within `workers`.
*/
/**
* 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
}
/**
* 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 worker - The worker.
* @param message - The received message.
- * @param promise - The Promise response.
*/
- protected afterPromiseWorkerResponseHook (
- message: MessageValue<Response>,
- promise: PromiseWorkerResponseWrapper<Worker, Response>
+ protected afterPromiseResponseHook (
+ worker: Worker,
+ message: MessageValue<Response>
): 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)
+ 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.runTime ?? 0
+ if (
+ this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime &&
+ workerTasksUsage.run !== 0
+ ) {
+ workerTasksUsage.avgRunTime =
+ workerTasksUsage.runTime / workerTasksUsage.run
+ }
+ }
}
/**
* 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] {
+ let workerKey: number
+ if (
+ this.type === PoolType.DYNAMIC &&
+ !this.full &&
+ this.findFreeWorkerKey() === -1
+ ) {
+ const createdWorker = this.createAndSetupWorker()
+ this.registerWorkerMessageListener(createdWorker, message => {
+ if (
+ isKillBehavior(KillBehaviors.HARD, message.kill) ||
+ (message.kill != null &&
+ this.getWorkerTasksUsage(createdWorker)?.running === 0)
+ ) {
+ // Kill message received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
+ void this.destroyWorker(createdWorker)
+ }
+ })
+ workerKey = this.getWorkerKey(createdWorker)
+ } else {
+ workerKey = this.workerChoiceStrategyContext.execute()
+ }
+ return [workerKey, this.workers[workerKey].worker]
}
/**
* 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.
+ * @virtual
*/
protected abstract afterWorkerSetup (worker: Worker): void
this.removeWorker(worker)
})
- this.workers.push(worker)
-
- // Init worker tasks usage map
- this.initWorkerTasksUsage(worker)
+ this.pushWorker(worker, {
+ run: 0,
+ running: 0,
+ runTime: 0,
+ avgRunTime: 0,
+ error: 0
+ })
this.afterWorkerSetup(worker)
*/
protected workerListener (): (message: MessageValue<Response>) => void {
return message => {
- if (message.id !== undefined) {
- const promise = this.promiseMap.get(message.id)
- if (promise !== undefined) {
+ if (message.id != null) {
+ // Task response received
+ const promiseResponse = this.promiseResponseMap.get(message.id)
+ if (promiseResponse != null) {
if (message.error != null) {
- promise.reject(message.error)
+ promiseResponse.reject(message.error)
} else {
- promise.resolve(message.data as Response)
+ promiseResponse.resolve(message.data as Response)
}
- this.afterPromiseWorkerResponseHook(message, promise)
- this.promiseMap.delete(message.id)
+ this.afterPromiseResponseHook(promiseResponse.worker, message)
+ this.promiseResponseMap.delete(message.id)
}
}
}
}
private async internalExecute (
+ workerKey: number,
worker: Worker,
- messageId: number
+ messageId: string
): Promise<Response> {
- this.beforePromiseWorkerResponseHook(worker)
+ this.beforePromiseResponseHook(workerKey)
return await new Promise<Response>((resolve, reject) => {
- this.promiseMap.set(messageId, { resolve, reject, worker })
+ this.promiseResponseMap.set(messageId, { resolve, reject, worker })
})
}
private checkAndEmitBusy (): void {
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)
+ this.emitter?.emit(PoolEvents.busy)
}
}
- /**
- * 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 {
+ private checkAndEmitFull (): void {
if (
- this.workerChoiceStrategyContext.getWorkerChoiceStrategy()
- .requiredStatistics.runTime &&
- this.checkWorkerTasksUsage(worker)
+ this.type === PoolType.DYNAMIC &&
+ this.opts.enableEvents === true &&
+ this.full
) {
- 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)
+ this.emitter?.emit(PoolEvents.full)
}
}
/**
- * Checks if the given worker is registered in the workers tasks usage map.
+ * Gets the given worker tasks usage in the pool.
*
- * @param worker - Worker to check.
- * @returns `true` if the worker is registered in the workers tasks usage map. `false` otherwise.
+ * @param worker - The worker.
+ * @returns The worker tasks usage.
*/
- 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')
+ private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
+ const workerKey = this.getWorkerKey(worker)
+ if (workerKey !== -1) {
+ return this.workers[workerKey].tasksUsage
}
- return hasTasksUsage
+ throw new Error('Worker could not be found in the pool')
}
/**
- * Initializes tasks usage statistics.
+ * Pushes the given worker in the pool.
*
* @param worker - The worker.
+ * @param tasksUsage - The worker tasks usage.
*/
- private initWorkerTasksUsage (worker: Worker): void {
- this.workersTasksUsage.set(worker, {
- run: 0,
- running: 0,
- runTime: 0,
- avgRunTime: 0
+ private pushWorker (worker: Worker, tasksUsage: TasksUsage): void {
+ this.workers.push({
+ worker,
+ tasksUsage
})
}
/**
- * Removes worker tasks usage statistics.
+ * Sets the given worker in the pool.
*
+ * @param workerKey - The worker key.
* @param worker - The worker.
+ * @param tasksUsage - The worker tasks usage.
*/
- private removeWorkerTasksUsage (worker: Worker): void {
- this.workersTasksUsage.delete(worker)
+ private setWorker (
+ workerKey: number,
+ worker: Worker,
+ tasksUsage: TasksUsage
+ ): void {
+ this.workers[workerKey] = {
+ worker,
+ tasksUsage
+ }
}
/**
- * Resets worker tasks usage statistics.
+ * Removes the given worker from the pool.
*
- * @param worker - The worker.
+ * @param worker - The worker that will be removed.
*/
- private resetWorkerTasksUsage (worker: Worker): void {
- this.removeWorkerTasksUsage(worker)
- this.initWorkerTasksUsage(worker)
+ protected removeWorker (worker: Worker): void {
+ const workerKey = this.getWorkerKey(worker)
+ this.workers.splice(workerKey, 1)
+ this.workerChoiceStrategyContext.remove(workerKey)
}
}
repositories / poolifier.git / blobdiff