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
} from './selection-strategies-types'
* 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 = 0
+
+ /** @inheritDoc */
+ public readonly strategyPolicy: StrategyPolicy = {
+ useDynamicWorker: false
+ }
+
/** @inheritDoc */
public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
- runTime: false,
- avgRunTime: false,
- medRunTime: false,
- waitTime: false,
- avgWaitTime: false,
- medWaitTime: false,
- elu: false
+ runTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+ elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
}
/**
this.choose = this.choose.bind(this)
}
- protected setTaskStatistics (opts: WorkerChoiceStrategyOptions): void {
- if (
- this.taskStatisticsRequirements.avgRunTime &&
- opts.medRunTime === true
- ) {
- this.taskStatisticsRequirements.avgRunTime = false
- this.taskStatisticsRequirements.medRunTime = opts.medRunTime as boolean
- }
- if (
- this.taskStatisticsRequirements.medRunTime &&
- opts.medRunTime === false
- ) {
- this.taskStatisticsRequirements.avgRunTime = true
- this.taskStatisticsRequirements.medRunTime = opts.medRunTime as boolean
- }
- if (
- this.taskStatisticsRequirements.avgWaitTime &&
- opts.medWaitTime === true
- ) {
- this.taskStatisticsRequirements.avgWaitTime = false
- this.taskStatisticsRequirements.medWaitTime = opts.medWaitTime as boolean
+ protected setTaskStatisticsRequirements (
+ opts: WorkerChoiceStrategyOptions
+ ): void {
+ 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.medWaitTime &&
- opts.medWaitTime === false
- ) {
- this.taskStatisticsRequirements.avgWaitTime = true
- this.taskStatisticsRequirements.medWaitTime = opts.medWaitTime as boolean
+ if (measurementStatisticsRequirements.median && !toggleMedian) {
+ measurementStatisticsRequirements.average = true
+ measurementStatisticsRequirements.median = toggleMedian
}
}
/** @inheritDoc */
public setOptions (opts: WorkerChoiceStrategyOptions): void {
- opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
- this.setTaskStatistics(opts)
- this.opts = opts
+ this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ 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()
- }
- this.toggleFindLastFreeWorkerNodeKey = true
- return this.findFirstFreeWorkerNodeKey()
+ protected isWorkerNodeReady (workerNodeKey: number): boolean {
+ return this.pool.workerNodes[workerNodeKey].info.ready
}
/**
* Gets the worker task runtime.
- * If the task statistics require `avgRunTime`, the average runtime is returned.
- * If the task statistics require `medRunTime`, the median runtime is returned.
+ * 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.
*/
protected getWorkerTaskRunTime (workerNodeKey: number): number {
- return this.taskStatisticsRequirements.medRunTime
- ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
- : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+ return this.taskStatisticsRequirements.runTime.median
+ ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0
+ : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0
}
/**
* Gets the worker task wait time.
- * If the task statistics require `avgWaitTime`, the average wait time is returned.
- * If the task statistics require `medWaitTime`, the median wait time is returned.
+ * 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.
*/
- protected getWorkerWaitTime (workerNodeKey: number): number {
- return this.taskStatisticsRequirements.medWaitTime
- ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
- : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+ protected getWorkerTaskWaitTime (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 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.
+ */
+ protected getWorkerTaskElu (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
}
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` 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.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` 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.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
- }
}