import { cpus } from 'node:os'
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import {
+ DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
import type { IPool } from '../pool'
import type { IWorker } from '../worker'
import type {
IWorkerChoiceStrategy,
+ MeasurementStatisticsRequirements,
StrategyPolicy,
TaskStatisticsRequirements,
WorkerChoiceStrategyOptions
* Worker choice strategy abstract base class.
*
* @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.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
*/
export abstract class AbstractWorkerChoiceStrategy<
Worker extends IWorker,
Data = unknown,
Response = unknown
> implements IWorkerChoiceStrategy {
- // /**
- // * Toggles finding the last free worker node key.
- // */
- // private toggleFindLastFreeWorkerNodeKey: boolean = false
-
/**
- * Id of the next worker node.
+ * The next worker node key.
*/
- protected nextWorkerNodeId: number = 0
+ protected nextWorkerNodeKey: number = 0
/** @inheritDoc */
public readonly strategyPolicy: StrategyPolicy = {
/** @inheritDoc */
public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
- runTime: {
- aggregate: false,
- average: false,
- median: false
- },
- waitTime: {
- aggregate: false,
- average: false,
- median: false
- },
- elu: {
- aggregate: false,
- average: false,
- median: false
- }
+ runTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
}
/**
protected readonly pool: IPool<Worker, Data, Response>,
protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
) {
+ this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
this.choose = this.choose.bind(this)
}
protected setTaskStatisticsRequirements (
opts: WorkerChoiceStrategyOptions
): 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,
+ opts.runTime?.median as boolean
+ )
+ this.toggleMedianMeasurementStatisticsRequirements(
+ this.taskStatisticsRequirements.waitTime,
+ opts.waitTime?.median as boolean
+ )
+ this.toggleMedianMeasurementStatisticsRequirements(
+ this.taskStatisticsRequirements.elu,
+ opts.elu?.median as boolean
+ )
+ }
+
+ 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
}
}
/** @inheritDoc */
public setOptions (opts: WorkerChoiceStrategyOptions): void {
- this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
this.setTaskStatisticsRequirements(this.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()
- // }
+ /**
+ * 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
+ }
+
+ /**
+ * Whether the worker node has back pressure or not (i.e. its tasks queue is full).
+ *
+ * @param workerNodeKey - The worker node key.
+ * @returns `true` if the worker node has back pressure, `false` otherwise.
+ */
+ private hasWorkerNodeBackPressure (workerNodeKey: number): boolean {
+ return this.pool.hasWorkerNodeBackPressure(workerNodeKey)
+ }
+
+ /**
+ * 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}
+ */
+ protected isWorkerNodeEligible (workerNodeKey: number): boolean {
+ return (
+ this.isWorkerNodeReady(workerNodeKey) &&
+ !this.hasWorkerNodeBackPressure(workerNodeKey)
+ )
+ }
/**
* Gets the worker task runtime.
*/
protected getWorkerTaskRunTime (workerNodeKey: number): number {
return this.taskStatisticsRequirements.runTime.median
- ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
- : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+ ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0
+ : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0
}
/**
*/
protected getWorkerTaskWaitTime (workerNodeKey: number): number {
return this.taskStatisticsRequirements.waitTime.median
- ? this.pool.workerNodes[workerNodeKey].workerUsage.waitTime.median
- : this.pool.workerNodes[workerNodeKey].workerUsage.waitTime.average
+ ? this.pool.workerNodes[workerNodeKey].usage.waitTime?.median ?? 0
+ : this.pool.workerNodes[workerNodeKey].usage.waitTime?.average ?? 0
}
/**
*/
protected getWorkerTaskElu (workerNodeKey: number): number {
return this.taskStatisticsRequirements.elu.median
- ? this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.median
- : this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.average
+ ? this.pool.workerNodes[workerNodeKey].usage.elu.active?.median ?? 0
+ : this.pool.workerNodes[workerNodeKey].usage.elu.active?.average ?? 0
}
protected computeDefaultWorkerWeight (): number {
}
return Math.round(cpusCycleTimeWeight / cpus().length)
}
-
- // /**
- // * 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.workerUsage.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.workerNodes.findLastIndex(workerNode => {
- // // return workerNode.workerUsage.tasks.executing === 0
- // // })
- // for (
- // let workerNodeKey = this.pool.workerNodes.length - 1;
- // workerNodeKey >= 0;
- // workerNodeKey--
- // ) {
- // if (
- // this.pool.workerNodes[workerNodeKey].workerUsage.tasks.executing === 0
- // ) {
- // return workerNodeKey
- // }
- // }
- // return -1
- // }
}
repositories / poolifier.git / blobdiff