* Least busy worker selection strategy.
*/
LEAST_BUSY: 'LEAST_BUSY',
+ /**
+ * Least ELU worker selection strategy.
+ *
+ * @experimental
+ */
+ LEAST_ELU: 'LEAST_ELU',
/**
* Fair share worker selection strategy.
*/
/**
* Weighted round robin worker selection strategy.
*/
- WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+ WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
+ /**
+ * Interleaved weighted round robin worker selection strategy.
+ *
+ * @experimental
+ */
+ INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
} as const)
/**
*/
export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
+/**
+ * Enumeration of measurements.
+ */
+export const Measurements = Object.freeze({
+ runTime: 'runTime',
+ waitTime: 'waitTime',
+ elu: 'elu'
+} as const)
+
+/**
+ * Measurement.
+ */
+export type Measurement = keyof typeof Measurements
+
+/**
+ * Measurement options.
+ */
+export interface MeasurementOptions {
+ /**
+ * Set measurement median.
+ */
+ readonly median: boolean
+}
+
/**
* Worker choice strategy options.
*/
export interface WorkerChoiceStrategyOptions {
/**
- * Use tasks median runtime instead of average runtime.
+ * Measurement to use for worker choice strategy.
+ */
+ readonly measurement?: Measurement
+ /**
+ * Runtime options.
+ *
+ * @defaultValue \{ median: false \}
+ */
+ readonly runTime?: MeasurementOptions
+ /**
+ * Wait time options.
*
- * @defaultValue false
+ * @defaultValue \{ median: false \}
*/
- medRunTime?: boolean
+ readonly waitTime?: MeasurementOptions
+ /**
+ * Event loop utilization options.
+ *
+ * @defaultValue \{ median: false \}
+ */
+ readonly elu?: MeasurementOptions
/**
* Worker weights to use for weighted round robin worker selection strategy.
* Weight is the tasks maximum average or median runtime in milliseconds.
*
* @defaultValue Computed worker weights automatically given the CPU performance.
*/
- weights?: Record<number, number>
+ readonly weights?: Record<number, number>
+}
+
+/**
+ * Measurement statistics requirements.
+ *
+ * @internal
+ */
+export interface MeasurementStatisticsRequirements {
+ /**
+ * Requires measurement aggregate.
+ */
+ aggregate: boolean
+ /**
+ * Requires measurement average.
+ */
+ average: boolean
+ /**
+ * Requires measurement median.
+ */
+ median: boolean
}
/**
- * Pool worker tasks usage statistics requirements.
+ * Pool worker node worker usage statistics requirements.
*
* @internal
*/
-export interface RequiredStatistics {
+export interface TaskStatisticsRequirements {
/**
- * Require tasks runtime.
+ * Tasks runtime requirements.
*/
- runTime: boolean
+ readonly runTime: MeasurementStatisticsRequirements
/**
- * Require tasks average runtime.
+ * Tasks wait time requirements.
*/
- avgRunTime: boolean
+ readonly waitTime: MeasurementStatisticsRequirements
/**
- * Require tasks median runtime.
+ * Tasks event loop utilization requirements.
*/
- medRunTime: boolean
+ readonly elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ *
+ * @internal
+ */
+export interface StrategyPolicy {
+ /**
+ * Expects direct usage of the newly created dynamic worker.
+ */
+ readonly useDynamicWorker: boolean
}
/**
* Worker choice strategy interface.
+ *
+ * @internal
*/
export interface IWorkerChoiceStrategy {
/**
- * Required tasks usage statistics.
+ * Strategy policy.
+ */
+ readonly strategyPolicy: StrategyPolicy
+ /**
+ * Tasks statistics requirements.
*/
- readonly requiredStatistics: RequiredStatistics
+ readonly taskStatisticsRequirements: TaskStatisticsRequirements
/**
* Resets strategy internals.
*
* @returns `true` if the reset is successful, `false` otherwise.
*/
- reset: () => boolean
+ readonly reset: () => boolean
/**
* Updates the worker node key strategy internals.
*
* @returns `true` if the update is successful, `false` otherwise.
*/
- update: (workerNodeKey: number) => boolean
+ readonly update: (workerNodeKey: number) => boolean
/**
* Chooses a worker node in the pool and returns its key.
*
* @returns The worker node key.
*/
- choose: () => number
+ readonly choose: () => number
/**
* Removes the worker node key from strategy internals.
*
* @param workerNodeKey - The worker node key.
* @returns `true` if the worker node key is removed, `false` otherwise.
*/
- remove: (workerNodeKey: number) => boolean
+ readonly remove: (workerNodeKey: number) => boolean
/**
* Sets the worker choice strategy options.
*
* @param opts - The worker choice strategy options.
*/
- setOptions: (opts: WorkerChoiceStrategyOptions) => void
+ readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
}