Add heartbeat option for WebSocket connections (#76)

* Added heartbeat option * Added heartbeat option * fix OrderbookSync test * fix websocket tests * update docs * remove default parameter * new test * cleanup * makes it backward compatible * improve tests and readme
coinbase · Sep 19, 2017 · 86c2987 · 86c2987
1 parent bbbb072
commit 86c2987
Show file tree

Hide file tree

Showing 4 changed files with 109 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -442,6 +442,20 @@ websocket.on('error', err => { /* handle error */ });
 websocket.on('close', () => { /* ... */ });
 ```
 
+Optionally set the heartbeat mode or websocket URI.
+```javascript
+var websocket = new Gdax.WebsocketClient(
+  ['BTC-USD','ETH-USD'],
+  'https://api-public.sandbox.gdax.com',
+  {
+    key: 'suchkey',
+    secret: 'suchsecret',
+    passphrase: 'muchpassphrase',
+  },
+  { heartbeat: true }
+);
+```
+
 The following events can be emitted from the `WebsocketClient`:
 
 - `open`

diff --git a/lib/clients/websocket.js b/lib/clients/websocket.js
@@ -10,7 +10,12 @@ const { signRequest } = require('../../lib/request_signer');
  * @param {Object} [auth] - An optional object containing your API key details (key, secret & passphrase)
  */
 class WebsocketClient extends EventEmitter {
-  constructor(productIDs, websocketURI = 'wss://ws-feed.gdax.com', auth) {
+  constructor(
+    productIDs,
+    websocketURI = 'wss://ws-feed.gdax.com',
+    auth = null,
+    { heartbeat = false } = {}
+  ) {
     super();
     this.productIDs = Utils.determineProductIDs(productIDs);
     this.websocketURI = websocketURI;
@@ -20,6 +25,7 @@ class WebsocketClient extends EventEmitter {
       );
     }
     this.auth = auth || {};
+    this.heartbeat = heartbeat;
     this.connect();
   }
 
@@ -63,12 +69,21 @@ class WebsocketClient extends EventEmitter {
 
     this.socket.send(JSON.stringify(subscribeMessage));
 
-    // Set a 30 second ping to keep connection alive
-    this.pinger = setInterval(() => {
-      if (this.socket) {
-        this.socket.ping('keepalive');
-      }
-    }, 30000);
+    if (this.heartbeat) {
+      // send heartbeat
+      var heartbeatMessage = {
+        type: 'heartbeat',
+        on: true,
+      };
+      this.socket.send(JSON.stringify(heartbeatMessage));
+    } else {
+      // Set a 30 second ping to keep connection alive
+      this.pinger = setInterval(() => {
+        if (this.socket) {
+          this.socket.ping('keepalive');
+        }
+      }, 30000);
+    }
   }
 
   onClose() {

diff --git a/lib/orderbook_sync.js b/lib/orderbook_sync.js
@@ -8,7 +8,8 @@ class OrderbookSync extends WebsocketClient {
     productIDs,
     apiURI = 'https://api.gdax.com',
     websocketURI = 'wss://ws-feed.gdax.com',
-    authenticatedClient
+    authenticatedClient = null,
+    { heartbeat = false } = {}
   ) {
     let auth = null;
     if (authenticatedClient) {
@@ -19,7 +20,7 @@ class OrderbookSync extends WebsocketClient {
       };
     }
 
-    super(productIDs, websocketURI, auth);
+    super(productIDs, websocketURI, auth, { heartbeat });
     this.apiURI = apiURI;
     this.authenticatedClient = authenticatedClient;
 
@@ -46,9 +47,9 @@ class OrderbookSync extends WebsocketClient {
       this._queues[product_id].push(data);
 
       if (this._sequences[product_id] === -2) {
-         // Start first resync
-         this._sequences[product_id] = -1;
-         this.loadOrderbook(product_id);
+        // Start first resync
+        this._sequences[product_id] = -1;
+        this.loadOrderbook(product_id);
       }
     } else {
       this.processMessage(data);

diff --git a/tests/websocket.spec.js b/tests/websocket.spec.js
@@ -131,3 +131,70 @@ suite('WebsocketClient', () => {
     });
   });
 });
+
+test('passes heartbeat details through', done => {
+  let calls = 0;
+  const server = testserver(++port, () => {
+    new Gdax.WebsocketClient(
+      'ETH-USD',
+      'ws://localhost:' + port,
+      {
+        key: 'suchkey',
+        secret: 'suchsecret',
+        passphrase: 'muchpassphrase',
+      },
+      { heartbeat: true }
+    );
+  });
+  server.on('connection', socket => {
+    socket.on('message', data => {
+      const msg = JSON.parse(data);
+      calls++;
+
+      if (msg.type === 'subscribe') {
+        assert.equal(msg.key, 'suchkey');
+        assert.equal(msg.passphrase, 'muchpassphrase');
+        assert(msg.timestamp);
+        assert(msg.signature);
+      } else {
+        assert.equal(msg.type, 'heartbeat');
+        assert.equal(msg.on, true);
+      }
+
+      if (calls > 1) {
+        server.close();
+        done();
+      }
+    });
+  });
+});
+
+test('passes heartbeat details through without authentication details', done => {
+  let calls = 0;
+  const server = testserver(++port, () => {
+    new Gdax.WebsocketClient(
+      ['BTC-USD', 'ETH-USD'],
+      'ws://localhost:' + port,
+      null,
+      { heartbeat: true }
+    );
+  });
+  server.on('connection', socket => {
+    socket.on('message', data => {
+      const msg = JSON.parse(data);
+      calls++;
+
+      if (msg.type === 'subscribe') {
+        assert.deepEqual(msg.product_ids, ['BTC-USD', 'ETH-USD']);
+      } else {
+        assert.equal(msg.type, 'heartbeat');
+        assert.equal(msg.on, true);
+      }
+
+      if (calls > 1) {
+        server.close();
+        done();
+      }
+    });
+  });
+});