X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=e53f3e822967b43a7d6f11ca0b34e6e3a9e7ed4e;hb=8e5ca0401467b0a5c40b20a40ef08db6c05b9561;hp=6ae695ca6dca6141d48cef31dd46c6be5cb08bbb;hpb=ae782cfa994b2468b49e4279e03c5140e9e309e3;p=poolifier.git diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts index 6ae695ca..e53f3e82 100644 --- a/src/pools/selection-strategies/selection-strategies-types.ts +++ b/src/pools/selection-strategies/selection-strategies-types.ts @@ -7,13 +7,19 @@ export const WorkerChoiceStrategies = Object.freeze({ */ ROUND_ROBIN: 'ROUND_ROBIN', /** - * Less used worker selection strategy. + * Least used worker selection strategy. */ - LESS_USED: 'LESS_USED', + LEAST_USED: 'LEAST_USED', /** - * Less busy worker selection strategy. + * Least busy worker selection strategy. */ - LESS_BUSY: 'LESS_BUSY', + LEAST_BUSY: 'LEAST_BUSY', + /** + * Least ELU worker selection strategy. + * + * @experimental + */ + LEAST_ELU: 'LEAST_ELU', /** * Fair share worker selection strategy. */ @@ -35,82 +41,160 @@ export const WorkerChoiceStrategies = Object.freeze({ */ 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 run time instead of average run time. + * Measurement to use for worker choice strategy. + */ + readonly measurement?: Measurement + /** + * Runtime options. + * + * @defaultValue \{ median: false \} + */ + readonly runTime?: MeasurementOptions + /** + * Wait time options. + * + * @defaultValue \{ median: false \} + */ + readonly waitTime?: MeasurementOptions + /** + * Event loop utilization options. * - * @defaultValue false + * @defaultValue \{ median: false \} */ - medRunTime?: boolean + 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 + readonly weights?: Record } /** - * Pool worker tasks usage statistics requirements. + * Measurement statistics requirements. * * @internal */ -export interface RequiredStatistics { +export interface MeasurementStatisticsRequirements { /** - * Require tasks run time. + * Requires measurement aggregate. */ - runTime: boolean + aggregate: boolean /** - * Require tasks average run time. + * Requires measurement average. */ - avgRunTime: boolean + average: boolean /** - * Require tasks median run time. + * Requires measurement median. */ - medRunTime: boolean + median: boolean +} + +/** + * Pool worker node worker usage statistics requirements. + * + * @internal + */ +export interface TaskStatisticsRequirements { + /** + * Tasks runtime requirements. + */ + readonly runTime: MeasurementStatisticsRequirements + /** + * Tasks wait time requirements. + */ + readonly waitTime: MeasurementStatisticsRequirements + /** + * Tasks event loop utilization requirements. + */ + readonly elu: MeasurementStatisticsRequirements +} + +/** + * Strategy policy. + * + * @internal + */ +export interface StrategyPolicy { + /** + * Expects direct usage of 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 }