-import { cpus } from 'os'
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import { cpus } from 'node:os'
+import type { IWorker } from '../worker'
+import type { IPool } from '../pool'
+import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
-import type { RequiredStatistics } from './selection-strategies-types'
-
-/**
- * Virtual task runtime.
- */
-interface TaskRunTime {
- weight: number
- runTime: number
-}
+import type {
+ IWorkerChoiceStrategy,
+ RequiredStatistics,
+ 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 serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable 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
+ runTime: true,
+ avgRunTime: true,
+ medRunTime: false
}
/**
- * Worker index where the current task will be submitted.
+ * Worker node id where the current task will be submitted.
*/
- private currentWorkerIndex: number = 0
+ private currentWorkerNodeId: number = 0
/**
* Default worker weight.
*/
private readonly defaultWorkerWeight: number
/**
- * Per worker virtual task runtime map.
+ * Worker virtual task runtime.
*/
- private readonly workersTaskRunTime: 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.initWorkersTaskRunTime()
+ /** @inheritDoc */
+ public constructor (
+ pool: IPool<Worker, Data, Response>,
+ opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ ) {
+ super(pool, opts)
+ this.checkOptions(this.opts)
+ this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
}
/** @inheritDoc */
public reset (): boolean {
- this.currentWorkerIndex = 0
- this.workersTaskRunTime.clear()
- this.initWorkersTaskRunTime()
+ this.currentWorkerNodeId = 0
+ this.workerVirtualTaskRunTime = 0
return true
}
/** @inheritDoc */
- public choose (): Worker {
- const chosenWorker = this.pool.workers[this.currentWorkerIndex]
- if (this.isDynamicPool && !this.workersTaskRunTime.has(chosenWorker)) {
- this.initWorkerTaskRunTime(chosenWorker)
- }
- const workerTaskRunTime =
- this.workersTaskRunTime.get(chosenWorker)?.runTime ?? 0
+ public choose (): number {
+ const chosenWorkerNodeKey = this.currentWorkerNodeId
+ const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime ?? 0
const workerTaskWeight =
- this.workersTaskRunTime.get(chosenWorker)?.weight ??
- this.defaultWorkerWeight
- if (workerTaskRunTime < workerTaskWeight) {
- this.setWorkerTaskRunTime(
- chosenWorker,
- workerTaskWeight,
- workerTaskRunTime +
- (this.getWorkerVirtualTaskRunTime(chosenWorker) ?? 0)
- )
+ this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
+ if (workerVirtualTaskRunTime < workerTaskWeight) {
+ this.workerVirtualTaskRunTime =
+ workerVirtualTaskRunTime +
+ (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
} else {
- this.currentWorkerIndex =
- this.currentWorkerIndex === this.pool.workers.length - 1
+ this.currentWorkerNodeId =
+ this.currentWorkerNodeId === this.pool.workerNodes.length - 1
? 0
- : this.currentWorkerIndex + 1
- this.setWorkerTaskRunTime(
- this.pool.workers[this.currentWorkerIndex],
- workerTaskWeight,
- 0
- )
+ : this.currentWorkerNodeId + 1
+ this.workerVirtualTaskRunTime = 0
}
- return chosenWorker
+ return chosenWorkerNodeKey
}
- private initWorkersTaskRunTime (): void {
- for (const worker of this.pool.workers) {
- this.initWorkerTaskRunTime(worker)
+ /** @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
+ }
+ this.workerVirtualTaskRunTime = 0
}
+ return true
}
- private initWorkerTaskRunTime (worker: Worker): void {
- this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0)
- }
-
- private setWorkerTaskRunTime (
- worker: Worker,
- weight: number,
- runTime: number
- ): void {
- this.workersTaskRunTime.set(worker, {
- weight,
- runTime
- })
- }
-
- private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined {
- return this.pool.getWorkerAverageTasksRunTime(worker)
+ private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
+ return this.requiredStatistics.medRunTime
+ ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+ : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
}
- private computeWorkerWeight (): number {
+ private computeDefaultWorkerWeight (): number {
let cpusCycleTimeWeight = 0
for (const cpu of cpus()) {
// CPU estimated cycle time
repositories / poolifier.git / blobdiff