} from '../utility-types'
import { EMPTY_FUNCTION } from '../utils'
import { isKillBehavior, KillBehaviors } from '../worker/worker-options'
-import type { AbstractPoolWorker } from './abstract-pool-worker'
import type { PoolOptions } from './pool'
-import type { IPoolInternal } from './pool-internal'
+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'
+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<Worker, Data, Response> {
public readonly workers: Worker[] = []
/** @inheritDoc */
- public readonly tasks: Map<Worker, number> = new Map<Worker, number>()
+ public readonly workersTasksUsage: Map<Worker, TasksUsage> = new Map<
+ Worker,
+ TasksUsage
+ >()
/** @inheritDoc */
public readonly emitter?: PoolEmitter
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'
)
return this.promiseMap.size
}
+ /** @inheritDoc */
+ public getWorkerIndex (worker: Worker): number {
+ return this.workers.indexOf(worker)
+ }
+
/** @inheritDoc */
public getWorkerRunningTasks (worker: Worker): number | undefined {
- return this.tasks.get(worker)
+ return this.workersTasksUsage.get(worker)?.running
}
/** @inheritDoc */
- public getWorkerIndex (worker: Worker): number {
- return this.workers.indexOf(worker)
+ public getWorkerAverageTasksRunTime (worker: Worker): number | undefined {
+ return this.workersTasksUsage.get(worker)?.avgRunTime
}
/** @inheritDoc */
workerChoiceStrategy: WorkerChoiceStrategy
): void {
this.opts.workerChoiceStrategy = workerChoiceStrategy
+ for (const worker of this.workers) {
+ this.resetWorkerTasksUsage(worker)
+ }
this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
workerChoiceStrategy
)
}
/**
- * 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
this.workers.splice(this.getWorkerIndex(worker), 1)
- this.tasks.delete(worker)
+ 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.initWorkerTasksUsage(worker)
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)
+ }
+ }
+ }
+
+ /**
+ * Initializes tasks usage statistics.
+ *
+ * @param worker The 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)
+ }
}
repositories / poolifier.git / blobdiff