| 1 | import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' |
| 2 | import type { IPool } from '../pool' |
| 3 | import type { IWorker } from '../worker' |
| 4 | import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy' |
| 5 | import type { |
| 6 | IWorkerChoiceStrategy, |
| 7 | RequiredStatistics, |
| 8 | WorkerChoiceStrategyOptions |
| 9 | } from './selection-strategies-types' |
| 10 | |
| 11 | /** |
| 12 | * Worker virtual task timestamp. |
| 13 | */ |
| 14 | interface WorkerVirtualTaskTimestamp { |
| 15 | start: number |
| 16 | end: number |
| 17 | } |
| 18 | |
| 19 | /** |
| 20 | * Selects the next worker with a fair share scheduling algorithm. |
| 21 | * Loosely modeled after the fair queueing algorithm: https://en.wikipedia.org/wiki/Fair_queuing. |
| 22 | * |
| 23 | * @typeParam Worker - Type of worker which manages the strategy. |
| 24 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. |
| 25 | * @typeParam Response - Type of execution response. This can only be serializable data. |
| 26 | */ |
| 27 | export class FairShareWorkerChoiceStrategy< |
| 28 | Worker extends IWorker, |
| 29 | Data = unknown, |
| 30 | Response = unknown |
| 31 | > |
| 32 | extends AbstractWorkerChoiceStrategy<Worker, Data, Response> |
| 33 | implements IWorkerChoiceStrategy { |
| 34 | /** @inheritDoc */ |
| 35 | public readonly requiredStatistics: RequiredStatistics = { |
| 36 | runTime: true, |
| 37 | avgRunTime: true, |
| 38 | medRunTime: false |
| 39 | } |
| 40 | |
| 41 | /** |
| 42 | * Workers' virtual task execution timestamp. |
| 43 | */ |
| 44 | private workersVirtualTaskTimestamp: WorkerVirtualTaskTimestamp[] = [] |
| 45 | |
| 46 | /** @inheritDoc */ |
| 47 | public constructor ( |
| 48 | pool: IPool<Worker, Data, Response>, |
| 49 | opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS |
| 50 | ) { |
| 51 | super(pool, opts) |
| 52 | this.checkOptions(this.opts) |
| 53 | } |
| 54 | |
| 55 | /** @inheritDoc */ |
| 56 | public reset (): boolean { |
| 57 | this.workersVirtualTaskTimestamp = [] |
| 58 | return true |
| 59 | } |
| 60 | |
| 61 | /** @inheritDoc */ |
| 62 | public choose (): number { |
| 63 | let minWorkerVirtualTaskEndTimestamp = Infinity |
| 64 | let chosenWorkerNodeKey!: number |
| 65 | for (const [workerNodeKey] of this.pool.workerNodes.entries()) { |
| 66 | this.computeWorkerVirtualTaskTimestamp(workerNodeKey) |
| 67 | const workerVirtualTaskEndTimestamp = |
| 68 | this.workersVirtualTaskTimestamp[workerNodeKey]?.end ?? 0 |
| 69 | if (workerVirtualTaskEndTimestamp < minWorkerVirtualTaskEndTimestamp) { |
| 70 | minWorkerVirtualTaskEndTimestamp = workerVirtualTaskEndTimestamp |
| 71 | chosenWorkerNodeKey = workerNodeKey |
| 72 | } |
| 73 | } |
| 74 | return chosenWorkerNodeKey |
| 75 | } |
| 76 | |
| 77 | /** @inheritDoc */ |
| 78 | public remove (workerNodeKey: number): boolean { |
| 79 | this.workersVirtualTaskTimestamp.splice(workerNodeKey, 1) |
| 80 | return true |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Computes worker virtual task timestamp. |
| 85 | * |
| 86 | * @param workerNodeKey - The worker node key. |
| 87 | */ |
| 88 | private computeWorkerVirtualTaskTimestamp (workerNodeKey: number): void { |
| 89 | const workerVirtualTaskStartTimestamp = Math.max( |
| 90 | performance.now(), |
| 91 | this.workersVirtualTaskTimestamp[workerNodeKey]?.end ?? -Infinity |
| 92 | ) |
| 93 | const workerVirtualTaskTRunTime = this.requiredStatistics.medRunTime |
| 94 | ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime |
| 95 | : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime |
| 96 | this.workersVirtualTaskTimestamp[workerNodeKey] = { |
| 97 | start: workerVirtualTaskStartTimestamp, |
| 98 | end: workerVirtualTaskStartTimestamp + (workerVirtualTaskTRunTime ?? 0) |
| 99 | } |
| 100 | } |
| 101 | } |