} from '../utility-types'
import { EMPTY_FUNCTION } from '../utils'
import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
-import type { IPoolInternal } from './pool-internal'
+import type { AbstractPoolWorker } from './abstract-pool-worker'
+import type { PoolOptions } from './pool'
+import type { IPoolInternal, TasksUsage } from './pool-internal'
import { PoolEmitter, PoolType } from './pool-internal'
-import type { WorkerChoiceStrategy } from './selection-strategies'
import {
WorkerChoiceStrategies,
- WorkerChoiceStrategyContext
-} from './selection-strategies'
+ WorkerChoiceStrategy
+} from './selection-strategies/selection-strategies-types'
+import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
-/**
- * Callback invoked if the worker has received a message.
- */
-export type MessageHandler<Worker> = (this: Worker, m: unknown) => void
-
-/**
- * Callback invoked if the worker raised an error.
- */
-export type ErrorHandler<Worker> = (this: Worker, e: Error) => void
-
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker> = (this: Worker) => void
-
-/**
- * Callback invoked when the worker exits successfully.
- */
-export type ExitHandler<Worker> = (this: Worker, code: number) => void
-
-/**
- * Basic interface that describes the minimum required implementation of listener events for a pool-worker.
- */
-export interface IWorker {
- /**
- * Register a listener to the message event.
- *
- * @param event `'message'`.
- * @param handler The message handler.
- */
- on(event: 'message', handler: MessageHandler<this>): void
- /**
- * Register a listener to the error event.
- *
- * @param event `'error'`.
- * @param handler The error handler.
- */
- on(event: 'error', handler: ErrorHandler<this>): void
- /**
- * Register a listener to the online event.
- *
- * @param event `'online'`.
- * @param handler The online handler.
- */
- on(event: 'online', handler: OnlineHandler<this>): void
- /**
- * Register a listener to the exit event.
- *
- * @param event `'exit'`.
- * @param handler The exit handler.
- */
- on(event: 'exit', handler: ExitHandler<this>): void
- /**
- * Register a listener to the exit event that will only performed once.
- *
- * @param event `'exit'`.
- * @param handler The exit handler.
- */
- once(event: 'exit', handler: ExitHandler<this>): void
-}
-
-/**
- * Options for a poolifier pool.
- */
-export interface PoolOptions<Worker> {
- /**
- * A function that will listen for message event on each worker.
- */
- messageHandler?: MessageHandler<Worker>
- /**
- * A function that will listen for error event on each worker.
- */
- errorHandler?: ErrorHandler<Worker>
- /**
- * A function that will listen for online event on each worker.
- */
- onlineHandler?: OnlineHandler<Worker>
- /**
- * A function that will listen for exit event on each worker.
- */
- exitHandler?: ExitHandler<Worker>
- /**
- * The work choice strategy to use in this pool.
- */
- workerChoiceStrategy?: WorkerChoiceStrategy
- /**
- * Pool events emission.
- *
- * @default true
- */
- enableEvents?: boolean
-}
+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.
* @template Response Type of response of execution. This can only be serializable data.
*/
export abstract class AbstractPool<
- Worker extends IWorker,
+ Worker extends AbstractPoolWorker,
Data = unknown,
Response = unknown
> implements IPoolInternal<Worker, Data, Response> {
- /** @inheritdoc */
+ /** @inheritDoc */
public readonly workers: Worker[] = []
- /** @inheritdoc */
- public readonly tasks: Map<Worker, number> = new Map<Worker, number>()
+ /**
+ * The workers tasks usage map.
+ *
+ * `key`: The `Worker`
+ * `value`: Worker tasks usage statistics.
+ */
+ protected workersTasksUsage: Map<Worker, TasksUsage> = new Map<
+ Worker,
+ TasksUsage
+ >()
- /** @inheritdoc */
+ /** @inheritDoc */
public readonly emitter?: PoolEmitter
- /** @inheritdoc */
+ /** @inheritDoc */
public readonly max?: number
/**
this.registerWorkerMessageListener(workerCreated, message => {
if (
isKillBehavior(KillBehaviors.HARD, message.kill) ||
- this.tasks.get(workerCreated) === 0
+ 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
throw new Error(
'Cannot instantiate a pool without specifying the number of workers'
)
- } else if (!Number.isSafeInteger(numberOfWorkers)) {
+ } else if (Number.isSafeInteger(numberOfWorkers) === false) {
throw new Error(
'Cannot instantiate a pool with a non integer number of workers'
)
this.opts.enableEvents = opts.enableEvents ?? true
}
- /** @inheritdoc */
+ /** @inheritDoc */
public abstract get type (): PoolType
- /** @inheritdoc */
+ /** @inheritDoc */
public get numberOfRunningTasks (): number {
return this.promiseMap.size
}
- /** @inheritdoc */
+ /** @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 {
)
}
- /** @inheritdoc */
+ /** @inheritDoc */
public abstract get busy (): boolean
protected internalGetBusyStatus (): boolean {
return (
this.numberOfRunningTasks >= this.numberOfWorkers &&
- this.findFreeTasksMapEntry() === false
+ this.findFreeWorker() === false
)
}
- /** @inheritdoc */
- public findFreeTasksMapEntry (): [Worker, number] | false {
- for (const [worker, numberOfTasks] of this.tasks) {
- if (numberOfTasks === 0) {
- // A worker is free, return the matching tasks map entry
- return [worker, numberOfTasks]
+ /** @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 */
+ /** @inheritDoc */
public execute (data: Data): Promise<Response> {
// Configure worker to handle message with the specified task
const worker = this.chooseWorker()
return res
}
- /** @inheritdoc */
+ /** @inheritDoc */
public async destroy (): Promise<void> {
await Promise.all(this.workers.map(worker => this.destroyWorker(worker)))
}
/**
- * Shut down given worker.
+ * Shutdowns given worker.
*
* @param worker A worker within `workers`.
*/
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<Response>,
+ promise: PromiseWorkerResponseWrapper<Worker, Response>
+ ): void {
+ this.decreaseWorkerRunningTasks(promise.worker)
+ this.stepWorkerRunTasks(promise.worker, 1)
+ this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime)
}
/**
*/
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)
+ this.workers.splice(this.getWorkerIndex(worker), 1)
+ 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.
*
}
/**
- * 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.
): 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.
worker: Worker,
messageId: number
): Promise<Response> {
- this.increaseWorkersTask(worker)
+ this.beforePromiseWorkerResponseHook(worker)
return new Promise<Response>((resolve, reject) => {
this.promiseMap.set(messageId, { resolve, reject, worker })
})
this.workers.push(worker)
- // Init tasks map
- this.tasks.set(worker, 0)
+ // Init worker tasks usage map
+ this.workersTasksUsage.set(worker, {
+ run: 0,
+ running: 0,
+ runTime: 0,
+ avgRunTime: 0
+ })
this.afterWorkerSetup(worker)
if (message.id !== undefined) {
const promise = this.promiseMap.get(message.id)
if (promise !== undefined) {
- this.decreaseWorkersTasks(promise.worker)
+ this.afterPromiseWorkerResponseHook(message, promise)
if (message.error) promise.reject(message.error)
else promise.resolve(message.data as Response)
this.promiseMap.delete(message.id)
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 {
+ 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)
+ }
+ }
+
+ /**
+ * 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 {
+ 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 Worker which run the task.
+ * @param taskRunTime Worker task runtime.
+ */
+ 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)
+ }
+ }
+ }
+
+ /**
+ * Removes worker tasks usage statistics.
+ *
+ * @param worker The worker.
+ */
+ private removeWorkerTasksUsage (worker: Worker): void {
+ this.workersTasksUsage.delete(worker)
+ }
}