Merge pull request #96 from JJ-Cro/master

fix(2.3.1): improve error handling in WebSocket client, fix circular error

Author: tiagosiebler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "kucoin-api",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Complete & robust Node.js SDK for Kucoin's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "scripts": {
     "clean": "rm -rf dist",

package.json

@@ -279,7 +279,17 @@ export class WebsocketAPIClient {
           console.info(new Date(), 'ws has authenticated ', data?.wsKey);
         })
         .on('exception', (data) => {
-          console.error(new Date(), 'ws exception: ', JSON.stringify(data));
+          try {
+            // Blind JSON.stringify can fail on circular references
+            console.error(
+              new Date(),
+              'ws exception: ',
+              JSON.stringify(data),
+              // JSON.stringify({ ...data, target: 'WebSocket' }),
+            );
+          } catch {
+            console.error(new Date(), 'ws exception: ', data);
+          }
         });
     }
   }

src/WebsocketAPIClient.ts

@@ -461,7 +461,10 @@ export abstract class BaseWebsocketClient<
         return { wsKey, ws: this.wsStore.getWs(wsKey)! };
       }
 
-      if (this.wsStore.isConnectionAttemptInProgress(wsKey)) {
+      if (
+        // Important: don't check for RECONNECTING here, or this clashes with reconnectWithDelay()!
+        this.wsStore.isConnectionState(wsKey, WsConnectionStateEnum.CONNECTING)
+      ) {
         this.logger.error(
           'Refused to connect to ws, connection attempt already active',
           { ...WS_LOGGER_CATEGORY, wsKey },