feat(#141): integrate automatic reconnection workflow when upgrade/please-reconnect notice arrives

Author: tiagosiebler

src/util/BaseWSClient.ts

@@ -449,6 +449,37 @@ export abstract class BaseWebsocketClient<
     });
   }
 
+  /**
+   * Closes a connection, if it's even open. If open, this will trigger a reconnect asynchronously.
+   * If closed, trigger a reconnect immediately
+   */
+  public executeReconnectableClose(wsKey: TWSKey, reason: string) {
+    this.logger.info(`${reason} - closing socket to reconnect`, {
+      ...WS_LOGGER_CATEGORY,
+      wsKey,
+      reason,
+    });
+
+    this.clearTimers(wsKey);
+
+    const wasOpen = this.wsStore.isWsOpen(wsKey);
+    if (wasOpen) {
+      safeTerminateWs(this.wsStore.getWs(wsKey), true);
+    }
+
+    if (!wasOpen) {
+      this.logger.info(
+        `${reason} - socket already closed - trigger immediate reconnect`,
+        {
+          ...WS_LOGGER_CATEGORY,
+          wsKey,
+          reason,
+        },
+      );
+      this.reconnectWithDelay(wsKey, this.options.reconnectTimeout);
+    }
+  }
+
   public isConnected(wsKey: TWSKey): boolean {
     return this.wsStore.isConnectionState(
       wsKey,

src/websocket-client.ts

@@ -704,6 +704,31 @@ export class WebsocketClient extends BaseWebsocketClient<
         return results;
       }
 
+      if (msg.event === 'notice') {
+        const WSNOTICE = {
+          CLOSING_FOR_UPGRADE_RECOMMEND_RECONNECT: '64008',
+        };
+        if (msg?.code === WSNOTICE.CLOSING_FOR_UPGRADE_RECOMMEND_RECONNECT) {
+          const closeReason = `Received notice (${msg.code} - "${msg?.msg}") - closing socket to reconnect`;
+          this.logger.info(closeReason, {
+            ...WS_LOGGER_CATEGORY,
+            ...msg,
+            wsKey,
+          });
+
+          // Queue immediate reconnection workflow
+          this.executeReconnectableClose(wsKey, closeReason);
+
+          // Emit notice to client for visibility
+          results.push({
+            eventType: 'update',
+            event: emittableEvent,
+          });
+
+          return results;
+        }
+      }
+
       this.logger.info('Unhandled/unrecognised ws event message', {
         ...WS_LOGGER_CATEGORY,
         message: msg || 'no message',