fix: constrain maximum timeout value (#3163)

fix: constrain maxiumum timeout value

Add a setting to allow constraining the timeout value to a maximum.

Author: achingbrain

packages/utils/src/adaptive-timeout.ts

@@ -6,7 +6,9 @@ import type { ClearableSignal } from 'any-signal'
 
 export const DEFAULT_TIMEOUT_MULTIPLIER = 1.2
 export const DEFAULT_FAILURE_MULTIPLIER = 2
-export const DEFAULT_MIN_TIMEOUT = 5000
+export const DEFAULT_MIN_TIMEOUT = 5_000
+export const DEFAULT_MAX_TIMEOUT = 60_000
+export const DEFAULT_INTERVAL = 5_000
 
 export interface AdaptiveTimeoutSignal extends ClearableSignal {
   start: number
@@ -20,6 +22,7 @@ export interface AdaptiveTimeoutInit {
   timeoutMultiplier?: number
   failureMultiplier?: number
   minTimeout?: number
+  maxTimeout?: number
 }
 
 export interface GetTimeoutSignalOptions {
@@ -35,14 +38,17 @@ export class AdaptiveTimeout {
   private readonly timeoutMultiplier: number
   private readonly failureMultiplier: number
   private readonly minTimeout: number
+  private readonly maxTimeout: number
 
   constructor (init: AdaptiveTimeoutInit = {}) {
-    this.success = new MovingAverage(init.interval ?? 5000)
-    this.failure = new MovingAverage(init.interval ?? 5000)
-    this.next = new MovingAverage(init.interval ?? 5000)
+    const interval = init.interval ?? DEFAULT_INTERVAL
+    this.success = new MovingAverage(interval)
+    this.failure = new MovingAverage(interval)
+    this.next = new MovingAverage(interval)
     this.failureMultiplier = init.failureMultiplier ?? DEFAULT_FAILURE_MULTIPLIER
     this.timeoutMultiplier = init.timeoutMultiplier ?? DEFAULT_TIMEOUT_MULTIPLIER
     this.minTimeout = init.minTimeout ?? DEFAULT_MIN_TIMEOUT
+    this.maxTimeout = init.maxTimeout ?? DEFAULT_MAX_TIMEOUT
 
     if (init.metricName != null) {
       this.metric = init.metrics?.registerMetricGroup(init.metricName)
@@ -52,10 +58,16 @@ export class AdaptiveTimeout {
   getTimeoutSignal (options: GetTimeoutSignalOptions = {}): AdaptiveTimeoutSignal {
     // calculate timeout for individual peers based on moving average of
     // previous successful requests
-    const timeout = Math.max(
-      Math.round(this.next.movingAverage * (options.timeoutFactor ?? this.timeoutMultiplier)),
-      this.minTimeout
-    )
+    let timeout = Math.round(this.next.movingAverage * (options.timeoutFactor ?? this.timeoutMultiplier))
+
+    if (timeout < this.minTimeout) {
+      timeout = this.minTimeout
+    }
+
+    if (timeout > this.maxTimeout) {
+      timeout = this.maxTimeout
+    }
+
     const sendTimeout = AbortSignal.timeout(timeout)
     const timeoutSignal = anySignal([options.signal, sendTimeout]) as AdaptiveTimeoutSignal
     setMaxListeners(Infinity, timeoutSignal, sendTimeout)

packages/utils/test/adaptive-timeout.spec.ts

@@ -107,4 +107,41 @@ describe('adaptive-timeout', () => {
 
     adaptiveTimeout.cleanUp(signal)
   })
+
+  it('should have a minimum timeout', () => {
+    const adaptiveTimeout = new AdaptiveTimeout({
+      minTimeout: 10_000
+    })
+
+    const signal1 = adaptiveTimeout.getTimeoutSignal()
+    adaptiveTimeout.cleanUp(signal1)
+
+    const signal2 = adaptiveTimeout.getTimeoutSignal()
+    adaptiveTimeout.cleanUp(signal2)
+
+    const signal3 = adaptiveTimeout.getTimeoutSignal()
+    adaptiveTimeout.cleanUp(signal3)
+
+    expect(signal3).to.have.property('timeout', 10_000)
+  })
+
+  it('should have a maximum timeout', () => {
+    const adaptiveTimeout = new AdaptiveTimeout({
+      maxTimeout: 10_000
+    })
+
+    const signal1 = adaptiveTimeout.getTimeoutSignal()
+    clock.tick(20_000)
+    adaptiveTimeout.cleanUp(signal1)
+
+    const signal2 = adaptiveTimeout.getTimeoutSignal()
+    clock.tick(20_000)
+    adaptiveTimeout.cleanUp(signal2)
+
+    const signal3 = adaptiveTimeout.getTimeoutSignal()
+    clock.tick(20_000)
+    adaptiveTimeout.cleanUp(signal3)
+
+    expect(signal3).to.have.property('timeout', 10_000)
+  })
 })