@wireapp/api-client 27.94.4 → 27.94.5

package/lib/tcp/ReconnectingWebsocket.d.ts

@@ -34,6 +34,7 @@ export declare class ReconnectingWebsocket {
     private readonly stopBackFromSleepHandler?;
     private isPingingEnabled;
     private readonly pendingHealthChecks;
+    private lastMessageTimestamp;
     constructor(onReconnect: () => Promise<string>, options?: {
         pingInterval?: number;
     });
@@ -49,7 +50,16 @@ export declare class ReconnectingWebsocket {
     send(message: any): void;
     getState(): WEBSOCKET_STATE;
     /**
-     * Lightweight health probe that sends a single ping and resolves with whether a pong was received in time.
+     * Lightweight health probe that intelligently determines connection health.
+     *
+     * If the WebSocket is actively processing messages (i.e., received a message within the last 5 seconds),
+     * it considers the connection healthy without sending a ping, as message processing
+     * indicates the connection is working properly.
+     *
+     * If the WebSocket is idle, it sends a ping and expects a pong within the timeout.
+     * This approach prevents false failures during high-load scenarios where pong responses
+     * get queued behind many other messages.
+     *
      * Does not close or reconnect the socket; callers can decide how to react to failures.
      */
     checkHealth(timeoutMs?: number): Promise<boolean>;

package/lib/tcp/ReconnectingWebsocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ReconnectingWebsocket.d.ts","sourceRoot":"","sources":["../../src/tcp/ReconnectingWebsocket.ts"],"names":[],"mappings":"AAoBA,OAAY,EAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAU,MAAM,wBAAwB,CAAC;AAQnF,oBAAY,cAAc;IACxB,cAAc,OAAO;IACrB,UAAU,OAAO;IACjB,cAAc,OAAO;IACrB,gBAAgB,OAAO;CACxB;AAED,oBAAY,eAAe;IACzB,UAAU,IAAI;IACd,IAAI,IAAI;IACR,OAAO,IAAI;IACX,MAAM,IAAI;CACX;AAED,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,qBAAa,qBAAqB;IA8B9B,OAAO,CAAC,QAAQ,CAAC,WAAW;IA7B9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAQ1C;IAEF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,MAAM,CAAC,CAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,iBAAiB,CAAU;IACnC,OAAO,CAAC,MAAM,CAAC,CAAyB;IACxC,OAAO,CAAC,SAAS,CAAC,CAAyB;IAC3C,OAAO,CAAC,OAAO,CAAC,CAA8B;IAC9C,OAAO,CAAC,OAAO,CAAC,CAA8B;IAC9C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAa;IAEvD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA2C;gBAG5D,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACnD,OAAO,GAAE;QACP,YAAY,CAAC,EAAE,MAAM,CAAC;KAClB;IA+BR,OAAO,CAAC,QAAQ,CAAC,eAAe,CAK9B;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAchC;IAEF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAQ7B;IAEF,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAQlC;IAEF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAO9B;IAEF,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAgBvB;IAEK,OAAO,IAAI,IAAI;IAQf,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAIxB,QAAQ,IAAI,eAAe;IAIlC;;;OAGG;IACI,WAAW,CAAC,SAAS,SAAmC,GAAG,OAAO,CAAC,OAAO,CAAC;IAqB3E,UAAU,CAAC,MAAM,SAAqB,GAAG,IAAI;IASpD;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO;IAMf,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,0BAA0B;IAK3B,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI;IAI/C,YAAY,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIrD,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,IAAI;IAItD,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,IAAI;IAItD,cAAc,IAAI,IAAI;CAI9B"}
+{"version":3,"file":"ReconnectingWebsocket.d.ts","sourceRoot":"","sources":["../../src/tcp/ReconnectingWebsocket.ts"],"names":[],"mappings":"AAoBA,OAAY,EAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAU,MAAM,wBAAwB,CAAC;AAQnF,oBAAY,cAAc;IACxB,cAAc,OAAO;IACrB,UAAU,OAAO;IACjB,cAAc,OAAO;IACrB,gBAAgB,OAAO;CACxB;AAED,oBAAY,eAAe;IACzB,UAAU,IAAI;IACd,IAAI,IAAI;IACR,OAAO,IAAI;IACX,MAAM,IAAI;CACX;AAED,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,qBAAa,qBAAqB;IA+B9B,OAAO,CAAC,QAAQ,CAAC,WAAW;IA9B9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAQ1C;IAEF,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IACxC,OAAO,CAAC,MAAM,CAAC,CAAM;IACrB,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,iBAAiB,CAAU;IACnC,OAAO,CAAC,MAAM,CAAC,CAAyB;IACxC,OAAO,CAAC,SAAS,CAAC,CAAyB;IAC3C,OAAO,CAAC,OAAO,CAAC,CAA8B;IAC9C,OAAO,CAAC,OAAO,CAAC,CAA8B;IAC9C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAa;IAEvD,OAAO,CAAC,gBAAgB,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAA2C;IAC/E,OAAO,CAAC,oBAAoB,CAAK;gBAGd,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EACnD,OAAO,GAAE;QACP,YAAY,CAAC,EAAE,MAAM,CAAC;KAClB;IA+BR,OAAO,CAAC,QAAQ,CAAC,eAAe,CAK9B;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAehC;IAEF,OAAO,CAAC,QAAQ,CAAC,cAAc,CAQ7B;IAEF,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAQlC;IAEF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAO9B;IAEF,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAgBvB;IAEK,OAAO,IAAI,IAAI;IAQf,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAIxB,QAAQ,IAAI,eAAe;IAIlC;;;;;;;;;;;;OAYG;IACI,WAAW,CAAC,SAAS,SAAoC,GAAG,OAAO,CAAC,OAAO,CAAC;IAmC5E,UAAU,CAAC,MAAM,SAAqB,GAAG,IAAI;IASpD;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO;IAMf,OAAO,CAAC,wBAAwB;IAIhC,OAAO,CAAC,0BAA0B;IAK3B,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI;IAI/C,YAAY,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIrD,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,IAAI;IAItD,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,GAAG,IAAI;IAItD,cAAc,IAAI,IAAI;CAI9B"}

package/lib/tcp/ReconnectingWebsocket.js

@@ -96,6 +96,7 @@ class ReconnectingWebsocket {
     stopBackFromSleepHandler;
     isPingingEnabled = true;
     pendingHealthChecks = new Set();
+    lastMessageTimestamp = 0;
     constructor(onReconnect, options = {}) {
         this.onReconnect = onReconnect;
         this.logger = commons_1.LogFactory.getLogger('@wireapp/api-client/tcp/ReconnectingWebsocket');
@@ -139,6 +140,7 @@ class ReconnectingWebsocket {
             this.resolvePendingHealthChecks(true);
             return;
         }
+        this.lastMessageTimestamp = Date.now();
         this.onMessage?.(data);
     };
     internalOnOpen = (event) => {
@@ -207,16 +209,34 @@ class ReconnectingWebsocket {
         return this.socket ? this.socket.readyState : WEBSOCKET_STATE.CLOSED;
     }
     /**
-     * Lightweight health probe that sends a single ping and resolves with whether a pong was received in time.
+     * Lightweight health probe that intelligently determines connection health.
+     *
+     * If the WebSocket is actively processing messages (i.e., received a message within the last 5 seconds),
+     * it considers the connection healthy without sending a ping, as message processing
+     * indicates the connection is working properly.
+     *
+     * If the WebSocket is idle, it sends a ping and expects a pong within the timeout.
+     * This approach prevents false failures during high-load scenarios where pong responses
+     * get queued behind many other messages.
+     *
      * Does not close or reconnect the socket; callers can decide how to react to failures.
      */
-    checkHealth(timeoutMs = commons_1.TimeUtil.TimeInMillis.SECOND * 5) {
+    checkHealth(timeoutMs = commons_1.TimeUtil.TimeInMillis.SECOND * 10) {
         if (!this.socket || this.getState() !== WEBSOCKET_STATE.OPEN) {
             return Promise.resolve(false);
         }
+        const now = Date.now();
+        const timeSinceLastMessage = now - this.lastMessageTimestamp;
+        // If we're actively processing messages during the last 5 seconds, consider the connection healthy
+        if (timeSinceLastMessage < commons_1.TimeUtil.TimeInMillis.SECOND * 5) {
+            this.logger.debug(`WebSocket is actively processing messages (last: ${timeSinceLastMessage}ms ago), considering healthy`);
+            return Promise.resolve(true);
+        }
+        // If idle, use ping/pong to verify connection
         return new Promise(resolve => {
             const timeoutId = setTimeout(() => {
                 this.pendingHealthChecks.delete(resolveHealthCheck);
+                this.logger.debug('Health check timeout - no pong received within timeout');
                 resolve(false);
             }, timeoutMs);
             const resolveHealthCheck = (isHealthy) => {
@@ -224,6 +244,7 @@ class ReconnectingWebsocket {
                 resolve(isHealthy);
             };
             this.pendingHealthChecks.add(resolveHealthCheck);
+            this.logger.debug('WebSocket is idle, sending ping for health check');
             this.send(PingMessage.PING);
         });
     }

package/package.json

@@ -70,6 +70,6 @@
     "watch": "webpack serve --config webpack.browser.js",
     "prepare": "yarn dist"
   },
-  "version": "27.94.4",
-  "gitHead": "eab357ab39f8e67e29e2067f67a9c83be67bd719"
+  "version": "27.94.5",
+  "gitHead": "33c5cf3c92492ab2f930c87a4272d75982fc8385"
 }