fix(v3.1.3, #600): handle risk of circular reference in WS API Client exception handler

Author: tiagosiebler

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "binance",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "Professional Node.js & JavaScript SDK for Binance REST APIs & WebSockets, with TypeScript & end-to-end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package.json

@@ -1,4 +1,5 @@
 import { AxiosRequestConfig } from 'axios';
+import { ClientRequestArgs } from 'http';
 import WebSocket from 'isomorphic-ws';
 
 import { RestClientOptions } from '../../util/requestUtils';
@@ -168,7 +169,7 @@ export interface WSClientConfigurableOptions {
   wsOptions?: {
     protocols?: string[];
     agent?: any;
-  };
+  } & Partial<WebSocket.ClientOptions | ClientRequestArgs>;
 
   wsUrl?: string;
 

src/types/websockets/ws-general.ts

@@ -1237,7 +1237,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);
+          }
         });
     }
   }