packages/docs-core/lib/Realtime/WebsocketState.ts

   1 const MinimumJitterFactor = 1
   2 const MaximumJitterFactor = 1.5
   3 const MaxBackoffInMilliseconds = 32_000
   4
   5 /**
   6  * If the connection is still connected after this time, reset backoff attempts. This is to avoid cases where a conneciton open then quickly shutters, which would bypass increasing exponentinal backoff. Instead, we wait this interval before deciding to reset connection attempts
   7  */
   8 const BackoffResetThresholdInMilliseconds = 10_000
   9
  10 export interface WebsocketStateInterface {
  11   didOpen(): void
  12   didFailToFetchToken(): void
  13   didClose(): void
  14   isConnected: boolean
  15   getBackoff(): number
  16   destroy(): void
  17 }
  18
  19 export class WebsocketState implements WebsocketStateInterface {
  20   private attempts = 0
  21   private connected: boolean = false
  22   private resetTimeout: ReturnType<typeof setTimeout> | null = null
  23
  24   didOpen() {
  25     this.connected = true
  26
  27     if (this.resetTimeout) {
  28       clearTimeout(this.resetTimeout)
  29     }
  30
  31     this.resetTimeout = setTimeout(() => {
  32       if (this.connected) {
  33         this.resetAttempts()
  34       }
  35     }, BackoffResetThresholdInMilliseconds)
  36   }
  37
  38   destroy() {
  39     if (this.resetTimeout) {
  40       clearTimeout(this.resetTimeout)
  41     }
  42   }
  43
  44   didFailToFetchToken() {
  45     this.incrementAttempts()
  46   }
  47
  48   didClose() {
  49     this.connected = false
  50
  51     this.incrementAttempts()
  52   }
  53
  54   get isConnected(): boolean {
  55     return this.connected
  56   }
  57
  58   getBackoff(): number {
  59     return this.getBackoffWithoutJitter() * this.getJitterFactor()
  60   }
  61
  62   getBackoffWithoutJitter(): number {
  63     const exponent = Math.max(this.attempts, 1)
  64     const backoff = Math.pow(2, exponent) * 1000
  65
  66     return Math.min(backoff, MaxBackoffInMilliseconds)
  67   }
  68
  69   getJitterFactor(): number {
  70     return Math.random() * (MaximumJitterFactor - MinimumJitterFactor) + MinimumJitterFactor
  71   }
  72
  73   get attemptCount(): number {
  74     return this.attempts
  75   }
  76
  77   incrementAttempts() {
  78     this.attempts++
  79   }
  80
  81   resetAttempts() {
  82     this.attempts = 0
  83   }
  84 }