/**
* Enumeration of worker choice strategies.
*/
-export const WorkerChoiceStrategies = Object.freeze({
+export const WorkerChoiceStrategies: Readonly<{
+ ROUND_ROBIN: 'ROUND_ROBIN'
+ LEAST_USED: 'LEAST_USED'
+ LEAST_BUSY: 'LEAST_BUSY'
+ LEAST_ELU: 'LEAST_ELU'
+ FAIR_SHARE: 'FAIR_SHARE'
+ WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+ INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+}> = Object.freeze({
/**
* Round robin worker selection strategy.
*/
LEAST_BUSY: 'LEAST_BUSY',
/**
* Least ELU worker selection strategy.
- *
- * @experimental
*/
LEAST_ELU: 'LEAST_ELU',
/**
WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
/**
* Interleaved weighted round robin worker selection strategy.
- *
* @experimental
*/
- INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+ INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN',
} as const)
/**
*/
export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
+/**
+ * Enumeration of measurements.
+ */
+export const Measurements: Readonly<{
+ runTime: 'runTime'
+ waitTime: 'waitTime'
+ elu: 'elu'
+}> = Object.freeze({
+ runTime: 'runTime',
+ waitTime: 'waitTime',
+ elu: 'elu',
+} as const)
+
+/**
+ * Measurement.
+ */
+export type Measurement = keyof typeof Measurements
+
/**
* Measurement options.
*/
-interface MeasurementOptions {
+export interface MeasurementOptions {
/**
* Set measurement median.
*/
- median: boolean
+ readonly median: boolean
}
/**
* Worker choice strategy options.
*/
export interface WorkerChoiceStrategyOptions {
+ /**
+ * Measurement to use in worker choice strategy supporting it.
+ */
+ readonly measurement?: Measurement
/**
* Runtime options.
- *
* @defaultValue \{ median: false \}
*/
- runTime?: MeasurementOptions
+ readonly runTime?: MeasurementOptions
/**
* Wait time options.
- *
* @defaultValue \{ median: false \}
*/
- waitTime?: MeasurementOptions
+ readonly waitTime?: MeasurementOptions
/**
* Event loop utilization options.
- *
* @defaultValue \{ median: false \}
*/
- elu?: MeasurementOptions
+ 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.
+ * Worker weights to use for weighted round robin worker selection strategies.
+ * A weight is tasks maximum execution time in milliseconds for a worker node.
+ * @defaultValue Weights computed automatically given the CPU performance.
*/
weights?: Record<number, number>
}
/**
* Measurement statistics requirements.
- *
* @internal
*/
-interface MeasurementStatisticsRequirements {
+export interface MeasurementStatisticsRequirements {
/**
- * Require measurement aggregate.
+ * Requires measurement aggregate.
*/
aggregate: boolean
/**
- * Require measurement average.
+ * Requires measurement average.
*/
average: boolean
/**
- * Require measurement median.
+ * Requires measurement median.
*/
median: boolean
}
/**
* Pool worker node worker usage statistics requirements.
- *
* @internal
*/
export interface TaskStatisticsRequirements {
/**
* Tasks runtime requirements.
*/
- runTime: MeasurementStatisticsRequirements
+ readonly runTime: MeasurementStatisticsRequirements
/**
* Tasks wait time requirements.
*/
- waitTime: MeasurementStatisticsRequirements
+ readonly waitTime: MeasurementStatisticsRequirements
/**
* Tasks event loop utilization requirements.
*/
- elu: MeasurementStatisticsRequirements
+ readonly elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ * @internal
+ */
+export interface StrategyPolicy {
+ /**
+ * Expects tasks execution on the newly created dynamic worker.
+ */
+ readonly dynamicWorkerUsage: boolean
+ /**
+ * Expects the newly created dynamic worker to be flagged as ready.
+ */
+ readonly dynamicWorkerReady: boolean
}
/**
* Worker choice strategy interface.
+ * @internal
*/
export interface IWorkerChoiceStrategy {
+ /**
+ * Strategy policy.
+ */
+ readonly strategyPolicy: StrategyPolicy
/**
* Tasks statistics requirements.
*/
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.
- *
+ * This is called after a task has been executed on a worker node.
* @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.
+ * If no worker nodes are not eligible, `undefined` is returned.
+ * If `undefined` is returned, the caller retry.
+ * @returns The worker node key or `undefined`.
*/
- choose: () => number
+ readonly choose: () => number | undefined
/**
* 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 | undefined) => void
}