-import { cpus } from 'node:os'
import type { IWorker } from '../worker'
import type { IPool } from '../pool'
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import {
+ DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
import type {
IWorkerChoiceStrategy,
- RequiredStatistics,
+ TaskStatisticsRequirements,
WorkerChoiceStrategyOptions
} from './selection-strategies-types'
* Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin.
*
* @typeParam Worker - Type of worker which manages the strategy.
- * @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.
+ * @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 IWorker,
extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
implements IWorkerChoiceStrategy {
/** @inheritDoc */
- public readonly requiredStatistics: RequiredStatistics = {
- runTime: true,
- avgRunTime: true,
- medRunTime: false
+ public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+ runTime: {
+ aggregate: true,
+ average: true,
+ median: false
+ },
+ waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
}
- /**
- * Worker node id where the current task will be submitted.
- */
- private currentWorkerNodeId: number = 0
/**
* Default worker weight.
*/
opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
) {
super(pool, opts)
- this.checkOptions(this.opts)
+ this.setTaskStatisticsRequirements(this.opts)
this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
}
/** @inheritDoc */
public reset (): boolean {
- this.currentWorkerNodeId = 0
+ this.resetWorkerNodeKeyProperties()
this.workerVirtualTaskRunTime = 0
return true
}
}
/** @inheritDoc */
- public choose (): number {
- const chosenWorkerNodeKey = this.currentWorkerNodeId
- const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime
- const workerWeight =
- this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
- if (workerVirtualTaskRunTime < workerWeight) {
- this.workerVirtualTaskRunTime =
- workerVirtualTaskRunTime +
- this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey)
- } else {
- this.currentWorkerNodeId =
- this.currentWorkerNodeId === this.pool.workerNodes.length - 1
- ? 0
- : this.currentWorkerNodeId + 1
- this.workerVirtualTaskRunTime = 0
- }
- return chosenWorkerNodeKey
+ public choose (): number | undefined {
+ this.setPreviousWorkerNodeKey(this.nextWorkerNodeKey)
+ return this.weightedRoundRobinNextWorkerNodeKey()
}
/** @inheritDoc */
public remove (workerNodeKey: number): boolean {
- if (this.currentWorkerNodeId === workerNodeKey) {
- if (this.pool.workerNodes.length === 0) {
- this.currentWorkerNodeId = 0
- } else {
- this.currentWorkerNodeId =
- this.currentWorkerNodeId > this.pool.workerNodes.length - 1
- ? this.pool.workerNodes.length - 1
- : this.currentWorkerNodeId
- }
+ if (this.pool.workerNodes.length === 0) {
+ this.reset()
+ }
+ if (this.nextWorkerNodeKey === workerNodeKey) {
this.workerVirtualTaskRunTime = 0
+ if (this.nextWorkerNodeKey > this.pool.workerNodes.length - 1) {
+ this.nextWorkerNodeKey = this.pool.workerNodes.length - 1
+ }
+ }
+ if (
+ this.previousWorkerNodeKey === workerNodeKey &&
+ this.previousWorkerNodeKey > this.pool.workerNodes.length - 1
+ ) {
+ this.previousWorkerNodeKey = this.pool.workerNodes.length - 1
}
return true
}
- private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
- return this.requiredStatistics.medRunTime
- ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
- : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
- }
-
- private computeDefaultWorkerWeight (): number {
- let cpusCycleTimeWeight = 0
- for (const cpu of cpus()) {
- // CPU estimated cycle time
- const numberOfDigits = cpu.speed.toString().length - 1
- const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits))
- cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits)
+ private weightedRoundRobinNextWorkerNodeKey (): number | undefined {
+ const workerWeight =
+ this.opts.weights?.[
+ this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+ ] ?? this.defaultWorkerWeight
+ if (this.workerVirtualTaskRunTime < workerWeight) {
+ this.workerVirtualTaskRunTime =
+ this.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 Math.round(cpusCycleTimeWeight / cpus().length)
+ return this.nextWorkerNodeKey
}
}