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=c4f1e2c65483ccceb1c3bb2f3343caac2c7530cf;hpb=9b1068374b1a52479b07e1e22b692289d5579237;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 c4f1e2c6..d8d8f32d 100644 --- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts +++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts @@ -1,16 +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. @@ -24,19 +24,20 @@ export abstract class AbstractWorkerChoiceStrategy< Data = unknown, Response = unknown > implements IWorkerChoiceStrategy { - // /** - // * Toggles finding the last free worker node key. - // */ - // private toggleFindLastFreeWorkerNodeKey: boolean = false - /** * The next worker node key. */ - protected nextWorkerNodeKey: number = 0 + protected nextWorkerNodeKey: number | undefined = 0 + + /** + * The previous worker node key. + */ + protected previousWorkerNodeKey: number = 0 /** @inheritDoc */ public readonly strategyPolicy: StrategyPolicy = { - useDynamicWorker: false + dynamicWorkerUsage: false, + dynamicWorkerReady: true } /** @inheritDoc */ @@ -54,62 +55,51 @@ export abstract class AbstractWorkerChoiceStrategy< */ public constructor ( protected readonly pool: IPool, - protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + protected opts?: WorkerChoiceStrategyOptions ) { + this.setOptions(this.opts) this.choose = this.choose.bind(this) } protected setTaskStatisticsRequirements ( - opts: WorkerChoiceStrategyOptions + opts: WorkerChoiceStrategyOptions | undefined ): void { - if ( - this.taskStatisticsRequirements.runTime.average && - opts.runTime?.median === true - ) { - this.taskStatisticsRequirements.runTime.average = false - this.taskStatisticsRequirements.runTime.median = opts.runTime - .median as boolean - } - if ( - this.taskStatisticsRequirements.runTime.median && - opts.runTime?.median === false - ) { - this.taskStatisticsRequirements.runTime.average = true - this.taskStatisticsRequirements.runTime.median = opts.runTime - .median as boolean - } - if ( - this.taskStatisticsRequirements.waitTime.average && - opts.waitTime?.median === true - ) { - this.taskStatisticsRequirements.waitTime.average = false - this.taskStatisticsRequirements.waitTime.median = opts.waitTime - .median as boolean - } - if ( - this.taskStatisticsRequirements.waitTime.median && - opts.waitTime?.median === false - ) { - this.taskStatisticsRequirements.waitTime.average = true - this.taskStatisticsRequirements.waitTime.median = opts.waitTime - .median as boolean - } - if ( - this.taskStatisticsRequirements.elu.average && - opts.elu?.median === true - ) { - this.taskStatisticsRequirements.elu.average = false - this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean + this.toggleMedianMeasurementStatisticsRequirements( + this.taskStatisticsRequirements.runTime, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + opts!.runTime!.median + ) + this.toggleMedianMeasurementStatisticsRequirements( + this.taskStatisticsRequirements.waitTime, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + opts!.waitTime!.median + ) + this.toggleMedianMeasurementStatisticsRequirements( + this.taskStatisticsRequirements.elu, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + opts!.elu!.median + ) + } + + private toggleMedianMeasurementStatisticsRequirements ( + measurementStatisticsRequirements: MeasurementStatisticsRequirements, + toggleMedian: boolean + ): void { + if (measurementStatisticsRequirements.average && toggleMedian) { + measurementStatisticsRequirements.average = false + measurementStatisticsRequirements.median = toggleMedian } - if ( - this.taskStatisticsRequirements.elu.median && - opts.elu?.median === false - ) { - this.taskStatisticsRequirements.elu.average = true - this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean + if (measurementStatisticsRequirements.median && !toggleMedian) { + measurementStatisticsRequirements.average = true + measurementStatisticsRequirements.median = toggleMedian } } + protected resetWorkerNodeKeyProperties (): void { + this.nextWorkerNodeKey = 0 + this.previousWorkerNodeKey = 0 + } + /** @inheritDoc */ public abstract reset (): boolean @@ -117,126 +107,93 @@ export abstract class AbstractWorkerChoiceStrategy< public abstract update (workerNodeKey: number): boolean /** @inheritDoc */ - public abstract choose (): number + public abstract choose (): number | undefined /** @inheritDoc */ public abstract remove (workerNodeKey: number): boolean /** @inheritDoc */ - public setOptions (opts: WorkerChoiceStrategyOptions): void { - this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void { + this.opts = buildWorkerChoiceStrategyOptions( + this.pool, + opts + ) this.setTaskStatisticsRequirements(this.opts) } + /** @inheritDoc */ + public hasPoolWorkerNodesReady (): boolean { + return this.pool.workerNodes.some(workerNode => workerNode.info.ready) + } + + /** + * Whether the worker node is ready or not. + * + * @param workerNodeKey - The worker node key. + * @returns Whether the worker node is ready or not. + */ protected isWorkerNodeReady (workerNodeKey: number): boolean { - return this.pool.workerNodes[workerNodeKey].info.ready + return this.pool.workerNodes[workerNodeKey]?.info?.ready ?? false } - // /** - // * 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() - // } + /** + * Check the next worker node readiness. + */ + 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 } - 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) + /** + * Sets safely the previous worker node key. + * + * @param workerNodeKey - The worker node key. + */ + protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void { + this.previousWorkerNodeKey = workerNodeKey ?? this.previousWorkerNodeKey } - - // /** - // * Finds the first free worker node key based on the number of tasks the worker has applied. - // * - // * If a worker is found with `0` executing 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.usage.tasks.executing === 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` executing 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.pool.workerNodes.findLastIndex(workerNode => { - // // return workerNode.usage.tasks.executing === 0 - // // }) - // for ( - // let workerNodeKey = this.pool.workerNodes.length - 1; - // workerNodeKey >= 0; - // workerNodeKey-- - // ) { - // if (this.pool.workerNodes[workerNodeKey].usage.tasks.executing === 0) { - // return workerNodeKey - // } - // } - // return -1 - // } }