X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fabstract-worker-choice-strategy.ts;h=d8d8f32d2f9dc2eee45f63c75f2aa0ece167b108;hb=ce63d9e2f3d895bd2ae5aafc40769ff4dda3c887;hp=cc38d196941e4611af2235a84899cd82ab55c9f0;hpb=c90257c0b2d2c8ebdc6abbee02361cc2ddae36b9;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 cc38d196..d8d8f32d 100644 --- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts +++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts @@ -1,17 +1,16 @@ -import { cpus } from 'node:os' import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS, - DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS -} from '../../utils' -import type { IPool } from '../pool' -import type { IWorker } from '../worker' + buildWorkerChoiceStrategyOptions +} from '../../utils.js' +import type { IPool } from '../pool.js' +import type { IWorker } from '../worker.js' import type { IWorkerChoiceStrategy, MeasurementStatisticsRequirements, StrategyPolicy, TaskStatisticsRequirements, WorkerChoiceStrategyOptions -} from './selection-strategies-types' +} from './selection-strategies-types.js' /** * Worker choice strategy abstract base class. @@ -56,26 +55,29 @@ export abstract class AbstractWorkerChoiceStrategy< */ public constructor ( protected readonly pool: IPool, - protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + protected opts?: WorkerChoiceStrategyOptions ) { - this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts } + this.setOptions(this.opts) this.choose = this.choose.bind(this) } protected setTaskStatisticsRequirements ( - opts: WorkerChoiceStrategyOptions + opts: WorkerChoiceStrategyOptions | undefined ): void { this.toggleMedianMeasurementStatisticsRequirements( this.taskStatisticsRequirements.runTime, - opts.runTime?.median as boolean + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + opts!.runTime!.median ) this.toggleMedianMeasurementStatisticsRequirements( this.taskStatisticsRequirements.waitTime, - opts.waitTime?.median as boolean + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + opts!.waitTime!.median ) this.toggleMedianMeasurementStatisticsRequirements( this.taskStatisticsRequirements.elu, - opts.elu?.median as boolean + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + opts!.elu!.median ) } @@ -93,6 +95,11 @@ export abstract class AbstractWorkerChoiceStrategy< } } + protected resetWorkerNodeKeyProperties (): void { + this.nextWorkerNodeKey = 0 + this.previousWorkerNodeKey = 0 + } + /** @inheritDoc */ public abstract reset (): boolean @@ -106,122 +113,87 @@ export abstract class AbstractWorkerChoiceStrategy< public abstract remove (workerNodeKey: number): boolean /** @inheritDoc */ - public setOptions (opts: WorkerChoiceStrategyOptions): void { - this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts } + public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void { + this.opts = buildWorkerChoiceStrategyOptions( + this.pool, + opts + ) this.setTaskStatisticsRequirements(this.opts) } - /** - * Whether the worker node is ready or not. - * - * @param workerNodeKey - The worker node key. - * @returns Whether the worker node is ready or not. - */ - private isWorkerNodeReady (workerNodeKey: number): boolean { - return this.pool.workerNodes[workerNodeKey].info.ready + /** @inheritDoc */ + public hasPoolWorkerNodesReady (): boolean { + return this.pool.workerNodes.some(workerNode => workerNode.info.ready) } /** - * Whether the worker node has back pressure or not (i.e. its tasks queue is full). + * Whether the worker node is ready or not. * * @param workerNodeKey - The worker node key. - * @returns `true` if the worker node has back pressure, `false` otherwise. + * @returns Whether the worker node is ready or not. */ - private hasWorkerNodeBackPressure (workerNodeKey: number): boolean { - return this.pool.hasWorkerNodeBackPressure(workerNodeKey) + protected isWorkerNodeReady (workerNodeKey: number): boolean { + return this.pool.workerNodes[workerNodeKey]?.info?.ready ?? false } /** - * Whether the worker node is eligible or not. - * A worker node is eligible if it is ready and does not have back pressure. - * - * @param workerNodeKey - The worker node key. - * @returns `true` if the worker node is eligible, `false` otherwise. - * @see {@link isWorkerNodeReady} - * @see {@link hasWorkerNodeBackPressure} + * Check the next worker node readiness. */ - protected isWorkerNodeEligible (workerNodeKey: number): boolean { - return ( - this.isWorkerNodeReady(workerNodeKey) && - !this.hasWorkerNodeBackPressure(workerNodeKey) - ) + protected checkNextWorkerNodeReadiness (): void { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + if (!this.isWorkerNodeReady(this.nextWorkerNodeKey!)) { + delete this.nextWorkerNodeKey + } } /** - * Gets the worker task runtime. + * Gets the worker node task runtime. * If the task statistics require the average runtime, the average runtime is returned. * If the task statistics require the median runtime , the median runtime is returned. * * @param workerNodeKey - The worker node key. - * @returns The worker task runtime. + * @returns The worker node task runtime. */ - protected getWorkerTaskRunTime (workerNodeKey: number): number { + protected getWorkerNodeTaskRunTime (workerNodeKey: number): number { return this.taskStatisticsRequirements.runTime.median - ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0 - : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0 + ? this.pool.workerNodes[workerNodeKey].usage.runTime.median ?? 0 + : this.pool.workerNodes[workerNodeKey].usage.runTime.average ?? 0 } /** - * Gets the worker task wait time. + * Gets the worker node task wait time. * If the task statistics require the average wait time, the average wait time is returned. * If the task statistics require the median wait time, the median wait time is returned. * * @param workerNodeKey - The worker node key. - * @returns The worker task wait time. + * @returns The worker node task wait time. */ - protected getWorkerTaskWaitTime (workerNodeKey: number): number { + protected getWorkerNodeTaskWaitTime (workerNodeKey: number): number { return this.taskStatisticsRequirements.waitTime.median - ? this.pool.workerNodes[workerNodeKey].usage.waitTime?.median ?? 0 - : this.pool.workerNodes[workerNodeKey].usage.waitTime?.average ?? 0 + ? this.pool.workerNodes[workerNodeKey].usage.waitTime.median ?? 0 + : this.pool.workerNodes[workerNodeKey].usage.waitTime.average ?? 0 } /** - * Gets the worker task ELU. + * Gets the worker node task ELU. * If the task statistics require the average ELU, the average ELU is returned. * If the task statistics require the median ELU, the median ELU is returned. * * @param workerNodeKey - The worker node key. - * @returns The worker task ELU. + * @returns The worker node task ELU. */ - protected getWorkerTaskElu (workerNodeKey: number): number { + protected getWorkerNodeTaskElu (workerNodeKey: number): number { return this.taskStatisticsRequirements.elu.median - ? this.pool.workerNodes[workerNodeKey].usage.elu.active?.median ?? 0 - : this.pool.workerNodes[workerNodeKey].usage.elu.active?.average ?? 0 + ? this.pool.workerNodes[workerNodeKey].usage.elu.active.median ?? 0 + : this.pool.workerNodes[workerNodeKey].usage.elu.active.average ?? 0 } /** - * Assign to nextWorkerNodeKey property the chosen worker node key. + * Sets safely the previous worker node key. * - * @param chosenWorkerNodeKey - The chosen worker node key. + * @param workerNodeKey - The worker node key. */ - protected assignChosenWorkerNodeKey ( - chosenWorkerNodeKey: number | undefined - ): void { - if (chosenWorkerNodeKey != null) { - this.nextWorkerNodeKey = chosenWorkerNodeKey - } else { - this.nextWorkerNodeKey = undefined - } - } - - protected checkNextWorkerNodeEligibility ( - chosenWorkerNodeKey: number | undefined - ): void { - if (!this.isWorkerNodeEligible(this.nextWorkerNodeKey as number)) { - this.nextWorkerNodeKey = undefined - this.previousWorkerNodeKey = - chosenWorkerNodeKey ?? this.previousWorkerNodeKey - } - } - - protected computeDefaultWorkerWeight (): number { - let cpusCycleTimeWeight = 0 - for (const cpu of cpus()) { - // CPU estimated cycle time - const numberOfDigits = cpu.speed.toString().length - 1 - const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits)) - cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits) - } - return Math.round(cpusCycleTimeWeight / cpus().length) + protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void { + this.previousWorkerNodeKey = workerNodeKey ?? this.previousWorkerNodeKey } }