Commit | Line | Data |
---|---|---|
bbeadd16 | 1 | import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' |
c4855468 | 2 | import { PoolType, type IPool } from '../pool' |
f06e48d8 | 3 | import type { IWorker } from '../worker' |
10fcfaf4 JB |
4 | import type { |
5 | IWorkerChoiceStrategy, | |
da309861 JB |
6 | RequiredStatistics, |
7 | WorkerChoiceStrategyOptions | |
10fcfaf4 | 8 | } from './selection-strategies-types' |
bdaf31cd JB |
9 | |
10 | /** | |
9cd39dd4 | 11 | * Worker choice strategy abstract base class. |
bdaf31cd | 12 | * |
38e795c1 JB |
13 | * @typeParam Worker - Type of worker which manages the strategy. |
14 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. | |
02706357 | 15 | * @typeParam Response - Type of execution response. This can only be serializable data. |
bdaf31cd JB |
16 | */ |
17 | export abstract class AbstractWorkerChoiceStrategy< | |
f06e48d8 | 18 | Worker extends IWorker, |
b2b1d84e JB |
19 | Data = unknown, |
20 | Response = unknown | |
17393ac8 | 21 | > implements IWorkerChoiceStrategy { |
cb70b19d JB |
22 | /** |
23 | * Toggles finding the last free worker node key. | |
24 | */ | |
25 | private toggleFindLastFreeWorkerNodeKey: boolean = false | |
afc003b2 | 26 | /** @inheritDoc */ |
8b4d4500 | 27 | protected readonly isDynamicPool: boolean |
afc003b2 | 28 | /** @inheritDoc */ |
da309861 | 29 | public readonly requiredStatistics: RequiredStatistics = { |
c6bd2650 | 30 | runTime: false, |
78099a15 JB |
31 | avgRunTime: false, |
32 | medRunTime: false | |
10fcfaf4 | 33 | } |
bdaf31cd JB |
34 | |
35 | /** | |
6533c3e6 | 36 | * Constructs a worker choice strategy bound to the pool. |
bdaf31cd | 37 | * |
38e795c1 | 38 | * @param pool - The pool instance. |
da309861 | 39 | * @param opts - The worker choice strategy options. |
bdaf31cd JB |
40 | */ |
41 | public constructor ( | |
c4855468 | 42 | protected readonly pool: IPool<Worker, Data, Response>, |
a20f0ba5 | 43 | protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS |
b8f3418c JB |
44 | ) { |
45 | this.isDynamicPool = this.pool.type === PoolType.DYNAMIC | |
7254e419 | 46 | this.choose = this.choose.bind(this) |
b8f3418c | 47 | } |
bdaf31cd | 48 | |
2fc5cae3 | 49 | protected checkOptions (opts: WorkerChoiceStrategyOptions): void { |
f9f00b5f | 50 | if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) { |
2fc5cae3 JB |
51 | this.requiredStatistics.avgRunTime = false |
52 | this.requiredStatistics.medRunTime = opts.medRunTime as boolean | |
da309861 | 53 | } |
a20f0ba5 JB |
54 | if (this.requiredStatistics.medRunTime && opts.medRunTime === false) { |
55 | this.requiredStatistics.avgRunTime = true | |
56 | this.requiredStatistics.medRunTime = opts.medRunTime as boolean | |
57 | } | |
da309861 JB |
58 | } |
59 | ||
afc003b2 | 60 | /** @inheritDoc */ |
a6f7f1b4 | 61 | public abstract reset (): boolean |
ea7a90d3 | 62 | |
afc003b2 | 63 | /** @inheritDoc */ |
c923ce56 | 64 | public abstract choose (): number |
97a2abc3 | 65 | |
afc003b2 | 66 | /** @inheritDoc */ |
f06e48d8 | 67 | public abstract remove (workerNodeKey: number): boolean |
a20f0ba5 JB |
68 | |
69 | /** @inheritDoc */ | |
70 | public setOptions (opts: WorkerChoiceStrategyOptions): void { | |
d01e4d67 | 71 | opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS |
a20f0ba5 JB |
72 | this.checkOptions(opts) |
73 | this.opts = opts | |
74 | } | |
cb70b19d JB |
75 | |
76 | /** | |
77 | * Finds a free worker node key. | |
78 | * | |
79 | * @returns The free worker node key or `-1` if there is no free worker node. | |
80 | */ | |
81 | protected findFreeWorkerNodeKey (): number { | |
82 | if (this.toggleFindLastFreeWorkerNodeKey) { | |
83 | this.toggleFindLastFreeWorkerNodeKey = false | |
84 | return this.pool.findLastFreeWorkerNodeKey() | |
85 | } | |
86 | this.toggleFindLastFreeWorkerNodeKey = true | |
87 | return this.pool.findFreeWorkerNodeKey() | |
88 | } | |
bdaf31cd | 89 | } |