} 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, TasksUsage } from './pool-internal'
import { PoolEmitter, PoolType } from './pool-internal'
+import type { IPoolWorker } from './pool-worker'
import {
WorkerChoiceStrategies,
WorkerChoiceStrategy
'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> {
/** @inheritDoc */
public readonly workers: Worker[] = []
- /**
- * The workers tasks usage map.
- *
- * `key`: The `Worker`
- * `value`: Worker tasks usage statistics.
- */
- protected workersTasksUsage: Map<Worker, TasksUsage> = new Map<
+ /** @inheritDoc */
+ public readonly workersTasksUsage: Map<Worker, TasksUsage> = new Map<
Worker,
TasksUsage
>()
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'
)
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`.
*/
/**
* Removes the given worker from the pool.
*
- * @param worker Worker that will be removed.
+ * @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.resetWorkerTasksUsage(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.
+ * @param worker The worker which should register a listener.
+ * @param listener The message listener callback.
*/
protected abstract registerWorkerMessageListener<
Message extends Data | Response
this.workers.push(worker)
// Init worker tasks usage map
- this.workersTasksUsage.set(worker, {
- run: 0,
- running: 0,
- runTime: 0,
- avgRunTime: 0
- })
+ this.initWorkerTasksUsage(worker)
this.afterWorkerSetup(worker)
}
/**
- * Increase the number of tasks that the given worker has applied.
+ * Increases the number of tasks that the given worker has applied.
*
* @param worker Worker which running tasks is increased.
*/
}
/**
- * Decrease the number of tasks that the given worker has applied.
+ * Decreases the number of tasks that the given worker has applied.
*
* @param worker Worker which running tasks is decreased.
*/
}
/**
- * Step the number of tasks that the given worker has applied.
+ * 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.
}
/**
- * Step the number of tasks that the given worker has run.
+ * 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) {
+ private stepWorkerRunTasks (worker: Worker, step: number): void {
const tasksUsage = this.workersTasksUsage.get(worker)
if (tasksUsage !== undefined) {
tasksUsage.run = tasksUsage.run + step
}
/**
- * Update tasks run time for the given worker.
+ * Updates tasks runtime for the given worker.
*
* @param worker Worker which run the task.
- * @param taskRunTime Worker task run time.
+ * @param taskRunTime Worker task runtime.
*/
private updateWorkerTasksRunTime (
worker: Worker,
taskRunTime: number | undefined
- ) {
- const tasksUsage = this.workersTasksUsage.get(worker)
- if (tasksUsage !== undefined && tasksUsage.run !== 0) {
- tasksUsage.runTime += taskRunTime ?? 0
- tasksUsage.avgRunTime = tasksUsage.runTime / tasksUsage.run
- this.workersTasksUsage.set(worker, tasksUsage)
- } else {
- throw new Error(WORKER_NOT_FOUND_TASKS_USAGE_MAP)
+ ): 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)
+ }
}
}
/**
- * Reset worker tasks usage statistics.
+ * Initializes tasks usage statistics.
*
* @param worker The worker.
*/
- private resetWorkerTasksUsage (worker: Worker): void {
+ 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