X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fabstract-worker-choice-strategy.ts;h=3dda355ef29a043ad3c9c4d34241cebac6e1f28f;hb=feec4213515cceb460e722dedca403914764b487;hp=9cbebc3b0d4d87cdac321e60d0d840f343683576;hpb=bdaf31cd0e637aa466c78d54a49f157899a2cb3f;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 9cbebc3b..3dda355e 100644 --- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts +++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts @@ -1,32 +1,126 @@ -import type { AbstractPoolWorker } from '../abstract-pool-worker' -import type { IPoolInternal } from '../pool-internal' -import { PoolType } from '../pool-internal' -import type { IWorkerChoiceStrategy } from './selection-strategies-types' +import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' +import { type IPool, PoolType } from '../pool' +import type { IWorker } from '../worker' +import type { + IWorkerChoiceStrategy, + RequiredStatistics, + WorkerChoiceStrategyOptions +} from './selection-strategies-types' /** - * Abstract worker choice strategy class. + * Worker choice strategy abstract base class. * - * @template Worker Type of worker which manages the strategy. - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. This can only be serializable data. + * @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 execution response. This can only be serializable data. */ export abstract class AbstractWorkerChoiceStrategy< - Worker extends AbstractPoolWorker, - Data, - Response -> implements IWorkerChoiceStrategy { - /** @inheritdoc */ - public isDynamicPool: boolean = this.pool.type === PoolType.DYNAMIC + 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 readonly requiredStatistics: RequiredStatistics = { + runTime: false, + avgRunTime: false, + medRunTime: false + } /** - * Constructs a worker choice strategy attached to the pool. + * Constructs a worker choice strategy bound to the pool. * - * @param pool The pool instance. + * @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 = 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 + } + } + + /** @inheritDoc */ + public abstract reset (): boolean + + /** @inheritDoc */ + public abstract choose (): number + + /** @inheritDoc */ + 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() + } - /** @inheritdoc */ - public abstract choose (): Worker + /** + * 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 i = this.pool.workerNodes.length - 1; i >= 0; i--) { + if (this.pool.workerNodes[i].tasksUsage?.running === 0) { + return i + } + } + return -1 + } }