X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=40e06b158fe3af59ec49527a6cc170822520657f;hb=1a76932b50afaed3047a58cb0365ad4c446460d6;hp=0921f45644446c18512f876a0a13b3379f8026fb;hpb=bf9549aef8a23a3931e19040dadb7f1e8e6422b5;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 0921f456..40e06b15 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -4,10 +4,10 @@ import type { } 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 @@ -18,27 +18,22 @@ 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 { /** @inheritDoc */ public readonly workers: Worker[] = [] - /** - * The workers tasks usage map. - * - * `key`: The `Worker` - * `value`: Worker tasks usage statistics. - */ - protected workersTasksUsage: Map = new Map< + /** @inheritDoc */ + public readonly workersTasksUsage: Map = new Map< Worker, TasksUsage >() @@ -135,7 +130,7 @@ export abstract class AbstractPool< 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' ) @@ -182,6 +177,9 @@ export abstract class AbstractPool< workerChoiceStrategy: WorkerChoiceStrategy ): void { this.opts.workerChoiceStrategy = workerChoiceStrategy + for (const worker of this.workers) { + this.resetWorkerTasksUsage(worker) + } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( workerChoiceStrategy ) @@ -226,7 +224,7 @@ export abstract class AbstractPool< } /** - * Shut down given worker. + * Shutdowns given worker. * * @param worker A worker within `workers`. */ @@ -274,16 +272,16 @@ export abstract class AbstractPool< /** * 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. * @@ -294,7 +292,7 @@ export abstract class AbstractPool< } /** - * 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. @@ -305,10 +303,10 @@ export abstract class AbstractPool< ): 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 @@ -355,12 +353,7 @@ export abstract class AbstractPool< 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) @@ -393,7 +386,7 @@ export abstract class AbstractPool< } /** - * 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. */ @@ -402,7 +395,7 @@ export abstract class AbstractPool< } /** - * 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. */ @@ -411,7 +404,7 @@ export abstract class AbstractPool< } /** - * 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. @@ -427,12 +420,12 @@ export abstract class AbstractPool< } /** - * 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 @@ -443,31 +436,62 @@ export abstract class AbstractPool< } /** - * 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) + } }