-import { cpus } from 'os'
-import type { AbstractPoolWorker } from '../abstract-pool-worker'
-import type { IPoolInternal } from '../pool-internal'
+import type { IWorker } from '../worker'
+import type { IPool } from '../pool'
+import {
+ DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
-import type { RequiredStatistics } from './selection-strategies-types'
-
-/**
- * Task run time.
- */
-type TaskRunTime = {
- weight: number
- runTime: number
-}
+import type {
+ IWorkerChoiceStrategy,
+ TaskStatisticsRequirements,
+ WorkerChoiceStrategyOptions
+} from './selection-strategies-types'
/**
* Selects the next worker with a weighted round robin scheduling algorithm.
* Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin.
*
- * @template Worker Type of worker which manages the strategy.
- * @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 the strategy.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
*/
export class WeightedRoundRobinWorkerChoiceStrategy<
- Worker extends AbstractPoolWorker,
- Data,
- Response
-> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
+ Worker extends IWorker,
+ Data = unknown,
+ Response = unknown
+ >
+ extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
+ implements IWorkerChoiceStrategy {
/** @inheritDoc */
- public requiredStatistics: RequiredStatistics = {
- runTime: true
+ public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+ runTime: {
+ aggregate: true,
+ average: true,
+ median: false
+ },
+ waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
}
- /**
- * Worker index where the previous task was submitted.
- */
- private previousWorkerIndex: number = 0
- /**
- * Worker index where the current task will be submitted.
- */
- private currentWorkerIndex: number = 0
/**
* Default worker weight.
*/
- private defaultWorkerWeight: number
+ private readonly defaultWorkerWeight: number
/**
- * Per worker task runtime map.
+ * Worker virtual task runtime.
*/
- private workerTaskRunTime: Map<Worker, TaskRunTime> = new Map<
- Worker,
- TaskRunTime
- >()
+ private workerVirtualTaskRunTime: number = 0
- /**
- * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm.
- *
- * @param pool The pool instance.
- */
- public constructor (pool: IPoolInternal<Worker, Data, Response>) {
- super(pool)
- this.defaultWorkerWeight = this.computeWorkerWeight()
- this.initWorkerTaskRunTime()
+ /** @inheritDoc */
+ public constructor (
+ pool: IPool<Worker, Data, Response>,
+ opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ ) {
+ super(pool, opts)
+ this.setTaskStatisticsRequirements(this.opts)
+ this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
}
/** @inheritDoc */
- public choose (): Worker {
- const currentWorker = this.pool.workers[this.currentWorkerIndex]
- if (this.isDynamicPool === true) {
- this.workerTaskRunTime.has(currentWorker) === false &&
- this.workerTaskRunTime.set(currentWorker, {
- weight: this.defaultWorkerWeight,
- runTime: 0
- })
- }
- const workerVirtualTaskRunTime =
- this.getWorkerVirtualTaskRunTime(currentWorker) ?? 0
- const workerTaskWeight =
- this.workerTaskRunTime.get(currentWorker)?.weight ??
- this.defaultWorkerWeight
- if (this.currentWorkerIndex === this.previousWorkerIndex) {
- const workerTaskRunTime =
- (this.workerTaskRunTime.get(currentWorker)?.runTime ?? 0) +
- workerVirtualTaskRunTime
- this.workerTaskRunTime.set(currentWorker, {
- weight: workerTaskWeight,
- runTime: workerTaskRunTime
- })
- } else {
- this.workerTaskRunTime.set(currentWorker, {
- weight: workerTaskWeight,
- runTime: 0
- })
- }
- if (
- workerVirtualTaskRunTime <
- (this.workerTaskRunTime.get(currentWorker) ?? this.defaultWorkerWeight)
- ) {
- this.previousWorkerIndex = this.currentWorkerIndex
- } else {
- this.previousWorkerIndex = this.currentWorkerIndex
- this.currentWorkerIndex =
- this.pool.workers.length - 1 === this.currentWorkerIndex
- ? 0
- : this.currentWorkerIndex + 1
- }
- return this.pool.workers[this.currentWorkerIndex]
+ public reset (): boolean {
+ this.nextWorkerNodeKey = 0
+ this.workerVirtualTaskRunTime = 0
+ return true
+ }
+
+ /** @inheritDoc */
+ public update (): boolean {
+ return true
}
- private computeWorkerWeight () {
- let cpusCycleTimeWeight = 0
- for (const cpu of cpus()) {
- // CPU estimated cycle time
- const numberOfDigit = cpu.speed.toString().length - 1
- const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigit))
- cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigit)
+ /** @inheritDoc */
+ public choose (): number | undefined {
+ const chosenWorkerNodeKey = this.nextWorkerNodeKey
+ this.weightedRoundRobinNextWorkerNodeKey()
+ if (!this.isWorkerNodeEligible(this.nextWorkerNodeKey as number)) {
+ this.nextWorkerNodeKey = undefined
+ this.previousWorkerNodeKey =
+ chosenWorkerNodeKey ?? this.previousWorkerNodeKey
}
- return cpusCycleTimeWeight / cpus().length
+ return chosenWorkerNodeKey
}
- private initWorkerTaskRunTime () {
- for (const worker of this.pool.workers) {
- this.workerTaskRunTime.set(worker, {
- weight: this.defaultWorkerWeight,
- runTime: 0
- })
+ /** @inheritDoc */
+ public remove (workerNodeKey: number): boolean {
+ if (this.nextWorkerNodeKey === workerNodeKey) {
+ if (this.pool.workerNodes.length === 0) {
+ this.nextWorkerNodeKey = 0
+ } else if (this.nextWorkerNodeKey > this.pool.workerNodes.length - 1) {
+ this.nextWorkerNodeKey = this.pool.workerNodes.length - 1
+ }
+ this.workerVirtualTaskRunTime = 0
}
+ return true
}
- private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined {
- return this.pool.getWorkerAverageTasksRunTime(worker)
+ private weightedRoundRobinNextWorkerNodeKey (): number | undefined {
+ const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime
+ const workerWeight =
+ this.opts.weights?.[
+ this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+ ] ?? this.defaultWorkerWeight
+ if (workerVirtualTaskRunTime < workerWeight) {
+ this.workerVirtualTaskRunTime =
+ workerVirtualTaskRunTime +
+ this.getWorkerTaskRunTime(
+ this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+ )
+ } else {
+ this.nextWorkerNodeKey =
+ this.nextWorkerNodeKey === this.pool.workerNodes.length - 1
+ ? 0
+ : (this.nextWorkerNodeKey ?? this.previousWorkerNodeKey) + 1
+ this.workerVirtualTaskRunTime = 0
+ }
+ return this.nextWorkerNodeKey
}
}
repositories / poolifier.git / blobdiff