-import type {
- MessageValue,
- PromiseWorkerResponseWrapper
-} from '../utility-types'
-import { EMPTY_FUNCTION } from '../utils'
-import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
-import type { IPoolInternal } from './pool-internal'
-import { PoolEmitter, PoolType } from './pool-internal'
-import type { WorkerChoiceStrategy } from './selection-strategies'
+import crypto from 'node:crypto'
+import type { MessageValue, PromiseResponseWrapper } from '../utility-types'
+import {
+ DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS,
+ EMPTY_FUNCTION,
+ median
+} from '../utils'
+import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
+import {
+ PoolEvents,
+ type IPool,
+ type PoolOptions,
+ type TasksQueueOptions,
+ PoolType
+} from './pool'
+import { PoolEmitter } from './pool'
+import type { IWorker, Task, TasksUsage, WorkerNode } from './worker'
import {
WorkerChoiceStrategies,
- WorkerChoiceStrategyContext
-} from './selection-strategies'
-
-/**
- * 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 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
-}
+ type WorkerChoiceStrategy
+} from './selection-strategies/selection-strategies-types'
+import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
+import { CircularArray } from '../circular-array'
/**
- * Options for a poolifier pool.
- */
-export interface PoolOptions<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 to true.
- */
- enableEvents?: boolean
-}
-
-/**
- * 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 execution response. This can only be serializable data.
*/
export abstract class AbstractPool<
Worker extends IWorker,
Data = unknown,
Response = unknown
-> implements IPoolInternal<Worker, Data, Response> {
- /** @inheritdoc */
- public readonly workers: Worker[] = []
-
- /** @inheritdoc */
- public readonly tasks: Map<Worker, number> = new Map<Worker, number>()
+> implements IPool<Worker, Data, Response> {
+ /** @inheritDoc */
+ public readonly workerNodes: Array<WorkerNode<Worker, Data>> = []
- /** @inheritdoc */
+ /** @inheritDoc */
public readonly emitter?: PoolEmitter
- /** @inheritdoc */
- public readonly max?: number
-
/**
- * The promise map.
+ * The execution response promise 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 execution response 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.
+ * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
*/
- protected promiseMap: Map<
- number,
- PromiseWorkerResponseWrapper<Worker, Response>
- > = new Map<number, PromiseWorkerResponseWrapper<Worker, Response>>()
+ protected promiseResponseMap: Map<
+ string,
+ PromiseResponseWrapper<Worker, Response>
+ > = new Map<string, PromiseResponseWrapper<Worker, Response>>()
/**
- * Id of the next message.
- */
- protected nextMessageId: number = 0
-
- /**
- * 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,
this.checkNumberOfWorkers(this.numberOfWorkers)
this.checkFilePath(this.filePath)
this.checkPoolOptions(this.opts)
+
+ this.chooseWorkerNode.bind(this)
+ this.executeTask.bind(this)
+ this.enqueueTask.bind(this)
+ this.checkAndEmitEvents.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, async message => {
- const tasksInProgress = this.tasks.get(workerCreated)
- if (
- isKillBehavior(KillBehaviors.HARD, message.kill) ||
- tasksInProgress === 0
- ) {
- // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
- await this.destroyWorker(workerCreated)
- }
- })
- return workerCreated
- },
- this.opts.workerChoiceStrategy
+ this.opts.workerChoiceStrategy,
+ this.opts.workerChoiceStrategyOptions
)
}
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')
}
}
'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) {
private checkPoolOptions (opts: PoolOptions<Worker>): void {
this.opts.workerChoiceStrategy =
opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
+ this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy)
+ this.opts.workerChoiceStrategyOptions =
+ opts.workerChoiceStrategyOptions ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
this.opts.enableEvents = opts.enableEvents ?? true
+ this.opts.enableTasksQueue = opts.enableTasksQueue ?? false
+ if (this.opts.enableTasksQueue) {
+ if ((opts.tasksQueueOptions?.concurrency as number) <= 0) {
+ throw new Error(
+ `Invalid worker tasks concurrency '${
+ (opts.tasksQueueOptions as TasksQueueOptions).concurrency as number
+ }'`
+ )
+ }
+ this.opts.tasksQueueOptions = {
+ concurrency: opts.tasksQueueOptions?.concurrency ?? 1
+ }
+ }
}
- /** @inheritdoc */
+ private checkValidWorkerChoiceStrategy (
+ workerChoiceStrategy: WorkerChoiceStrategy
+ ): void {
+ if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) {
+ throw new Error(
+ `Invalid worker choice strategy '${workerChoiceStrategy}'`
+ )
+ }
+ }
+
+ /** @inheritDoc */
public abstract get type (): PoolType
- /** @inheritdoc */
- public get numberOfRunningTasks (): number {
- return this.promiseMap.size
+ /**
+ * Number of tasks running in the pool.
+ */
+ private get numberOfRunningTasks (): number {
+ return this.workerNodes.reduce(
+ (accumulator, workerNode) => accumulator + workerNode.tasksUsage.running,
+ 0
+ )
+ }
+
+ /**
+ * Number of tasks queued in the pool.
+ */
+ private get numberOfQueuedTasks (): number {
+ if (this.opts.enableTasksQueue === false) {
+ return 0
+ }
+ return this.workerNodes.reduce(
+ (accumulator, workerNode) => accumulator + workerNode.tasksQueue.length,
+ 0
+ )
+ }
+
+ /**
+ * Gets the given worker its worker node key.
+ *
+ * @param worker - The worker.
+ * @returns The worker node key if the worker is found in the pool worker nodes, `-1` otherwise.
+ */
+ private getWorkerNodeKey (worker: Worker): number {
+ return this.workerNodes.findIndex(
+ workerNode => workerNode.worker === worker
+ )
}
- /** @inheritdoc */
+ /** @inheritDoc */
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
+ this.checkValidWorkerChoiceStrategy(workerChoiceStrategy)
this.opts.workerChoiceStrategy = workerChoiceStrategy
+ for (const workerNode of this.workerNodes) {
+ this.setWorkerNodeTasksUsage(workerNode, {
+ run: 0,
+ running: 0,
+ runTime: 0,
+ runTimeHistory: new CircularArray(),
+ avgRunTime: 0,
+ medRunTime: 0,
+ error: 0
+ })
+ }
this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
workerChoiceStrategy
)
}
- /** @inheritdoc */
- public abstract get busy (): boolean
+ /**
+ * Whether the pool is full or not.
+ *
+ * The pool filling boolean status.
+ */
+ protected abstract get full (): boolean
- protected internalGetBusyStatus (): boolean {
- return (
- this.numberOfRunningTasks >= this.numberOfWorkers &&
- this.findFreeTasksMapEntry() === false
- )
+ /**
+ * Whether the pool is busy or not.
+ *
+ * The pool busyness boolean status.
+ */
+ protected abstract get busy (): boolean
+
+ protected internalBusy (): boolean {
+ return this.findFreeWorkerNodeKey() === -1
}
- /** @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]
- }
- }
- return false
+ /** @inheritDoc */
+ public findFreeWorkerNodeKey (): number {
+ return this.workerNodes.findIndex(workerNode => {
+ return workerNode.tasksUsage?.running === 0
+ })
}
- /** @inheritdoc */
- public execute (data: Data): Promise<Response> {
- // 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()
- this.sendToWorker(worker, { data: data || ({} as Data), id: messageId })
+ /** @inheritDoc */
+ public async execute (data: Data): Promise<Response> {
+ const [workerNodeKey, workerNode] = this.chooseWorkerNode()
+ const submittedTask: Task<Data> = {
+ // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+ data: data ?? ({} as Data),
+ id: crypto.randomUUID()
+ }
+ const res = new Promise<Response>((resolve, reject) => {
+ this.promiseResponseMap.set(submittedTask.id as string, {
+ resolve,
+ reject,
+ worker: workerNode.worker
+ })
+ })
+ if (
+ this.opts.enableTasksQueue === true &&
+ (this.busy ||
+ this.workerNodes[workerNodeKey].tasksUsage.running >=
+ ((this.opts.tasksQueueOptions as TasksQueueOptions)
+ .concurrency as number))
+ ) {
+ this.enqueueTask(workerNodeKey, submittedTask)
+ } else {
+ this.executeTask(workerNodeKey, submittedTask)
+ }
+ this.checkAndEmitEvents()
+ // 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.workerNodes.map(async (workerNode, workerNodeKey) => {
+ this.flushTasksQueue(workerNodeKey)
+ await this.destroyWorker(workerNode.worker)
+ })
+ )
}
/**
- * Shut down given worker.
+ * Shutdowns the given worker.
*
- * @param worker A worker within `workers`.
+ * @param worker - A worker within `workerNodes`.
*/
protected abstract destroyWorker (worker: Worker): void | Promise<void>
/**
- * Setup hook that can be overridden by a Poolifier pool implementation
- * to run code before workers are created in the abstract constructor.
+ * Setup hook to execute code before worker node are created in the abstract constructor.
+ * Can be overridden
+ *
+ * @virtual
*/
protected setupHook (): void {
- // Can be overridden
+ // Intentionally empty
}
/**
protected abstract isMain (): boolean
/**
- * Increase the number of tasks that the given workers has applied.
- *
- * @param worker Worker whose tasks are increased.
- */
- protected increaseWorkersTask (worker: Worker): void {
- this.stepWorkerNumberOfTasks(worker, 1)
- }
-
- /**
- * Decrease the number of tasks that the given workers has applied.
+ * Hook executed before the worker task execution.
+ * Can be overridden.
*
- * @param worker Worker whose tasks are decreased.
+ * @param workerNodeKey - The worker node key.
*/
- protected decreaseWorkersTasks (worker: Worker): void {
- this.stepWorkerNumberOfTasks(worker, -1)
+ protected beforeTaskExecutionHook (workerNodeKey: number): void {
+ ++this.workerNodes[workerNodeKey].tasksUsage.running
}
/**
- * Step the number of tasks that the given workers has applied.
+ * Hook executed after the worker task execution.
+ * Can be overridden.
*
- * @param worker Worker whose tasks are set.
- * @param step Worker number of tasks step.
+ * @param worker - The worker.
+ * @param message - The received message.
*/
- 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 afterTaskExecutionHook (
+ worker: Worker,
+ message: MessageValue<Response>
+ ): void {
+ 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
+ }
+ if (this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime) {
+ workerTasksUsage.runTimeHistory.push(message.runTime ?? 0)
+ workerTasksUsage.medRunTime = median(workerTasksUsage.runTimeHistory)
+ }
}
}
/**
- * Removes the given worker from the pool.
- *
- * @param worker Worker that will be removed.
- */
- 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)
- }
-
- /**
- * Choose a worker for the next task.
+ * Chooses a worker node 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 node key, worker node].
*/
- protected chooseWorker (): Worker {
- return this.workerChoiceStrategyContext.execute()
+ protected chooseWorkerNode (): [number, WorkerNode<Worker, Data>] {
+ let workerNodeKey: number
+ if (this.type === PoolType.DYNAMIC && !this.full && this.internalBusy()) {
+ const workerCreated = this.createAndSetupWorker()
+ this.registerWorkerMessageListener(workerCreated, message => {
+ if (
+ isKillBehavior(KillBehaviors.HARD, message.kill) ||
+ (message.kill != null &&
+ this.getWorkerTasksUsage(workerCreated)?.running === 0)
+ ) {
+ // Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime)
+ this.flushTasksQueueByWorker(workerCreated)
+ void this.destroyWorker(workerCreated)
+ }
+ })
+ workerNodeKey = this.getWorkerNodeKey(workerCreated)
+ } else {
+ workerNodeKey = this.workerChoiceStrategyContext.execute()
+ }
+ return [workerNodeKey, this.workerNodes[workerNodeKey]]
}
/**
- * 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,
): void
/**
- * Register a listener callback on a given worker.
+ * Registers a listener callback on the 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<Message>) => void): void
-
- protected internalExecute (
- worker: Worker,
- messageId: number
- ): Promise<Response> {
- this.increaseWorkersTask(worker)
- return new Promise<Response>((resolve, reject) => {
- this.promiseMap.set(messageId, { resolve, reject, worker })
- })
- }
+ >(worker: Worker, listener: (message: MessageValue<Message>) => void): void
/**
* 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.
+ * Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
*
- * 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.
*/
protected abstract afterWorkerSetup (worker: Worker): void
/**
- * Creates a new worker for this pool and sets it up completely.
+ * Creates a new worker and sets it up completely in the pool worker nodes.
*
* @returns New, completely set up worker.
*/
protected createAndSetupWorker (): Worker {
- const worker: Worker = this.createWorker()
+ const worker = this.createWorker()
+ 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))
-
- this.workers.push(worker)
+ worker.once('exit', () => {
+ this.removeWorkerNode(worker)
+ })
- // Init tasks map
- this.tasks.set(worker, 0)
+ this.pushWorkerNode(worker)
this.afterWorkerSetup(worker)
}
/**
- * This function is the listener registered for each worker.
+ * This function is the listener registered for each worker message.
*
- * @returns The listener function to execute when a message is sent from a worker.
+ * @returns The listener function to execute when a message is received from a worker.
*/
protected workerListener (): (message: MessageValue<Response>) => void {
return message => {
- if (message.id) {
- const value = this.promiseMap.get(message.id)
- if (value) {
- this.decreaseWorkersTasks(value.worker)
- if (message.error) value.reject(message.error)
- else value.resolve(message.data as Response)
- this.promiseMap.delete(message.id)
+ if (message.id != null) {
+ // Task execution response received
+ 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.afterTaskExecutionHook(promiseResponse.worker, message)
+ this.promiseResponseMap.delete(message.id)
+ const workerNodeKey = this.getWorkerNodeKey(promiseResponse.worker)
+ if (
+ this.opts.enableTasksQueue === true &&
+ this.tasksQueueSize(workerNodeKey) > 0
+ ) {
+ this.executeTask(
+ workerNodeKey,
+ this.dequeueTask(workerNodeKey) as Task<Data>
+ )
+ }
}
}
}
}
- private checkAndEmitBusy (): void {
- if (this.opts.enableEvents && this.busy) {
- this.emitter?.emit('busy')
+ private checkAndEmitEvents (): void {
+ if (this.opts.enableEvents === true) {
+ if (this.busy) {
+ this.emitter?.emit(PoolEvents.busy)
+ }
+ if (this.type === PoolType.DYNAMIC && this.full) {
+ this.emitter?.emit(PoolEvents.full)
+ }
+ }
+ }
+
+ /**
+ * Sets the given worker node its tasks usage in the pool.
+ *
+ * @param workerNode - The worker node.
+ * @param tasksUsage - The worker node tasks usage.
+ */
+ private setWorkerNodeTasksUsage (
+ workerNode: WorkerNode<Worker, Data>,
+ tasksUsage: TasksUsage
+ ): void {
+ workerNode.tasksUsage = tasksUsage
+ }
+
+ /**
+ * Gets the given worker its tasks usage in the pool.
+ *
+ * @param worker - The worker.
+ * @throws {@link Error} if the worker is not found in the pool worker nodes.
+ * @returns The worker tasks usage.
+ */
+ private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
+ const workerNodeKey = this.getWorkerNodeKey(worker)
+ if (workerNodeKey !== -1) {
+ return this.workerNodes[workerNodeKey].tasksUsage
}
+ throw new Error('Worker could not be found in the pool worker nodes')
+ }
+
+ /**
+ * Pushes the given worker in the pool worker nodes.
+ *
+ * @param worker - The worker.
+ * @returns The worker nodes length.
+ */
+ private pushWorkerNode (worker: Worker): number {
+ return this.workerNodes.push({
+ worker,
+ tasksUsage: {
+ run: 0,
+ running: 0,
+ runTime: 0,
+ runTimeHistory: new CircularArray(),
+ avgRunTime: 0,
+ medRunTime: 0,
+ error: 0
+ },
+ tasksQueue: []
+ })
+ }
+
+ /**
+ * Sets the given worker in the pool worker nodes.
+ *
+ * @param workerNodeKey - The worker node key.
+ * @param worker - The worker.
+ * @param tasksUsage - The worker tasks usage.
+ * @param tasksQueue - The worker task queue.
+ */
+ private setWorkerNode (
+ workerNodeKey: number,
+ worker: Worker,
+ tasksUsage: TasksUsage,
+ tasksQueue: Array<Task<Data>>
+ ): void {
+ this.workerNodes[workerNodeKey] = {
+ worker,
+ tasksUsage,
+ tasksQueue
+ }
+ }
+
+ /**
+ * Removes the given worker from the pool worker nodes.
+ *
+ * @param worker - The worker.
+ */
+ private removeWorkerNode (worker: Worker): void {
+ const workerNodeKey = this.getWorkerNodeKey(worker)
+ this.workerNodes.splice(workerNodeKey, 1)
+ this.workerChoiceStrategyContext.remove(workerNodeKey)
+ }
+
+ private executeTask (workerNodeKey: number, task: Task<Data>): void {
+ this.beforeTaskExecutionHook(workerNodeKey)
+ this.sendToWorker(this.workerNodes[workerNodeKey].worker, task)
+ }
+
+ private enqueueTask (workerNodeKey: number, task: Task<Data>): number {
+ return this.workerNodes[workerNodeKey].tasksQueue.push(task)
+ }
+
+ private dequeueTask (workerNodeKey: number): Task<Data> | undefined {
+ return this.workerNodes[workerNodeKey].tasksQueue.shift()
+ }
+
+ private tasksQueueSize (workerNodeKey: number): number {
+ return this.workerNodes[workerNodeKey].tasksQueue.length
+ }
+
+ private flushTasksQueue (workerNodeKey: number): void {
+ if (this.tasksQueueSize(workerNodeKey) > 0) {
+ for (const task of this.workerNodes[workerNodeKey].tasksQueue) {
+ this.executeTask(workerNodeKey, task)
+ }
+ }
+ }
+
+ private flushTasksQueueByWorker (worker: Worker): void {
+ const workerNodeKey = this.getWorkerNodeKey(worker)
+ this.flushTasksQueue(workerNodeKey)
}
}
repositories / poolifier.git / blobdiff