build: switch default to ESM
[poolifier.git] / src / pools / selection-strategies / interleaved-weighted-round-robin-worker-choice-strategy.ts
CommitLineData
d35e5717
JB
1import type { IWorker } from '../worker.js'
2import type { IPool } from '../pool.js'
3import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../../utils.js'
4import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.js'
feec6e8c
JB
5import type {
6 IWorkerChoiceStrategy,
26ce26ca
JB
7 InternalWorkerChoiceStrategyOptions,
8 TaskStatisticsRequirements
d35e5717 9} from './selection-strategies-types.js'
feec6e8c
JB
10
11/**
12 * Selects the next worker with an interleaved weighted round robin scheduling algorithm.
13 *
14 * @typeParam Worker - Type of worker which manages the strategy.
e102732c
JB
15 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
16 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
feec6e8c
JB
17 */
18export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
19 Worker extends IWorker,
20 Data = unknown,
21 Response = unknown
22 >
23 extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
24 implements IWorkerChoiceStrategy {
619f403b
JB
25 /** @inheritDoc */
26 public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
27 runTime: {
28 aggregate: true,
29 average: true,
30 median: false
31 },
32 waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
33 elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
34 }
35
feec6e8c 36 /**
d33be430 37 * Round id.
feec6e8c 38 */
d33be430 39 private roundId: number = 0
feec6e8c
JB
40 /**
41 * Round weights.
42 */
b2365b8a 43 private roundWeights: number[]
feec6e8c 44 /**
619f403b 45 * Worker node id.
feec6e8c 46 */
619f403b
JB
47 private workerNodeId: number = 0
48 /**
f3a91bac 49 * Worker node virtual task runtime.
619f403b 50 */
f3a91bac 51 private workerNodeVirtualTaskRunTime: number = 0
feec6e8c
JB
52
53 /** @inheritDoc */
54 public constructor (
55 pool: IPool<Worker, Data, Response>,
26ce26ca 56 opts: InternalWorkerChoiceStrategyOptions
feec6e8c
JB
57 ) {
58 super(pool, opts)
3d6f0f73
JB
59 this.setTaskStatisticsRequirements(this.opts)
60 this.roundWeights = this.getRoundWeights()
feec6e8c
JB
61 }
62
63 /** @inheritDoc */
64 public reset (): boolean {
39a43af7 65 this.resetWorkerNodeKeyProperties()
d33be430 66 this.roundId = 0
619f403b 67 this.workerNodeId = 0
f3a91bac 68 this.workerNodeVirtualTaskRunTime = 0
feec6e8c
JB
69 return true
70 }
71
72 /** @inheritDoc */
73 public update (): boolean {
74 return true
75 }
76
77 /** @inheritDoc */
b1aae695 78 public choose (): number | undefined {
297f3bbe 79 for (
d33be430 80 let roundIndex = this.roundId;
d3127e84
JB
81 roundIndex < this.roundWeights.length;
82 roundIndex++
297f3bbe 83 ) {
619f403b 84 this.roundId = roundIndex
feec6e8c 85 for (
619f403b 86 let workerNodeKey = this.workerNodeId;
297f3bbe
JB
87 workerNodeKey < this.pool.workerNodes.length;
88 workerNodeKey++
feec6e8c 89 ) {
619f403b 90 this.workerNodeId = workerNodeKey
619f403b
JB
91 if (
92 this.workerNodeId !== this.nextWorkerNodeKey &&
f3a91bac 93 this.workerNodeVirtualTaskRunTime !== 0
619f403b 94 ) {
f3a91bac 95 this.workerNodeVirtualTaskRunTime = 0
619f403b 96 }
00e1bdeb 97 const workerWeight = this.opts.weights?.[workerNodeKey] as number
619f403b 98 if (
97256a85 99 this.isWorkerNodeReady(workerNodeKey) &&
619f403b 100 workerWeight >= this.roundWeights[roundIndex] &&
f3a91bac 101 this.workerNodeVirtualTaskRunTime < workerWeight
619f403b 102 ) {
f3a91bac
JB
103 this.workerNodeVirtualTaskRunTime =
104 this.workerNodeVirtualTaskRunTime +
105 this.getWorkerNodeTaskRunTime(workerNodeKey)
baca80f7 106 this.setPreviousWorkerNodeKey(this.nextWorkerNodeKey)
619f403b
JB
107 this.nextWorkerNodeKey = workerNodeKey
108 return this.nextWorkerNodeKey
feec6e8c
JB
109 }
110 }
297f3bbe 111 }
619f403b
JB
112 this.interleavedWeightedRoundRobinNextWorkerNodeId()
113 }
114
115 private interleavedWeightedRoundRobinNextWorkerNodeId (): void {
a38b62f1
JB
116 if (
117 this.roundId === this.roundWeights.length - 1 &&
118 this.workerNodeId === this.pool.workerNodes.length - 1
119 ) {
120 this.roundId = 0
121 this.workerNodeId = 0
122 } else if (this.workerNodeId === this.pool.workerNodes.length - 1) {
123 this.roundId = this.roundId + 1
124 this.workerNodeId = 0
125 } else {
126 this.workerNodeId = this.workerNodeId + 1
127 }
feec6e8c
JB
128 }
129
130 /** @inheritDoc */
131 public remove (workerNodeKey: number): boolean {
226b02a3
JB
132 if (this.pool.workerNodes.length === 0) {
133 this.reset()
134 }
135 if (
136 this.workerNodeId === workerNodeKey &&
137 this.workerNodeId > this.pool.workerNodes.length - 1
138 ) {
139 this.workerNodeId = this.pool.workerNodes.length - 1
140 }
141 if (
142 this.previousWorkerNodeKey === workerNodeKey &&
143 this.previousWorkerNodeKey > this.pool.workerNodes.length - 1
144 ) {
145 this.previousWorkerNodeKey = this.pool.workerNodes.length - 1
feec6e8c
JB
146 }
147 return true
148 }
149
e4854a4e 150 /** @inheritDoc */
26ce26ca 151 public setOptions (opts: InternalWorkerChoiceStrategyOptions): void {
e4854a4e
JB
152 super.setOptions(opts)
153 this.roundWeights = this.getRoundWeights()
154 }
155
feec6e8c 156 private getRoundWeights (): number[] {
feec6e8c
JB
157 return [
158 ...new Set(
00e1bdeb 159 Object.values(this.opts.weights as Record<number, number>)
feec6e8c 160 .slice()
b808b625 161 .sort((a, b) => a - b)
feec6e8c
JB
162 )
163 ]
164 }
165}