Merge pull request #379 from f3rno/fix-skip-auth-seq-error-n

(fix) skip auth seq # for error notifications w/ test

Author: f3rno

lib/transports/ws2.js

@@ -313,7 +313,11 @@ class WSv2 extends EventEmitter {
 
     // All other packets provide a public sequence # as the last value. For chan
     // 0 packets, these are included as the 2nd to last value
-    const seq = msg[0] === 0 && msg[1] !== 'hb'
+    const seq = (
+      (msg[0] === 0) &&
+      (msg[1] !== 'hb') &&
+      !(msg[1] === 'n' && msg[2][6] === 'ERROR') // error notifications lack seq
+    )
       ? msg[msg.length - 2]
       : msg[msg.length - 1]
 
@@ -332,6 +336,7 @@ class WSv2 extends EventEmitter {
 
     if (!isFinite(authSeq)) return null
     if (authSeq === 0) return null // still syncing
+    if (msg[1] === 'n' && msg[2][6] === 'ERROR') return null // err notifications lack seq
     if (authSeq === this._lastAuthSeq) return null // seq didn't advance
 
     // check

test/lib/transports/ws2-unit.js

@@ -1479,3 +1479,63 @@ describe('WSv2 message sending', () => {
     ws.send({ a: 42 })
   })
 })
+
+describe('WSv2 seq audit: _validateMessageSeq', () => {
+  it('returns an error on invalid pub seq', () => {
+    const ws = new WSv2()
+
+    ws._seqAudit = true
+    ws._lastPubSeq = 0
+
+    assert.equal(ws._validateMessageSeq([243, [252.12, 2, -1], 1]), null)
+    assert.equal(ws._validateMessageSeq([243, [252.12, 2, -1], 2]), null)
+
+    const err = ws._validateMessageSeq([243, [252.12, 2, -1], 5])
+    assert(err instanceof Error)
+  })
+
+  it('returns an error on invalid auth seq', () => {
+    const ws = new WSv2()
+
+    ws._seqAudit = true
+    ws._lastPubSeq = 0
+    ws._lastAuthSeq = 0
+
+    assert.equal(ws._validateMessageSeq([0, [252.12, 2, -1], 1, 1]), null)
+    assert.equal(ws._validateMessageSeq([0, [252.12, 2, -1], 2, 2]), null)
+
+    const err = ws._validateMessageSeq([0, [252.12, 2, -1], 3, 5])
+    assert(err instanceof Error)
+  })
+
+  it('ignores heartbeats', () => {
+    const ws = new WSv2()
+
+    ws._seqAudit = true
+    ws._lastPubSeq = 0
+
+    assert.equal(ws._validateMessageSeq([243, [252.12, 2, -1], 1]), null)
+    assert.equal(ws._validateMessageSeq([243, [252.12, 2, -1], 2]), null)
+    assert.equal(ws._validateMessageSeq([243, 'hb']), null)
+    assert.equal(ws._validateMessageSeq([243, 'hb']), null)
+    assert.equal(ws._validateMessageSeq([243, [252.12, 2, -1], 3]), null)
+    assert.equal(ws._validateMessageSeq([243, [252.12, 2, -1], 4]), null)
+  })
+
+  it('skips auth seq for error notifications', () => {
+    const ws = new WSv2()
+
+    ws._seqAudit = true
+    ws._lastPubSeq = 0
+    ws._lastAuthSeq = 0
+
+    const nSuccess = [null, null, null, null, null, null, 'SUCCESS']
+    const nError = [null, null, null, null, null, null, 'ERROR']
+
+    assert.equal(ws._validateMessageSeq([0, 'n', nSuccess, 1, 1]), null)
+    assert.equal(ws._validateMessageSeq([0, 'n', nSuccess, 2, 2]), null)
+    assert.equal(ws._validateMessageSeq([0, 'n', nError, 3]), null)
+    assert.equal(ws._validateMessageSeq([0, 'n', nSuccess, 4, 3]), null)
+    assert.equal(ws._validateMessageSeq([0, 'n', nSuccess, 5, 4]), null)
+  })
+})