X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fabstract-worker-choice-strategy.ts;h=bf67b80e84ef257bd8d10ffe86946a53b2433b8a;hb=0682ba158c6af9ffc453f38bd7d16438eab97695;hp=8ab3d360ca67f210db221fcdd424039799cf6668;hpb=78099a150dc54d7adab495195fa5f133fd54e114;p=poolifier.git diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts index 8ab3d360..bf67b80e 100644 --- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts +++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts @@ -1,9 +1,10 @@ -import type { IPoolInternal } from '../pool-internal' -import { PoolType } from '../pool-internal' -import type { IPoolWorker } from '../pool-worker' +import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' +import type { IPool } from '../pool' +import type { IWorker } from '../worker' import type { IWorkerChoiceStrategy, - RequiredStatistics + RequiredStatistics, + WorkerChoiceStrategyOptions } from './selection-strategies-types' /** @@ -11,17 +12,19 @@ import type { * * @typeParam Worker - Type of worker which manages the strategy. * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of response of execution. This can only be serializable data. + * @typeParam Response - Type of execution response. This can only be serializable data. */ export abstract class AbstractWorkerChoiceStrategy< - Worker extends IPoolWorker, + Worker extends IWorker, Data = unknown, Response = unknown > implements IWorkerChoiceStrategy { + /** + * Toggles finding the last free worker node key. + */ + private toggleFindLastFreeWorkerNodeKey: boolean = false /** @inheritDoc */ - protected readonly isDynamicPool: boolean - /** @inheritDoc */ - public requiredStatistics: RequiredStatistics = { + public readonly requiredStatistics: RequiredStatistics = { runTime: false, avgRunTime: false, medRunTime: false @@ -31,20 +34,105 @@ export abstract class AbstractWorkerChoiceStrategy< * Constructs a worker choice strategy bound to the pool. * * @param pool - The pool instance. + * @param opts - The worker choice strategy options. */ public constructor ( - protected readonly pool: IPoolInternal + protected readonly pool: IPool, + protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS ) { - this.isDynamicPool = this.pool.type === PoolType.DYNAMIC - this.choose.bind(this) + this.choose = this.choose.bind(this) + } + + protected checkOptions (opts: WorkerChoiceStrategyOptions): void { + if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) { + this.requiredStatistics.avgRunTime = false + this.requiredStatistics.medRunTime = opts.medRunTime as boolean + } + if (this.requiredStatistics.medRunTime && opts.medRunTime === false) { + this.requiredStatistics.avgRunTime = true + this.requiredStatistics.medRunTime = opts.medRunTime as boolean + } + if ( + opts.weights != null && + Object.keys(opts.weights).length < this.pool.size + ) { + throw new Error( + 'Worker choice strategy options must have a weight for each worker node.' + ) + } } /** @inheritDoc */ public abstract reset (): boolean + /** @inheritDoc */ + public abstract update (workerNodeKey: number): boolean + /** @inheritDoc */ public abstract choose (): number /** @inheritDoc */ - public abstract remove (workerKey: number): boolean + public abstract remove (workerNodeKey: number): boolean + + /** @inheritDoc */ + public setOptions (opts: WorkerChoiceStrategyOptions): void { + opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + this.checkOptions(opts) + this.opts = opts + } + + /** + * Finds a free worker node key. + * + * @returns The free worker node key or `-1` if there is no free worker node. + */ + protected findFreeWorkerNodeKey (): number { + if (this.toggleFindLastFreeWorkerNodeKey) { + this.toggleFindLastFreeWorkerNodeKey = false + return this.findLastFreeWorkerNodeKey() + } + this.toggleFindLastFreeWorkerNodeKey = true + return this.findFirstFreeWorkerNodeKey() + } + + /** + * Finds the first free worker node key based on the number of tasks the worker has applied. + * + * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. + * + * If no free worker is found, `-1` is returned. + * + * @returns A worker node key if there is one, `-1` otherwise. + */ + private findFirstFreeWorkerNodeKey (): number { + return this.pool.workerNodes.findIndex(workerNode => { + return workerNode.tasksUsage.running === 0 + }) + } + + /** + * Finds the last free worker node key based on the number of tasks the worker has applied. + * + * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. + * + * If no free worker is found, `-1` is returned. + * + * @returns A worker node key if there is one, `-1` otherwise. + */ + private findLastFreeWorkerNodeKey (): number { + // It requires node >= 18.0.0: + // return this.workerNodes.findLastIndex(workerNode => { + // return workerNode.tasksUsage.running === 0 + // }) + for ( + let workerNodeKey = this.pool.workerNodes.length - 1; + workerNodeKey >= 0; + workerNodeKey-- + ) { + if (this.pool.workerNodes[workerNodeKey].tasksUsage.running === 0) { + return workerNodeKey + } + } + return -1 + } }