Commit | Line | Data |
---|---|---|
d35e5717 JB |
1 | import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../../utils.js' |
2 | import type { IPool } from '../pool.js' | |
67f3f2d6 | 3 | import type { IWorker } from '../worker.js' |
d35e5717 | 4 | import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.js' |
9adcefab JB |
5 | import { |
6 | type IWorkerChoiceStrategy, | |
7 | Measurements, | |
39618ede JB |
8 | type TaskStatisticsRequirements, |
9 | type WorkerChoiceStrategyOptions | |
d35e5717 | 10 | } from './selection-strategies-types.js' |
23ff945a | 11 | |
23ff945a JB |
12 | /** |
13 | * Selects the next worker with a fair share scheduling algorithm. | |
14 | * Loosely modeled after the fair queueing algorithm: https://en.wikipedia.org/wiki/Fair_queuing. | |
15 | * | |
38e795c1 | 16 | * @typeParam Worker - Type of worker which manages the strategy. |
e102732c JB |
17 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. |
18 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. | |
23ff945a JB |
19 | */ |
20 | export class FairShareWorkerChoiceStrategy< | |
f06e48d8 | 21 | Worker extends IWorker, |
b2b1d84e JB |
22 | Data = unknown, |
23 | Response = unknown | |
bf90656c JB |
24 | > |
25 | extends AbstractWorkerChoiceStrategy<Worker, Data, Response> | |
17393ac8 | 26 | implements IWorkerChoiceStrategy { |
afc003b2 | 27 | /** @inheritDoc */ |
87de9ff5 | 28 | public readonly taskStatisticsRequirements: TaskStatisticsRequirements = { |
932fc8be JB |
29 | runTime: { |
30 | aggregate: true, | |
31 | average: true, | |
32 | median: false | |
33 | }, | |
3c93feb9 | 34 | waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS, |
5df69fab | 35 | elu: { |
9adcefab JB |
36 | aggregate: true, |
37 | average: true, | |
5df69fab JB |
38 | median: false |
39 | } | |
10fcfaf4 JB |
40 | } |
41 | ||
2fc5cae3 JB |
42 | /** @inheritDoc */ |
43 | public constructor ( | |
44 | pool: IPool<Worker, Data, Response>, | |
39618ede | 45 | opts?: WorkerChoiceStrategyOptions |
2fc5cae3 JB |
46 | ) { |
47 | super(pool, opts) | |
932fc8be | 48 | this.setTaskStatisticsRequirements(this.opts) |
2fc5cae3 JB |
49 | } |
50 | ||
afc003b2 | 51 | /** @inheritDoc */ |
a6f7f1b4 | 52 | public reset (): boolean { |
f3a91bac JB |
53 | for (const workerNode of this.pool.workerNodes) { |
54 | delete workerNode.strategyData?.virtualTaskEndTimestamp | |
55 | } | |
ea7a90d3 JB |
56 | return true |
57 | } | |
58 | ||
138d29a8 | 59 | /** @inheritDoc */ |
a4958de2 | 60 | public update (workerNodeKey: number): boolean { |
f3a91bac JB |
61 | this.pool.workerNodes[workerNodeKey].strategyData = { |
62 | virtualTaskEndTimestamp: | |
63 | this.computeWorkerNodeVirtualTaskEndTimestamp(workerNodeKey) | |
64 | } | |
db703c75 JB |
65 | return true |
66 | } | |
67 | ||
68 | /** @inheritDoc */ | |
b1aae695 | 69 | public choose (): number | undefined { |
baca80f7 | 70 | this.setPreviousWorkerNodeKey(this.nextWorkerNodeKey) |
fce028d6 | 71 | this.nextWorkerNodeKey = this.fairShareNextWorkerNodeKey() |
b1aae695 | 72 | return this.nextWorkerNodeKey |
9b106837 JB |
73 | } |
74 | ||
75 | /** @inheritDoc */ | |
f3a91bac | 76 | public remove (): boolean { |
9b106837 JB |
77 | return true |
78 | } | |
79 | ||
b1aae695 | 80 | private fairShareNextWorkerNodeKey (): number | undefined { |
f3a91bac JB |
81 | return this.pool.workerNodes.reduce( |
82 | (minWorkerNodeKey, workerNode, workerNodeKey, workerNodes) => { | |
83 | if (workerNode.strategyData?.virtualTaskEndTimestamp == null) { | |
84 | workerNode.strategyData = { | |
85 | virtualTaskEndTimestamp: | |
86 | this.computeWorkerNodeVirtualTaskEndTimestamp(workerNodeKey) | |
87 | } | |
88 | } | |
ae3ab61d | 89 | return this.isWorkerNodeReady(workerNodeKey) && |
67f3f2d6 JB |
90 | // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
91 | workerNode.strategyData.virtualTaskEndTimestamp! < | |
92 | // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | |
93 | workerNodes[minWorkerNodeKey].strategyData!.virtualTaskEndTimestamp! | |
f3a91bac JB |
94 | ? workerNodeKey |
95 | : minWorkerNodeKey | |
96 | }, | |
97 | 0 | |
98 | ) | |
97a2abc3 JB |
99 | } |
100 | ||
23ff945a | 101 | /** |
b0d6ed8f | 102 | * Computes the worker node key virtual task end timestamp. |
11df3590 | 103 | * |
f06e48d8 | 104 | * @param workerNodeKey - The worker node key. |
f3a91bac | 105 | * @returns The worker node key virtual task end timestamp. |
23ff945a | 106 | */ |
f3a91bac JB |
107 | private computeWorkerNodeVirtualTaskEndTimestamp ( |
108 | workerNodeKey: number | |
109 | ): number { | |
110 | return this.getWorkerNodeVirtualTaskEndTimestamp( | |
111 | workerNodeKey, | |
112 | this.getWorkerNodeVirtualTaskStartTimestamp(workerNodeKey) | |
113 | ) | |
b0d6ed8f JB |
114 | } |
115 | ||
f3a91bac | 116 | private getWorkerNodeVirtualTaskEndTimestamp ( |
b0d6ed8f | 117 | workerNodeKey: number, |
f3a91bac | 118 | workerNodeVirtualTaskStartTimestamp: number |
b0d6ed8f | 119 | ): number { |
f3a91bac | 120 | const workerNodeTaskRunTime = |
39618ede JB |
121 | // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
122 | this.opts!.measurement === Measurements.elu | |
f3a91bac JB |
123 | ? this.getWorkerNodeTaskElu(workerNodeKey) |
124 | : this.getWorkerNodeTaskRunTime(workerNodeKey) | |
125 | return workerNodeVirtualTaskStartTimestamp + workerNodeTaskRunTime | |
b0d6ed8f JB |
126 | } |
127 | ||
f3a91bac JB |
128 | private getWorkerNodeVirtualTaskStartTimestamp ( |
129 | workerNodeKey: number | |
130 | ): number { | |
f201a0cd JB |
131 | const virtualTaskEndTimestamp = |
132 | this.pool.workerNodes[workerNodeKey]?.strategyData | |
133 | ?.virtualTaskEndTimestamp | |
f3a91bac | 134 | const now = performance.now() |
f201a0cd | 135 | return now < (virtualTaskEndTimestamp ?? -Infinity) |
67f3f2d6 JB |
136 | ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
137 | virtualTaskEndTimestamp! | |
f3a91bac | 138 | : now |
23ff945a JB |
139 | } |
140 | } |