Adds backoff to minimum interval between successfull connects

Author: paulocsanz

README.md

@@ -103,8 +103,10 @@ wsOpts = {
   awareness: new awarenessProtocol.Awareness(ydoc),
   // Specify the maximum amount to wait between reconnects (we use exponential backoff).
   maxBackoffTime: 2500
-  // Specify the minimum amount to wait between reconnects if the previous connection succeeded but got closed right after.
-  minRetryInterval: 2500
+  // Specify the maximum amount to wait between reconnects if previous connection succeeded (we use exponential backoff).
+  // This prevents connections that close right after their successful creation from being retried immediately.
+  // Backoff only resets when a connection has been open for `maxBackoffIntervalOnSuccessfulConnects` ms
+  maxBackoffIntervalOnSuccessfulConnects: 2500
 }
 ```
 

dist/src/y-websocket.d.ts

@@ -35,10 +35,10 @@ export class WebsocketProvider extends ObservableV2<{
      * @param {typeof WebSocket} [opts.WebSocketPolyfill] Optionall provide a WebSocket polyfill
      * @param {number} [opts.resyncInterval] Request server state every `resyncInterval` milliseconds
      * @param {number} [opts.maxBackoffTime] Maximum amount of time to wait before trying to reconnect (we try to reconnect using exponential backoff)
-     * @param {number} [opts.minRetryInterval] Minimum mount of time to wait between reconnects if the previous connection succeeded but got closed right after.
+     * @param {number} [opts.maxBackoffIntervalOnSuccessfulConnects] Maximum amount of time to wait before trying to reconnect if previous connection succeeded (we try to reconnect using exponential backoff). Backoff only resets after a connection has been open for `maxBackoffIntervalOnSuccessfulConnects` ms
      * @param {boolean} [opts.disableBc] Disable cross-tab BroadcastChannel communication
      */
-    constructor(serverUrl: string, roomname: string, doc: Y.Doc, { connect, awareness, params, protocols, WebSocketPolyfill, resyncInterval, maxBackoffTime, minRetryInterval, disableBc }?: {
+    constructor(serverUrl: string, roomname: string, doc: Y.Doc, { connect, awareness, params, protocols, WebSocketPolyfill, resyncInterval, maxBackoffTime, maxBackoffIntervalOnSuccessfulConnects, disableBc }?: {
         connect?: boolean | undefined;
         awareness?: awarenessProtocol.Awareness | undefined;
         params?: {
@@ -55,13 +55,13 @@ export class WebsocketProvider extends ObservableV2<{
         } | undefined;
         resyncInterval?: number | undefined;
         maxBackoffTime?: number | undefined;
-        minRetryInterval?: number | undefined;
+        maxBackoffIntervalOnSuccessfulConnects?: number | undefined;
         disableBc?: boolean | undefined;
     });
     serverUrl: string;
     bcChannel: string;
     maxBackoffTime: number;
-    minRetryInterval: number;
+    maxBackoffIntervalOnSuccessfulConnects: number;
     /**
      * The specified url parameters. This can be safely updated. The changed parameters will be used
      * when a new connection is established.
@@ -88,6 +88,7 @@ export class WebsocketProvider extends ObservableV2<{
     disableBc: boolean;
     wsUnsuccessfulReconnects: number;
     lastConnectAt: any;
+    wsSubsequentConnects: number;
     messageHandlers: ((arg0: encoding.Encoder, arg1: decoding.Decoder, arg2: WebsocketProvider, arg3: boolean, arg4: number) => void)[];
     /**
      * @type {boolean}

dist/y-websocket.cjs

@@ -201,14 +201,21 @@ const closeWebsocketConnection = (provider, ws, event) => {
  * @param {WebsocketProvider} provider
  */
 const setupWS = (provider) => {
-  const timeout = provider.lastConnectAt ? Date.now() - provider.lastConnectAt.getTime() : provider.minRetryInterval;
-  if (timeout < provider.minRetryInterval && provider.wsUnsuccessfulReconnects === 0) {
+  // Start with 100ms interval between successful connects and increase with exponential backoff
+  const backoff = math__namespace.min(math__namespace.pow(2, provider.wsSubsequentConnects) * 50, provider.maxBackoffIntervalOnSuccessfulConnects);
+  const timeout = provider.lastConnectAt ? Date.now() - provider.lastConnectAt.getTime() : backoff;
+  if (timeout < backoff) {
+    console.log(`Backoff: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt }, null, 2)}`);
     setTimeout(setupWS, timeout, provider);
-    return
+    return;
+  } else if (timeout > provider.maxBackoffIntervalOnSuccessfulConnects) {
+    console.log(`Reset: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt, max: provider.maxBackoffIntervalOnSuccessfulConnects }, null, 2)}`);
+    provider.wsSubsequentConnects = 0;
   }
 
   if (provider.shouldConnect && provider.ws === null) {
     const websocket = new provider._WS(provider.url, provider.protocols);
+    console.log(`Connect: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt }, null, 2)}`);
     websocket.binaryType = 'arraybuffer';
     provider.ws = websocket;
     provider.wsconnecting = true;
@@ -230,6 +237,8 @@ const setupWS = (provider) => {
     };
     websocket.onopen = () => {
       provider.lastConnectAt = new Date();
+      provider.wsSubsequentConnects++;
+      console.log(`Open: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt }, null, 2)}`);
       provider.wsLastMessageReceived = time__namespace.getUnixTime();
       provider.wsconnecting = false;
       provider.wsconnected = true;
@@ -301,7 +310,7 @@ class WebsocketProvider extends observable.ObservableV2 {
    * @param {typeof WebSocket} [opts.WebSocketPolyfill] Optionall provide a WebSocket polyfill
    * @param {number} [opts.resyncInterval] Request server state every `resyncInterval` milliseconds
    * @param {number} [opts.maxBackoffTime] Maximum amount of time to wait before trying to reconnect (we try to reconnect using exponential backoff)
-   * @param {number} [opts.minRetryInterval] Minimum mount of time to wait between reconnects if the previous connection succeeded but got closed right after.
+   * @param {number} [opts.maxBackoffIntervalOnSuccessfulConnects] Maximum amount of time to wait before trying to reconnect if previous connection succeeded (we try to reconnect using exponential backoff). Backoff only resets after a connection has been open for `maxBackoffIntervalOnSuccessfulConnects` ms
    * @param {boolean} [opts.disableBc] Disable cross-tab BroadcastChannel communication
    */
   constructor (serverUrl, roomname, doc, {
@@ -312,7 +321,7 @@ class WebsocketProvider extends observable.ObservableV2 {
     WebSocketPolyfill = WebSocket,
     resyncInterval = -1,
     maxBackoffTime = 2500,
-    minRetryInterval = 2500,
+    maxBackoffIntervalOnSuccessfulConnects = 2500,
     disableBc = false
   } = {}) {
     super();
@@ -323,7 +332,7 @@ class WebsocketProvider extends observable.ObservableV2 {
     this.serverUrl = serverUrl;
     this.bcChannel = serverUrl + '/' + roomname;
     this.maxBackoffTime = maxBackoffTime;
-    this.minRetryInterval = minRetryInterval;
+    this.maxBackoffIntervalOnSuccessfulConnects = maxBackoffIntervalOnSuccessfulConnects;
     /**
      * The specified url parameters. This can be safely updated. The changed parameters will be used
      * when a new connection is established.
@@ -341,6 +350,7 @@ class WebsocketProvider extends observable.ObservableV2 {
     this.disableBc = disableBc;
     this.wsUnsuccessfulReconnects = 0;
     this.lastConnectAt = null;
+    this.wsSubsequentConnects = 0;
     this.messageHandlers = messageHandlers.slice();
     /**
      * @type {boolean}

dist/y-websocket.cjs.map

@@ -172,14 +172,21 @@ const closeWebsocketConnection = (provider, ws, event) => {
  * @param {WebsocketProvider} provider
  */
 const setupWS = (provider) => {
-  const timeout = provider.lastConnectAt ? Date.now() - provider.lastConnectAt.getTime() : provider.minRetryInterval
-  if (timeout < provider.minRetryInterval && provider.wsUnsuccessfulReconnects === 0) {
+  // Start with 100ms interval between successful connects and increase with exponential backoff
+  const backoff = math.min(math.pow(2, provider.wsSubsequentConnects) * 50, provider.maxBackoffIntervalOnSuccessfulConnects)
+  const timeout = provider.lastConnectAt ? Date.now() - provider.lastConnectAt.getTime() : backoff
+  if (timeout < backoff) {
+    console.log(`Backoff: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt }, null, 2)}`)
     setTimeout(setupWS, timeout, provider)
-    return
+    return;
+  } else if (timeout > provider.maxBackoffIntervalOnSuccessfulConnects) {
+    console.log(`Reset: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt, max: provider.maxBackoffIntervalOnSuccessfulConnects }, null, 2)}`)
+    provider.wsSubsequentConnects = 0
   }
 
   if (provider.shouldConnect && provider.ws === null) {
     const websocket = new provider._WS(provider.url, provider.protocols)
+    console.log(`Connect: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt }, null, 2)}`)
     websocket.binaryType = 'arraybuffer'
     provider.ws = websocket
     provider.wsconnecting = true
@@ -201,6 +208,8 @@ const setupWS = (provider) => {
     }
     websocket.onopen = () => {
       provider.lastConnectAt = new Date()
+      provider.wsSubsequentConnects++
+      console.log(`Open: ${JSON.stringify({ backoff, timeout, wsSubsequentConnects: provider.wsSubsequentConnects, lastConnectAt: provider.lastConnectAt }, null, 2)}`)
       provider.wsLastMessageReceived = time.getUnixTime()
       provider.wsconnecting = false
       provider.wsconnected = true
@@ -272,7 +281,7 @@ export class WebsocketProvider extends ObservableV2 {
    * @param {typeof WebSocket} [opts.WebSocketPolyfill] Optionall provide a WebSocket polyfill
    * @param {number} [opts.resyncInterval] Request server state every `resyncInterval` milliseconds
    * @param {number} [opts.maxBackoffTime] Maximum amount of time to wait before trying to reconnect (we try to reconnect using exponential backoff)
-   * @param {number} [opts.minRetryInterval] Minimum mount of time to wait between reconnects if the previous connection succeeded but got closed right after.
+   * @param {number} [opts.maxBackoffIntervalOnSuccessfulConnects] Maximum amount of time to wait before trying to reconnect if previous connection succeeded (we try to reconnect using exponential backoff). Backoff only resets after a connection has been open for `maxBackoffIntervalOnSuccessfulConnects` ms
    * @param {boolean} [opts.disableBc] Disable cross-tab BroadcastChannel communication
    */
   constructor (serverUrl, roomname, doc, {
@@ -283,7 +292,7 @@ export class WebsocketProvider extends ObservableV2 {
     WebSocketPolyfill = WebSocket,
     resyncInterval = -1,
     maxBackoffTime = 2500,
-    minRetryInterval = 2500,
+    maxBackoffIntervalOnSuccessfulConnects = 2500,
     disableBc = false
   } = {}) {
     super()
@@ -294,7 +303,7 @@ export class WebsocketProvider extends ObservableV2 {
     this.serverUrl = serverUrl
     this.bcChannel = serverUrl + '/' + roomname
     this.maxBackoffTime = maxBackoffTime
-    this.minRetryInterval = minRetryInterval
+    this.maxBackoffIntervalOnSuccessfulConnects = maxBackoffIntervalOnSuccessfulConnects
     /**
      * The specified url parameters. This can be safely updated. The changed parameters will be used
      * when a new connection is established.
@@ -312,6 +321,7 @@ export class WebsocketProvider extends ObservableV2 {
     this.disableBc = disableBc
     this.wsUnsuccessfulReconnects = 0
     this.lastConnectAt = null
+    this.wsSubsequentConnects = 0
     this.messageHandlers = messageHandlers.slice()
     /**
      * @type {boolean}