(feature) auth arg management

Author: f3rno

CHANGELOG

@@ -1,3 +1,9 @@
+4.0.5
+- WSv2: add auth arg management (pre-set dms and calc)
+- WSv2: add updateAthArgs()
+- WSv2: add getAuthArgs()
+- WS2Manager: fix auth args handling with new methods
+
 4.0.4
 - Orderbook: generate and update book using lossless string format
   in order to prevent floating point precision checksum errors:

lib/transports/ws2.js

@@ -12,6 +12,7 @@ const _isString = require('lodash/isString')
 const _includes = require('lodash/includes')
 const _pick = require('lodash/pick')
 const _isEqual = require('lodash/isEqual')
+const _isFinite = require('lodash/isFinite')
 const { genAuthSig, nonce } = require('bfx-api-node-util')
 const getMessagePayload = require('../util/ws2')
 const LosslessJSON = require('lossless-json')
@@ -107,6 +108,7 @@ class WSv2 extends EventEmitter {
     this._orderBooks = {}
     this._losslessOrderBooks = {}
     this._candles = {}
+    this._authArgs = {}
 
     /**
      * {
@@ -144,6 +146,17 @@ class WSv2 extends EventEmitter {
     this._sendCalc = _Throttle(this._sendCalc.bind(this), 1000 / MAX_CALC_OPS)
   }
 
+  updateAuthArgs (args = {}) {
+    this._authArgs = {
+      ...this._authArgs,
+      ...args
+    }
+  }
+
+  getAuthArgs () {
+    return this._authArgs
+  }
+
   setAPICredentials (apiKey, apiSecret) {
     this._apiKey = apiKey
     this._apiSecret = apiSecret
@@ -259,7 +272,7 @@ class WSv2 extends EventEmitter {
    * @param {number?} dms - optional dead man switch flag, active 4
    * @return {Promise} p
    */
-  auth (calc = 0, dms = 0) {
+  auth (calc, dms) {
     if (!this._isOpen) return Promise.reject(new Error('not open'))
     if (this._isAuthenticated) {
       return Promise.reject(new Error('already authenticated'))
@@ -268,6 +281,10 @@ class WSv2 extends EventEmitter {
     const authNonce = nonce()
     const authPayload = `AUTH${authNonce}${authNonce}`
     const { sig } = genAuthSig(this._apiSecret, authPayload)
+    const authArgs = { ...this._authArgs }
+
+    if (_isFinite(calc)) authArgs.calc = calc
+    if (_isFinite(dms)) authArgs.dms = dms
 
     return new Promise((resolve, reject) => {
       this.once('auth', () => {
@@ -281,8 +298,7 @@ class WSv2 extends EventEmitter {
         authSig: sig,
         authPayload,
         authNonce,
-        dms,
-        calc
+        ...authArgs
       })
     })
   }

lib/ws2_manager.js

@@ -51,6 +51,8 @@ class WS2Manager extends EventEmitter {
       ...this._authArgs,
       ...args
     }
+
+    this._sockets.forEach(socket => socket.ws.updateAuthArgs(this._authArgs))
   }
 
   /**
@@ -127,7 +129,8 @@ class WS2Manager extends EventEmitter {
     this._sockets.forEach(s => {
       if (!s.ws.isAuthenticated()) {
         s.ws.setAuthCredentials(apiKey, apiSecret)
-        s.ws.auth({ calc, dms })
+        s.ws.updateAuthArgs(this._authArgs)
+        s.ws.auth()
       }
     })
   }
@@ -141,14 +144,14 @@ class WS2Manager extends EventEmitter {
    */
   openSocket () {
     const { apiKey, apiSecret } = this._socketArgs
-    const { calc, dms } = this._authArgs
     const ws = new WSv2(this._socketArgs)
     const wsState = {
       pendingSubscriptions: [],
       pendingUnsubscriptions: [],
       ws
     }
 
+    ws.updateAuthArgs(this._authArgs)
     ws.on('open', () => this.emit('open', ws))
     ws.on('message', (msg = {}) => this.emit('message', msg, ws))
     ws.on('error', (error) => this.emit('error', error, ws))
@@ -194,7 +197,7 @@ class WS2Manager extends EventEmitter {
       ws.once('open', () => {
         debug('authenticating socket...')
 
-        ws.auth(calc, dms).then(() => {
+        ws.auth().then(() => {
           debug('socket authenticated')
         }).catch((err) => {
           debug('error authenticating socket: %s', err.message)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitfinex-api-node",
-  "version": "4.0.4",
+  "version": "4.0.5",
   "description": "Node reference library for Bitfinex API",
   "engines": {
     "node": ">=7"

test/lib/transports/ws2-unit.js

@@ -5,6 +5,7 @@ const assert = require('assert')
 const WSv2 = require('../../../lib/transports/ws2')
 const { MockWSv2Server } = require('bfx-api-mock-srv')
 const _isObject = require('lodash/isObject')
+const _isEmpty = require('lodash/isEmpty')
 
 const API_KEY = 'dummy'
 const API_SECRET = 'dummy'
@@ -805,7 +806,7 @@ describe('WSv2 channel msg handling', () => {
       if (++errorsSeen === 2) done()
     })
 
-    let obMsg = [42, [100, 0, 1]]
+    const obMsg = [42, [100, 0, 1]]
     wsTransform._handleOBMessage(obMsg, wsTransform._channelMap[42], JSON.stringify(obMsg))
     wsNoTransform._handleOBMessage(obMsg, wsNoTransform._channelMap[42], JSON.stringify(obMsg))
   })
@@ -830,7 +831,7 @@ describe('WSv2 channel msg handling', () => {
       if (++seen === 2) done()
     })
 
-    let obMsg = [42, [[100, 2, 3]]]
+    const obMsg = [42, [[100, 2, 3]]]
     ws._handleOBMessage(obMsg, ws._channelMap[42], JSON.stringify(obMsg))
   })
 
@@ -869,7 +870,7 @@ describe('WSv2 channel msg handling', () => {
       if (++seen === 2) done()
     })
 
-    let obMsg = [42, [[100, 2, 3]]]
+    const obMsg = [42, [[100, 2, 3]]]
     ws._handleOBMessage(obMsg, ws._channelMap[42], JSON.stringify(obMsg))
     ws._handleOBMessage(obMsg, ws._channelMap[42], JSON.stringify(obMsg))
   })
@@ -889,7 +890,7 @@ describe('WSv2 channel msg handling', () => {
       done()
     })
 
-    let obMsg = [42, [[100, 2, 3]]]
+    const obMsg = [42, [[100, 2, 3]]]
     ws._handleOBMessage(obMsg, ws._channelMap[42], JSON.stringify(obMsg))
   })
 
@@ -911,7 +912,7 @@ describe('WSv2 channel msg handling', () => {
       done()
     })
 
-    let obMsg = [42, [[100, 2, 3]]]
+    const obMsg = [42, [[100, 2, 3]]]
     ws._handleOBMessage(obMsg, ws._channelMap[42], obMsg)
   })
 
@@ -1716,3 +1717,40 @@ describe('resubscribePreviousChannels', () => {
     assert(subBook)
   })
 })
+
+describe('WSv2 auth args', () => {
+  it('provides getAuthArgs to read args', () => {
+    const ws = new WSv2()
+    ws.updateAuthArgs({ dms: 4 })
+    assert.strictEqual(ws.getAuthArgs().dms, 4)
+  })
+
+  it('initializes to empty args set', () => {
+    const ws = new WSv2()
+    const initAuthArgs = ws.getAuthArgs()
+
+    assert(_isObject(initAuthArgs) && _isEmpty(initAuthArgs))
+  })
+
+  it('updates auth args with setAuthArgs', async () => {
+    const ws = new WSv2()
+    const wss = new MockWSv2Server()
+    let sendCalled = false
+
+    await ws.open()
+
+    ws.updateAuthArgs({ dms: 4 })
+    assert.strictEqual(ws.getAuthArgs().dms, 4)
+
+    ws.send = (payload) => {
+      assert.strictEqual(payload.dms, 4)
+      sendCalled = true
+      ws.emit('auth')
+    }
+
+    await ws.auth()
+    assert(sendCalled)
+
+    wss.close()
+  })
+})