/**
* 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',
/**
*/
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.
+ */
+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 in worker choice strategy supporting it.
+ */
+ readonly measurement?: Measurement
+ /**
+ * Runtime options.
*
- * @defaultValue false
+ * @defaultValue \{ median: false \}
*/
- medRunTime?: boolean
+ readonly runTime?: MeasurementOptions
/**
- * Use tasks median wait time instead of average runtime.
+ * Wait time options.
*
- * @defaultValue false
+ * @defaultValue \{ median: false \}
*/
- medWaitTime?: boolean
+ readonly waitTime?: MeasurementOptions
/**
- * Worker weights to use for weighted round robin worker selection strategy.
- * Weight is the tasks maximum average or median runtime in milliseconds.
+ * Event loop utilization options.
*
- * @defaultValue Computed worker weights automatically given the CPU performance.
+ * @defaultValue \{ median: false \}
+ */
+ readonly elu?: MeasurementOptions
+ /**
+ * 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>
}
/**
- * Pool worker tasks usage statistics requirements.
+ * Measurement statistics requirements.
*
* @internal
*/
-export interface TaskStatistics {
+export interface MeasurementStatisticsRequirements {
/**
- * Require tasks runtime.
+ * Requires measurement aggregate.
*/
- runTime: boolean
+ aggregate: boolean
/**
- * Require tasks average runtime.
+ * Requires measurement average.
*/
- avgRunTime: boolean
+ average: boolean
/**
- * Require tasks median runtime.
+ * Requires measurement median.
*/
- medRunTime: boolean
+ median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
+ *
+ * @internal
+ */
+export interface TaskStatisticsRequirements {
/**
- * Require tasks wait time.
+ * Tasks runtime requirements.
*/
- waitTime: boolean
+ readonly runTime: MeasurementStatisticsRequirements
/**
- * Require tasks average wait time.
+ * Tasks wait time requirements.
*/
- avgWaitTime: boolean
+ readonly waitTime: MeasurementStatisticsRequirements
/**
- * Require tasks median wait time.
+ * Tasks event loop utilization requirements.
*/
- medWaitTime: boolean
+ readonly elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ *
+ * @internal
+ */
+export interface StrategyPolicy {
+ /**
+ * Expects tasks execution on the newly created dynamic worker.
+ */
+ readonly dynamicWorkerUsage: boolean
/**
- * Event loop utilization.
+ * Expects the newly created dynamic worker to be flagged as ready.
*/
- elu: boolean
+ readonly dynamicWorkerReady: boolean
}
/**
* Worker choice strategy interface.
+ *
+ * @internal
*/
export interface IWorkerChoiceStrategy {
/**
- * Required tasks statistics.
+ * Strategy policy.
+ */
+ readonly strategyPolicy: StrategyPolicy
+ /**
+ * Tasks statistics requirements.
*/
- readonly taskStatistics: TaskStatistics
+ 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.
+ * 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 | undefined) => void
}
repositories / poolifier.git / blobdiff