bfx-api-node-ws1 1.0.3 → 2.0.0

package/CHANGELOG

@@ -1,3 +1,10 @@
+# 2.0.0
+- Require Node.js >= 22
+- meta: bump ws to 7.5.13, bfx-api-node-util to 2.0.0, lodash to 4.18.1
+- meta: drop debug, unused bluebird and chai
+- meta: remove docs/, jsdoc-to-markdown and Travis config
+- Tests: migrate from mocha to brittle, lint with @bitfinex/lint-js
+
 # 1.0.3
 - fix: use relative paths to allow generic mocha execution
 - feature: add isOpen() method

package/README.md

@@ -1,7 +1,5 @@
 # Bitfinex WSv1 Reference Implementation for Node.JS
 
-[![Build Status](https://travis-ci.org/bitfinexcom/bfx-api-node-ws1.svg?branch=master)](https://travis-ci.org/bitfinexcom/bfx-api-node-ws1)
-
 This repo contains the reference implementation for version 1 of the websocket Bitfinex API. It is deprecated in favour of version 2, and should no longer be used.
 
 For the version 2 API library, see [bitfinex-api-node](https://github.com/bitfinexcom/bitfinex-api-node)
@@ -34,10 +32,6 @@ ws.on('trades', (pair, trade) => {
 })
 ```
 
-### Docs
-
-For JSDoc-generated API documentation, [see `docs/ws1.md`](/docs/ws1.md)
-
 ### Contributing
 
 1. Fork it

package/lib/ws.js

@@ -2,7 +2,7 @@
 
 const { EventEmitter } = require('events')
 const { isSnapshot, genAuthSig } = require('bfx-api-node-util')
-const debug = require('debug')('bfx:api:ws1')
+const debug = require('util').debuglog('bfx:api:ws1')
 const _isArray = require('lodash/isArray')
 const WebSocket = require('ws')
 
@@ -32,7 +32,7 @@ class WSv1 extends EventEmitter {
    * @return {boolean} open
    */
   isOpen () {
-    return this._ws.isOpen()
+    return !!this._ws && this._ws.readyState === WebSocket.OPEN
   }
 
   /**
@@ -291,10 +291,27 @@ class WSv1 extends EventEmitter {
    * @param {*} msg
    */
   send (msg) {
-    debug('Sending %j', msg)
+    debug('Sending %j', this._redact(msg))
     this._ws.send(JSON.stringify(msg))
   }
 
+  /**
+   * Returns a copy of the packet that is safe to log: the api key is masked
+   * to a short prefix and the auth signature is hidden.
+   *
+   * @param {object} msg
+   * @returns {object} safe
+   * @private
+   */
+  _redact (msg) {
+    const safe = { ...msg }
+
+    if (safe.apiKey) safe.apiKey = `${safe.apiKey.slice(0, 5)}***`
+    if (safe.authSig) safe.authSig = '***'
+
+    return safe
+  }
+
   /**
    * Subscribe to order book updates. Snapshot will be sent as multiple updates.
    * Event will be emited as `PAIRNAME_book`.

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "bfx-api-node-ws1",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Legacy WSv1 transport for the Bitfinex Node API",
   "engines": {
-    "node": ">=7"
+    "node": ">=22.0.0"
   },
   "main": "index.js",
   "scripts": {
-    "lint": "standard",
-    "test": "npm run lint && npm run unit",
-    "unit": "NODE_ENV=test mocha -b --recursive",
-    "docs": "npm run ws1_docs",
-    "ws1_docs": "node_modules/jsdoc-to-markdown/bin/cli.js lib/ws.js > docs/ws1_docs.md"
+    "lint": "bfx-lint-js .",
+    "lint:fix": "bfx-lint-js . --fix",
+    "test": "npm run lint && npm run test:unit",
+    "test:unit": "NODE_ENV=test brittle-node --bail 'test/**/*.js'"
   },
   "repository": {
     "type": "git",
@@ -36,17 +35,12 @@
     "url": "https://github.com/bitfinexcom/bfx-api-node-ws1/issues"
   },
   "devDependencies": {
-    "babel-eslint": "^10.0.3",
-    "chai": "^4.2.0",
-    "jsdoc-to-markdown": "^5.0.1",
-    "mocha": "^6.2.0",
-    "standard": "^14.1.0"
+    "@bitfinex/lint-js": "^1.1.0",
+    "brittle": "^4.5.0"
   },
   "dependencies": {
-    "bfx-api-node-util": "^1.0.2",
-    "bluebird": "^3.5.5",
-    "debug": "^4.1.1",
-    "lodash": "^4.17.15",
-    "ws": "^3.0.0"
+    "bfx-api-node-util": "^2.0.0",
+    "lodash": "^4.18.1",
+    "ws": "7.5.13"
   }
 }

package/test/lib/ws-1-handle-channel.js

@@ -1,7 +1,6 @@
-/* eslint-env mocha */
 'use strict'
 
-const assert = require('assert')
+const test = require('brittle')
 const BfxWs = require('../../lib/ws')
 
 const bfxWs = new BfxWs({
@@ -9,41 +8,44 @@ const bfxWs = new BfxWs({
   apiSecret: 'dummy'
 })
 
-describe('ws1 channel msg handling', () => {
-  it('ws1 transforms & normalizes well - R0 update', (done) => {
+test('ws1 channel msg handling', async (t) => {
+  await t.test('ws1 transforms & normalizes well - R0 update', (t) => {
+    t.plan(1)
+
     bfxWs._channelMap = {
       32755: { channel: 'book', prec: 'R0', symbol: 'tBTCUSD' }
     }
 
     bfxWs.once('orderbook', (symbol, data) => {
-      assert.deepStrictEqual(data, { price: 2477.1, orderId: 2919111002, amount: 0.0125 })
-      done()
+      t.alike(data, { price: 2477.1, orderId: 2919111002, amount: 0.0125 })
     })
 
     bfxWs._handleChannel([32755, 2919111002, 2477.1, 0.0125])
   })
 
-  it('ws1 transforms & normalizes well - P1 update', (done) => {
+  await t.test('ws1 transforms & normalizes well - P1 update', (t) => {
+    t.plan(1)
+
     bfxWs._channelMap = {
       182: { channel: 'book', prec: 'P1', symbol: 'tBTCUSD' }
     }
 
     bfxWs.once('orderbook', (symbol, data) => {
-      assert.deepStrictEqual(data, { price: 2494, count: 2, amount: 5.9895 })
-      done()
+      t.alike(data, { price: 2494, count: 2, amount: 5.9895 })
     })
 
     bfxWs._handleChannel([182, 2494, 2, 5.9895])
   })
 
-  it('ws1 transforms & normalizes well - P1 snap', (done) => {
+  await t.test('ws1 transforms & normalizes well - P1 snap', (t) => {
+    t.plan(1)
+
     bfxWs._channelMap = {
       39: { channel: 'book', prec: 'P1', symbol: 'tBTCUSD' }
     }
 
     bfxWs.once('orderbook', (symbol, data) => {
-      assert.deepStrictEqual(data[1], { price: 2494, count: 3, amount: 0.14606853 })
-      done()
+      t.alike(data[1], { price: 2494, count: 3, amount: 0.14606853 })
     })
 
     const snap = [39, [
@@ -55,17 +57,18 @@ describe('ws1 channel msg handling', () => {
     bfxWs._handleChannel(snap)
   })
 
-  it('ws1 transforms & normalizes well - R0 snap', (done) => {
+  await t.test('ws1 transforms & normalizes well - R0 snap', (t) => {
+    t.plan(1)
+
     bfxWs._channelMap = {
       34513: { channel: 'book', prec: 'R0', symbol: 'tBTCUSD' }
     }
 
     bfxWs.once('orderbook', (symbol, data) => {
-      assert.deepStrictEqual(
+      t.alike(
         data[1],
         { price: 2494.5, orderId: 2919279471, amount: 0.07288 }
       )
-      done()
     })
 
     const snap = [34513, [
@@ -76,8 +79,4 @@ describe('ws1 channel msg handling', () => {
 
     bfxWs._handleChannel(snap)
   })
-
-  it('ws1 _handleChannel ignores heartbeats')
-  it('ws1 _processUserEvent emits data, breaks up snapshots')
-  it('ws1 _processTradeEvent emits a single trade for te & tu messages')
 })

package/test/lib/ws-1-parsing.js

@@ -1,20 +1,19 @@
-/* eslint-env mocha */
 'use strict'
 
 const PORT = 1337
 
-const assert = require('assert')
+const test = require('brittle')
 const WebSocket = require('ws')
 const WSv1 = require('../../lib/ws')
 
-describe('websocket1 parsing non json', () => {
+test('websocket1 parsing non json', async (t) => {
   let ws = null
   let wss = null
 
-  afterEach(async () => {
+  const teardown = async () => {
     try { // may fail due to being modified by a test, it's not a problem
       if (ws && ws.isOpen()) {
-        await new Promise(resolve => ws.close(resolve))
+        ws.close()
       }
     } catch (e) {}
 
@@ -25,9 +24,12 @@ describe('websocket1 parsing non json', () => {
     }
 
     wss = null
-  })
+  }
+
+  await t.test('should not crash the client', (t) => {
+    t.teardown(teardown)
+    t.plan(1)
 
-  it('should not crash the client', (done) => {
     ws = new WSv1({
       apiKey: 'dummy',
       apiSecret: 'dummy',
@@ -44,8 +46,7 @@ describe('websocket1 parsing non json', () => {
     wss.on('connection', function connection (ws) {
       ws.on('message', function incoming (msg) {
         msg = JSON.parse(msg)
-        assert.strictEqual(msg.len, '25')
-        done()
+        t.is(msg.len, '25')
       })
 
       ws.send("HTTP Code 408 - I'm a Tea Pot")

package/test/lib/ws-1-test.js

@@ -1,7 +1,6 @@
-/* eslint-env mocha */
 'use strict'
 
-const assert = require('assert')
+const test = require('brittle')
 const WebSocket = require('ws')
 const _isObject = require('lodash/isObject')
 
@@ -16,11 +15,12 @@ const getWSInstance = (args) => (
   })
 )
 
-describe('WebSocket v1 integration', () => {
+test('WebSocket v1 integration', async (t) => {
   let ws = null
   let wss = null
 
-  afterEach(async () => {
+  const opts = { timeout: 10 * 1000 }
+  const teardown = async () => {
     try { // may fail due to being modified by a test, it's not a problem
       if (ws && ws.isOpen()) {
         ws.close()
@@ -34,9 +34,12 @@ describe('WebSocket v1 integration', () => {
     }
 
     wss = null
-  })
+  }
+
+  await t.test('plays ping pong', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(1)
 
-  it('plays ping pong', (done) => {
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -50,11 +53,14 @@ describe('WebSocket v1 integration', () => {
     })
 
     ws.on('open', () => ws.send({ event: 'ping' }))
-    ws.on('pong', () => done())
+    ws.on('pong', () => t.pass())
     ws.open()
   })
 
-  it('should receive info message', (done) => {
+  await t.test('should receive info message', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(4)
+
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -73,17 +79,19 @@ describe('WebSocket v1 integration', () => {
     })
 
     ws.on('info', (data) => {
-      assert(_isObject(data.platform))
-      assert.strictEqual(data.event, 'info')
-      assert.strictEqual(data.version, 1.1)
-      assert.strictEqual(data.platform.status, 1)
-      done()
+      t.ok(_isObject(data.platform))
+      t.is(data.event, 'info')
+      t.is(data.version, 1.1)
+      t.is(data.platform.status, 1)
     })
 
     ws.open()
   })
 
-  it('should emit an error when authorization fails', (done) => {
+  await t.test('should emit an error when authorization fails', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(1)
+
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -98,15 +106,17 @@ describe('WebSocket v1 integration', () => {
     })
 
     ws.on('error', (err) => {
-      assert.strictEqual(err.event, 'auth')
-      done()
+      t.is(err.event, 'auth')
     })
 
     ws.on('open', ws.auth.bind(ws))
     ws.open()
   })
 
-  it('should unsubscribe by channelId', (done) => {
+  await t.test('should unsubscribe by channelId', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(2)
+
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -130,9 +140,8 @@ describe('WebSocket v1 integration', () => {
       const channelId = data.chanId
 
       ws.once('unsubscribed', (data) => {
-        assert.strictEqual(data.status, 'OK')
-        assert.strictEqual(data.chanId, channelId)
-        done()
+        t.is(data.status, 'OK')
+        t.is(data.chanId, channelId)
       })
 
       ws.unsubscribe(channelId)
@@ -142,7 +151,10 @@ describe('WebSocket v1 integration', () => {
     ws.open()
   })
 
-  it('should receive a subscribed success messages', (done) => {
+  await t.test('should receive a subscribed success messages', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(2)
+
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -156,16 +168,18 @@ describe('WebSocket v1 integration', () => {
     })
 
     ws.on('subscribed', (data) => {
-      assert.strictEqual(data.channel, 'trades')
-      assert.strictEqual(data.pair, 'BTCUSD')
-      done()
+      t.is(data.channel, 'trades')
+      t.is(data.pair, 'BTCUSD')
     })
 
     ws.on('open', () => ws.subscribeTrades('BTCUSD'))
     ws.open()
   })
 
-  it('#orderBook data should have the defined fields', (done) => {
+  await t.test('#orderBook data should have the defined fields', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(5)
+
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -189,19 +203,21 @@ describe('WebSocket v1 integration', () => {
 
     ws = getWSInstance({ transform: true })
     ws.once('orderbook', (pair, data) => {
-      assert.strictEqual(pair, 'BTCUSD')
-      assert.strictEqual(typeof data[0].price, 'number')
-      assert.strictEqual(typeof data[0].orderId, 'number')
-      assert.strictEqual(typeof data[0].amount, 'number')
-      assert.strictEqual(data.length, 50)
-      done()
+      t.is(pair, 'BTCUSD')
+      t.is(typeof data[0].price, 'number')
+      t.is(typeof data[0].orderId, 'number')
+      t.is(typeof data[0].amount, 'number')
+      t.is(data.length, 50)
     })
 
     ws.on('open', () => ws.subscribeOrderBook('BTCUSD'))
     ws.open()
-  }).timeout(10 * 1000)
+  })
+
+  await t.test('#ticker data should have the defined fields', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(11)
 
-  it('#ticker data should have the defined fields', (done) => {
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -218,25 +234,27 @@ describe('WebSocket v1 integration', () => {
     ws = getWSInstance()
 
     ws.once('ticker', (pair, data) => {
-      assert.strictEqual(pair, 'BTCUSD')
-      assert.strictEqual(typeof data.bid, 'number')
-      assert.strictEqual(typeof data.bidSize, 'number')
-      assert.strictEqual(typeof data.ask, 'number')
-      assert.strictEqual(typeof data.askSize, 'number')
-      assert.strictEqual(typeof data.dailyChange, 'number')
-      assert.strictEqual(typeof data.dailyChangePerc, 'number')
-      assert.strictEqual(typeof data.lastPrice, 'number')
-      assert.strictEqual(typeof data.volume, 'number')
-      assert.strictEqual(typeof data.high, 'number')
-      assert.strictEqual(typeof data.low, 'number')
-      done()
+      t.is(pair, 'BTCUSD')
+      t.is(typeof data.bid, 'number')
+      t.is(typeof data.bidSize, 'number')
+      t.is(typeof data.ask, 'number')
+      t.is(typeof data.askSize, 'number')
+      t.is(typeof data.dailyChange, 'number')
+      t.is(typeof data.dailyChangePerc, 'number')
+      t.is(typeof data.lastPrice, 'number')
+      t.is(typeof data.volume, 'number')
+      t.is(typeof data.high, 'number')
+      t.is(typeof data.low, 'number')
     })
 
     ws.on('open', () => ws.subscribeTicker('BTCUSD'))
     ws.open()
   })
 
-  it('#trade data should have the defined fields', (done) => {
+  await t.test('#trade data should have the defined fields', opts, (t) => {
+    t.teardown(teardown)
+    t.plan(4)
+
     wss = new WebSocket.Server({
       perMessageDeflate: false,
       port: PORT
@@ -269,14 +287,13 @@ describe('WebSocket v1 integration', () => {
     ws = getWSInstance()
 
     ws.once('trade', (pair, data) => {
-      assert.strictEqual(pair, 'BTCUSD')
-      assert.strictEqual(typeof data[0].timestamp, 'number')
-      assert.strictEqual(typeof data[0].price, 'number')
-      assert.strictEqual(typeof data[0].amount, 'number')
-      done()
+      t.is(pair, 'BTCUSD')
+      t.is(typeof data[0].timestamp, 'number')
+      t.is(typeof data[0].price, 'number')
+      t.is(typeof data[0].amount, 'number')
     })
 
     ws.on('open', () => ws.subscribeTrades('BTCUSD'))
     ws.open()
   })
-}).timeout(10 * 1000)
+})

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-  "extends": "standard"
-}

package/.eslintrc.json

@@ -1,26 +0,0 @@
-{
-  "parser": "babel-eslint",
-  "extends": [
-    "standard"
-  ],
-  "rules": {
-    "jsx-quotes": ["error", "prefer-single"],
-    "semi": [1, "never"],
-    "max-len": 0,
-    "import/no-named-as-default": 0,
-    "import/no-named-as-default-member": 0
-  },
-  "settings": {
-    "import/resolver": {
-      "node": {
-        "moduleDirectory": [
-          "node_modules",
-          "lib"
-        ]
-      }
-    }
-  },
-  "env": {
-    "jest": true
-  }
-}

package/.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-
-language: node_js
-node_js:
-  - "stable"
-
-install:
-  - npm install
-
-script:
-  - npm run lint
-  - npm run unit

package/docs/ws1_docs.md

@@ -1,114 +0,0 @@
-<a name="WSv1"></a>
-
-## WSv1
-Communicates with v1 of the Bitfinex WebSocket API
-
-**Kind**: global class  
-
-* [WSv1](#WSv1)
-    * [new WSv1()](#new_WSv1_new)
-    * [.open()](#WSv1+open)
-    * [.close()](#WSv1+close)
-    * [.send(msg)](#WSv1+send)
-    * [.subscribeOrderBook(pair, precision, length)](#WSv1+subscribeOrderBook)
-    * [.subscribeTrades(pair)](#WSv1+subscribeTrades)
-    * [.subscribeTicker(pair)](#WSv1+subscribeTicker)
-    * [.unsubscribe(chanId)](#WSv1+unsubscribe)
-    * [.auth()](#WSv1+auth)
-
-<a name="new_WSv1_new"></a>
-
-### new WSv1()
-
-| Param | Type | Description |
-| --- | --- | --- |
-| opts.apiKey | <code>sting</code> |  |
-| opts.apiSecret | <code>string</code> |  |
-| opts.url | <code>string</code> | ws connection url |
-
-<a name="WSv1+open"></a>
-
-### wSv1.open()
-Opens a new websocket conection to the configured URL
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-<a name="WSv1+close"></a>
-
-### wSv1.close()
-Close the websocket connection
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-<a name="WSv1+send"></a>
-
-### wSv1.send(msg)
-Send a packet via the ws connection; automatically converted to a JSON
-string.
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-
-| Param | Type |
-| --- | --- |
-| msg | <code>\*</code> | 
-
-<a name="WSv1+subscribeOrderBook"></a>
-
-### wSv1.subscribeOrderBook(pair, precision, length)
-Subscribe to order book updates. Snapshot will be sent as multiple updates.
-Event will be emited as `PAIRNAME_book`.
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-**See**: http://docs.bitfinex.com/#order-books  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| pair | <code>string</code> | <code>&quot;BTCUSD&quot;</code> |  |
-| precision | <code>string</code> |  | price aggregation level (P0 (def), P1, P2, P3) |
-| length | <code>string</code> |  | number of price points. 25 (default) or 100. |
-
-<a name="WSv1+subscribeTrades"></a>
-
-### wSv1.subscribeTrades(pair)
-Subscribe to trades. Snapshot will be sent as multiple updates.
-Event will be emited as `PAIRNAME_trades`.
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-**See**: http://docs.bitfinex.com/#trades75  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| pair | <code>string</code> | <code>&quot;BTCUSD&quot;</code> | 
-
-<a name="WSv1+subscribeTicker"></a>
-
-### wSv1.subscribeTicker(pair)
-Subscribe to ticker updates. The ticker is a high level overview of the
-state of the market. It shows you the current best bid and ask, as well as
-the last trade price.
-
-Event will be emited as `PAIRNAME_ticker`.
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-**See**: http://docs.bitfinex.com/#ticker76  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| pair | <code>string</code> | <code>&quot;BTCUSD&quot;</code> | pair |
-
-<a name="WSv1+unsubscribe"></a>
-
-### wSv1.unsubscribe(chanId)
-Unsubscribe from a channel.
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| chanId | <code>number</code> | ID of the channel received on `subscribed` event |
-
-<a name="WSv1+auth"></a>
-
-### wSv1.auth()
-Authenticate the user. Will receive executed traded updates.
-
-**Kind**: instance method of [<code>WSv1</code>](#WSv1)  
-**See**: http://docs.bitfinex.com/#wallet-updates