-import { cpus } from 'os'
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
-import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
-import type { RequiredStatistics } from './selection-strategies-types'
-
-/**
- * Virtual task runtime.
- */
-type TaskRunTime = {
- weight: number
- runTime: number
-}
+import type { IPool } from '../pool.js'
+import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.js'
+import type { IWorker } from '../worker.js'
+import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.js'
+import type {
+ IWorkerChoiceStrategy,
+ TaskStatisticsRequirements,
+ WorkerChoiceStrategyOptions
+} from './selection-strategies-types.js'
/**
* 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 IPoolWorker,
- Data,
- Response
-> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
+ Worker extends IWorker,
+ Data = unknown,
+ Response = unknown
+ >
+ extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
+ implements IWorkerChoiceStrategy {
/** @inheritDoc */
- public readonly requiredStatistics: RequiredStatistics = {
- runTime: true
+ public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+ runTime: {
+ aggregate: true,
+ average: true,
+ median: false
+ },
+ waitTime: {
+ aggregate: true,
+ average: true,
+ median: false
+ },
+ 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
- /**
- * Per worker virtual task runtime map.
+ * Worker node virtual execution time.
*/
- private readonly workersTaskRunTime: Map<Worker, TaskRunTime> = new Map<
- Worker,
- TaskRunTime
- >()
+ private workerNodeVirtualTaskExecutionTime = 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.initWorkersTaskRunTime()
+ /** @inheritDoc */
+ public constructor (
+ pool: IPool<Worker, Data, Response>,
+ opts?: WorkerChoiceStrategyOptions
+ ) {
+ super(pool, opts)
+ this.setTaskStatisticsRequirements(this.opts)
}
/** @inheritDoc */
- public resetStatistics (): boolean {
- this.workersTaskRunTime.clear()
- this.initWorkersTaskRunTime()
+ public reset (): boolean {
+ this.resetWorkerNodeKeyProperties()
+ this.workerNodeVirtualTaskExecutionTime = 0
return true
}
/** @inheritDoc */
- public choose (): Worker {
- const currentWorker = this.pool.workers[this.currentWorkerIndex]
- if (
- this.isDynamicPool === true &&
- this.workersTaskRunTime.has(currentWorker) === false
- ) {
- this.initWorkerTaskRunTime(currentWorker)
- }
- const workerVirtualTaskRunTime =
- this.getWorkerVirtualTaskRunTime(currentWorker) ?? 0
- const workerTaskWeight =
- this.workersTaskRunTime.get(currentWorker)?.weight ??
- this.defaultWorkerWeight
- if (this.currentWorkerIndex === this.previousWorkerIndex) {
- const workerTaskRunTime =
- (this.workersTaskRunTime.get(currentWorker)?.runTime ?? 0) +
- workerVirtualTaskRunTime
- this.setWorkerTaskRunTime(
- currentWorker,
- workerTaskWeight,
- workerTaskRunTime
- )
- } else {
- this.setWorkerTaskRunTime(currentWorker, workerTaskWeight, 0)
- }
- if (workerVirtualTaskRunTime < workerTaskWeight) {
- 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]
- }
-
- private initWorkersTaskRunTime (): void {
- for (const worker of this.pool.workers) {
- this.initWorkerTaskRunTime(worker)
- }
- }
-
- private initWorkerTaskRunTime (worker: Worker): void {
- this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0)
+ public update (): boolean {
+ return true
}
- private setWorkerTaskRunTime (
- worker: Worker,
- weight: number,
- runTime: number
- ): void {
- this.workersTaskRunTime.set(worker, {
- weight,
- runTime
- })
+ /** @inheritDoc */
+ public choose (): number | undefined {
+ this.setPreviousWorkerNodeKey(this.nextWorkerNodeKey)
+ this.weightedRoundRobinNextWorkerNodeKey()
+ this.checkNextWorkerNodeKey()
+ return this.nextWorkerNodeKey
}
- private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined {
- return this.pool.getWorkerAverageTasksRunTime(worker)
+ /** @inheritDoc */
+ public remove (workerNodeKey: number): boolean {
+ if (this.pool.workerNodes.length === 0) {
+ this.reset()
+ return true
+ }
+ if (this.nextWorkerNodeKey === workerNodeKey) {
+ this.workerNodeVirtualTaskExecutionTime = 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 computeWorkerWeight (): number {
- 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)
+ private weightedRoundRobinNextWorkerNodeKey (): number | undefined {
+ const workerWeight =
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.opts!.weights![this.nextWorkerNodeKey ?? this.previousWorkerNodeKey]
+ if (this.workerNodeVirtualTaskExecutionTime < workerWeight) {
+ this.workerNodeVirtualTaskExecutionTime +=
+ this.getWorkerNodeTaskWaitTime(
+ this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+ ) +
+ this.getWorkerNodeTaskRunTime(
+ this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+ )
+ } else {
+ this.nextWorkerNodeKey =
+ this.nextWorkerNodeKey === this.pool.workerNodes.length - 1
+ ? 0
+ : (this.nextWorkerNodeKey ?? this.previousWorkerNodeKey) + 1
+ this.workerNodeVirtualTaskExecutionTime = 0
}
- return Math.round(cpusCycleTimeWeight / cpus().length)
+ return this.nextWorkerNodeKey
}
}