-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
-import { PoolType, type IPool } from '../pool'
-import type { IWorker } from '../worker'
+import type { IPool } from '../pool.js'
+import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.js'
+import type { IWorker } from '../worker.js'
import type {
IWorkerChoiceStrategy,
- RequiredStatistics,
+ StrategyPolicy,
+ TaskStatisticsRequirements,
WorkerChoiceStrategyOptions
-} from './selection-strategies-types'
+} from './selection-strategies-types.js'
+import {
+ buildWorkerChoiceStrategyOptions,
+ toggleMedianMeasurementStatisticsRequirements
+} from './selection-strategies-utils.js'
/**
* 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,
Response = unknown
> implements IWorkerChoiceStrategy {
/**
- * Toggles finding the last free worker node key.
+ * The next worker node key.
*/
- private toggleFindLastFreeWorkerNodeKey: boolean = false
+ protected nextWorkerNodeKey: number | undefined = 0
+
+ /**
+ * The previous worker node key.
+ */
+ protected previousWorkerNodeKey = 0
+
/** @inheritDoc */
- protected readonly isDynamicPool: boolean
+ public readonly strategyPolicy: StrategyPolicy = {
+ dynamicWorkerUsage: false,
+ dynamicWorkerReady: true
+ }
+
/** @inheritDoc */
- public readonly requiredStatistics: RequiredStatistics = {
- runTime: false,
- avgRunTime: false,
- medRunTime: false
+ public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+ runTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
}
/**
*/
public constructor (
protected readonly pool: IPool<Worker, Data, Response>,
- protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ protected opts?: WorkerChoiceStrategyOptions
) {
- this.isDynamicPool = this.pool.type === PoolType.DYNAMIC
this.choose = this.choose.bind(this)
+ this.setOptions(this.opts)
}
- 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
- }
+ protected setTaskStatisticsRequirements (
+ opts: WorkerChoiceStrategyOptions | undefined
+ ): void {
+ toggleMedianMeasurementStatisticsRequirements(
+ this.taskStatisticsRequirements.runTime,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ opts!.runTime!.median
+ )
+ toggleMedianMeasurementStatisticsRequirements(
+ this.taskStatisticsRequirements.waitTime,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ opts!.waitTime!.median
+ )
+ toggleMedianMeasurementStatisticsRequirements(
+ this.taskStatisticsRequirements.elu,
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ opts!.elu!.median
+ )
+ }
+
+ protected resetWorkerNodeKeyProperties (): void {
+ this.nextWorkerNodeKey = 0
+ this.previousWorkerNodeKey = 0
}
/** @inheritDoc */
public abstract reset (): boolean
/** @inheritDoc */
- public abstract choose (): number
+ public abstract update (workerNodeKey: number): boolean
+
+ /** @inheritDoc */
+ public abstract choose (): number | undefined
/** @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
+ public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void {
+ this.opts = buildWorkerChoiceStrategyOptions<Worker, Data, Response>(
+ this.pool,
+ opts
+ )
+ this.setTaskStatisticsRequirements(this.opts)
}
/**
- * Finds a free worker node key.
+ * Whether the worker node is ready or not.
*
- * @returns The free worker node key or `-1` if there is no free worker node.
+ * @param workerNodeKey - The worker node key.
+ * @returns Whether the worker node is ready or not.
*/
- protected findFreeWorkerNodeKey (): number {
- if (this.toggleFindLastFreeWorkerNodeKey) {
- this.toggleFindLastFreeWorkerNodeKey = false
- return this.findLastFreeWorkerNodeKey()
+ protected isWorkerNodeReady (workerNodeKey: number): boolean {
+ return this.pool.workerNodes[workerNodeKey]?.info?.ready ?? false
+ }
+
+ /**
+ * Check the next worker node key.
+ */
+ protected checkNextWorkerNodeKey (): void {
+ if (
+ this.nextWorkerNodeKey != null &&
+ (this.nextWorkerNodeKey < 0 ||
+ !this.isWorkerNodeReady(this.nextWorkerNodeKey))
+ ) {
+ delete this.nextWorkerNodeKey
}
- 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.
+ * 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.
*
- * @returns A worker node key if there is one, `-1` otherwise.
+ * @param workerNodeKey - The worker node key.
+ * @returns The worker node task runtime.
*/
- private findFirstFreeWorkerNodeKey (): number {
- return this.pool.workerNodes.findIndex(workerNode => {
- return workerNode.tasksUsage?.running === 0
- })
+ 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
}
/**
- * Finds the last free worker node key based on the number of tasks the worker has applied.
+ * 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.
*
- * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
+ * @param workerNodeKey - The worker node key.
+ * @returns The worker node task wait time.
+ */
+ 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
+ }
+
+ /**
+ * 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.
*
- * If no free worker is found, `-1` is returned.
+ * @param workerNodeKey - The worker node key.
+ * @returns The worker node task ELU.
+ */
+ 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
+ }
+
+ /**
+ * Sets safely the previous worker node key.
*
- * @returns A worker node key if there is one, `-1` otherwise.
+ * @param workerNodeKey - The worker node key.
*/
- 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
+ protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void {
+ this.previousWorkerNodeKey =
+ workerNodeKey != null && workerNodeKey >= 0
+ ? workerNodeKey
+ : this.previousWorkerNodeKey
}
}