feat: worker node readiness aware worker choice strategies
[poolifier.git] / src / pools / selection-strategies / least-elu-worker-choice-strategy.ts
1 import {
2 DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
3 DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
4 } from '../../utils'
5 import type { IPool } from '../pool'
6 import type { IWorker } from '../worker'
7 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
8 import type {
9 IWorkerChoiceStrategy,
10 TaskStatisticsRequirements,
11 WorkerChoiceStrategyOptions
12 } from './selection-strategies-types'
13
14 /**
15 * Selects the worker with the least ELU.
16 *
17 * @typeParam Worker - Type of worker which manages the strategy.
18 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
19 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
20 */
21 export class LeastEluWorkerChoiceStrategy<
22 Worker extends IWorker,
23 Data = unknown,
24 Response = unknown
25 >
26 extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
27 implements IWorkerChoiceStrategy {
28 /** @inheritDoc */
29 public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
30 runTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
31 waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
32 elu: {
33 aggregate: true,
34 average: false,
35 median: false
36 }
37 }
38
39 /** @inheritDoc */
40 public constructor (
41 pool: IPool<Worker, Data, Response>,
42 opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
43 ) {
44 super(pool, opts)
45 this.setTaskStatisticsRequirements(this.opts)
46 }
47
48 /** @inheritDoc */
49 public reset (): boolean {
50 return true
51 }
52
53 /** @inheritDoc */
54 public update (): boolean {
55 return true
56 }
57
58 /** @inheritDoc */
59 public choose (): number {
60 let minWorkerElu = Infinity
61 for (const [workerNodeKey, workerNode] of this.pool.workerNodes.entries()) {
62 const workerUsage = workerNode.usage
63 const workerElu = workerUsage.elu?.active?.aggregate ?? 0
64 if (this.workerNodeReady(workerNodeKey) && workerElu === 0) {
65 this.nextWorkerNodeId = workerNodeKey
66 break
67 } else if (
68 this.workerNodeReady(workerNodeKey) &&
69 workerElu < minWorkerElu
70 ) {
71 minWorkerElu = workerElu
72 this.nextWorkerNodeId = workerNodeKey
73 }
74 }
75 return this.nextWorkerNodeId
76 }
77
78 /** @inheritDoc */
79 public remove (): boolean {
80 return true
81 }
82 }