LEAST_BUSY: 'LEAST_BUSY',
/**
* Least ELU worker selection strategy.
- *
- * @experimental
*/
LEAST_ELU: 'LEAST_ELU',
/**
*/
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.
*/
-interface MeasurementOptions {
+export interface MeasurementOptions {
/**
* Set measurement median.
*/
- median: boolean
+ readonly median: boolean
}
/**
* Worker choice strategy options.
*/
export interface WorkerChoiceStrategyOptions {
+ /**
+ * Number of worker choice retries to perform if no worker is eligible.
+ *
+ * @defaultValue 6
+ */
+ readonly retries?: number
+ /**
+ * 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.
+ * 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 Computed worker weights automatically given the CPU performance.
+ * @defaultValue Weights computed automatically given the CPU performance.
*/
- weights?: Record<number, number>
+ readonly weights?: Record<number, number>
}
/**
*
* @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
}
/**
* 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.
*/
*
* @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.
+ * If no worker nodes are not eligible, `undefined` is returned.
+ * If `undefined` is returned, the caller retry.
*
- * @returns The worker node key.
+ * @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) => void
}