-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
worker-choice-strategy-context.ts
181 lines (173 loc) · 5.53 KB
/
worker-choice-strategy-context.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
import type { IPool } from '../pool'
import type { IWorker } from '../worker'
import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy'
import { InterleavedWeightedRoundRobinWorkerChoiceStrategy } from './interleaved-weighted-round-robin-worker-choice-strategy'
import { LeastBusyWorkerChoiceStrategy } from './least-busy-worker-choice-strategy'
import { LeastUsedWorkerChoiceStrategy } from './least-used-worker-choice-strategy'
import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy'
import type {
IWorkerChoiceStrategy,
RequiredStatistics,
WorkerChoiceStrategy,
WorkerChoiceStrategyOptions
} from './selection-strategies-types'
import { WorkerChoiceStrategies } from './selection-strategies-types'
import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy'
/**
* The worker choice strategy context.
*
* @typeParam Worker - Type of worker.
* @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 WorkerChoiceStrategyContext<
Worker extends IWorker,
Data = unknown,
Response = unknown
> {
private readonly workerChoiceStrategies: Map<
WorkerChoiceStrategy,
IWorkerChoiceStrategy
>
/**
* Worker choice strategy context constructor.
*
* @param pool - The pool instance.
* @param workerChoiceStrategy - The worker choice strategy.
* @param opts - The worker choice strategy options.
*/
public constructor (
pool: IPool<Worker, Data, Response>,
private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
) {
this.execute = this.execute.bind(this)
this.workerChoiceStrategies = new Map<
WorkerChoiceStrategy,
IWorkerChoiceStrategy
>([
[
WorkerChoiceStrategies.ROUND_ROBIN,
new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
opts
)
],
[
WorkerChoiceStrategies.LEAST_USED,
new (LeastUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
opts
)
],
[
WorkerChoiceStrategies.LEAST_BUSY,
new (LeastBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
opts
)
],
[
WorkerChoiceStrategies.FAIR_SHARE,
new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
pool,
opts
)
],
[
WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN,
new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))<
Worker,
Data,
Response
>(pool, opts)
],
[
WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN,
new (InterleavedWeightedRoundRobinWorkerChoiceStrategy.bind(this))<
Worker,
Data,
Response
>(pool, opts)
]
])
}
/**
* Gets the worker choice strategy in the context required statistics.
*
* @returns The required statistics.
*/
public getRequiredStatistics (): RequiredStatistics {
return (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
).requiredStatistics
}
/**
* Sets the worker choice strategy to use in the context.
*
* @param workerChoiceStrategy - The worker choice strategy to set.
*/
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
if (this.workerChoiceStrategy !== workerChoiceStrategy) {
this.workerChoiceStrategy = workerChoiceStrategy
}
this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset()
}
/**
* Updates the worker node key in the worker choice strategy internals in the context.
*
* @returns `true` if the update is successful, `false` otherwise.
*/
public update (workerNodeKey: number): boolean {
return (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
).update(workerNodeKey)
}
/**
* Executes the worker choice strategy algorithm in the context.
*
* @returns The key of the worker node.
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker node key is null or undefined.
*/
public execute (): number {
const workerNodeKey = (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
).choose()
if (workerNodeKey == null) {
throw new Error('Worker node key chosen is null or undefined')
}
return workerNodeKey
}
/**
* Removes the worker node key from the worker choice strategy in the context.
*
* @param workerNodeKey - The key of the worker node.
* @returns `true` if the removal is successful, `false` otherwise.
*/
public remove (workerNodeKey: number): boolean {
return (
this.workerChoiceStrategies.get(
this.workerChoiceStrategy
) as IWorkerChoiceStrategy
).remove(workerNodeKey)
}
/**
* Sets the worker choice strategies in the context options.
*
* @param opts - The worker choice strategy options.
*/
public setOptions (opts: WorkerChoiceStrategyOptions): void {
for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
workerChoiceStrategy.setOptions(opts)
}
}
}