chore: release version v0.10.1

fix: catch errors on incomming sockets

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.9.2",
+  "version": "0.10.1",
   "description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
   "main": "src/index.js",
   "scripts": {
@@ -33,19 +33,22 @@
     "node": ">=4.0.0"
   },
   "devDependencies": {
-    "interface-transport": "~0.3.3",
+    "aegir": "^11.0.1",
-    "aegir": "^10.0.0",
     "chai": "^3.5.0",
+    "dirty-chai": "^1.2.2",
+    "interface-transport": "~0.3.5",
     "lodash.isfunction": "^3.0.8",
     "pre-commit": "^1.2.2",
     "pull-stream": "^3.5.0"
   },
   "dependencies": {
-    "interface-connection": "~0.3.0",
+    "interface-connection": "~0.3.2",
-    "mafmt": "^2.1.6",
+    "ip-address": "^5.8.8",
-    "multiaddr": "^2.2.1",
-    "ip-address": "^5.8.6",
     "lodash.includes": "^4.3.0",
+    "lodash.isfunction": "^3.0.8",
+    "mafmt": "^2.1.8",
+    "multiaddr": "^2.3.0",
+    "once": "^1.4.0",
     "stream-to-pull-stream": "^1.7.2"
   },
   "contributors": [

src/index.js

@@ -6,38 +6,47 @@ const mafmt = require('mafmt')
 const includes = require('lodash.includes')
 const isFunction = require('lodash.isfunction')
 const Connection = require('interface-connection').Connection
+const once = require('once')
 const debug = require('debug')
 const log = debug('libp2p:tcp:dial')
 
 const createListener = require('./listener')
 
-module.exports = class TCP {
+function noop () {}
-  dial (ma, options, cb) {
+
+class TCP {
+  dial (ma, options, callback) {
     if (isFunction(options)) {
-      cb = options
+      callback = options
       options = {}
     }
 
-    if (!cb) {
+    callback = callback || noop
-      cb = () => {}
-    }
 
+    callback = once(callback)
     const cOpts = ma.toOptions()
     log('Connecting to %s %s', cOpts.port, cOpts.host)
 
-    const rawSocket = net.connect(cOpts, cb)
+    const rawSocket = net.connect(cOpts)
 
     rawSocket.once('timeout', () => {
       log('timeout')
       rawSocket.emit('error', new Error('Timeout'))
     })
 
+    rawSocket.once('error', callback)
+
+    rawSocket.once('connect', () => {
+      rawSocket.removeListener('error', callback)
+      callback()
+    })
+
     const socket = toPull.duplex(rawSocket)
 
     const conn = new Connection(socket)
 
-    conn.getObservedAddrs = (cb) => {
+    conn.getObservedAddrs = (callback) => {
-      return cb(null, [ma])
+      return callback(null, [ma])
     }
 
     return conn
@@ -66,3 +75,5 @@ module.exports = class TCP {
     })
   }
 }
+
+module.exports = TCP

src/listener.js

@@ -14,17 +14,22 @@ const getMultiaddr = require('./get-multiaddr')
 
 const IPFS_CODE = 421
 const CLOSE_TIMEOUT = 2000
+function noop () {}
 
 module.exports = (handler) => {
   const listener = new EventEmitter()
 
   const server = net.createServer((socket) => {
+    // Avoid uncaught errors cause by unstable connections
+    socket.on('error', noop)
+
     const addr = getMultiaddr(socket)
     log('new connection', addr.toString())
 
     const s = toPull.duplex(socket)
+
     s.getObservedAddrs = (cb) => {
-      return cb(null, [addr])
+      cb(null, [addr])
     }
 
     trackSocket(server, socket)
@@ -34,36 +39,31 @@ module.exports = (handler) => {
     listener.emit('connection', conn)
   })
 
-  server.on('listening', () => {
+  server.on('listening', () => listener.emit('listening'))
-    listener.emit('listening')
+  server.on('error', (err) => listener.emit('error', err))
-  })
+  server.on('close', () => listener.emit('close'))
-
-  server.on('error', (err) => {
-    listener.emit('error', err)
-  })
-
-  server.on('close', () => {
-    listener.emit('close')
-  })
 
   // Keep track of open connections to destroy in case of timeout
   server.__connections = {}
 
-  listener.close = (options, cb) => {
+  listener.close = (options, callback) => {
     if (typeof options === 'function') {
-      cb = options
+      callback = options
       options = {}
     }
-    cb = cb || (() => {})
+    callback = callback || noop
     options = options || {}
 
     let closed = false
-    server.close(cb)
+    server.close(callback)
+
     server.once('close', () => {
       closed = true
     })
     setTimeout(() => {
-      if (closed) return
+      if (closed) {
+        return
+      }
 
       log('unable to close graciously, destroying conns')
       Object.keys(server.__connections).forEach((key) => {
@@ -76,7 +76,7 @@ module.exports = (handler) => {
   let ipfsId
   let listeningAddr
 
-  listener.listen = (ma, cb) => {
+  listener.listen = (ma, callback) => {
     listeningAddr = ma
     if (includes(ma.protoNames(), 'ipfs')) {
       ipfsId = getIpfsId(ma)
@@ -85,15 +85,15 @@ module.exports = (handler) => {
 
     const lOpts = listeningAddr.toOptions()
     log('Listening on %s %s', lOpts.port, lOpts.host)
-    return server.listen(lOpts.port, lOpts.host, cb)
+    return server.listen(lOpts.port, lOpts.host, callback)
   }
 
-  listener.getAddrs = (cb) => {
+  listener.getAddrs = (callback) => {
     const multiaddrs = []
     const address = server.address()
 
     if (!address) {
-      return cb(new Error('Listener is not ready yet'))
+      return callback(new Error('Listener is not ready yet'))
     }
 
     // Because TCP will only return the IPv6 version
@@ -128,7 +128,7 @@ module.exports = (handler) => {
       multiaddrs.push(ma)
     }
 
-    cb(null, multiaddrs)
+    callback(null, multiaddrs)
   }
 
   return listener

test/index.spec.js

@@ -2,7 +2,10 @@
 'use strict'
 
 const pull = require('pull-stream')
-const expect = require('chai').expect
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
 const TCP = require('../src')
 const net = require('net')
 const multiaddr = require('multiaddr')
@@ -11,7 +14,7 @@ const Connection = require('interface-connection').Connection
 describe('instantiate the transport', () => {
   it('create', () => {
     const tcp = new TCP()
-    expect(tcp).to.exist
+    expect(tcp).to.exist()
   })
 })
 
@@ -71,7 +74,7 @@ describe('listen', () => {
     const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
         expect(multiaddrs[0]).to.deep.equal(mh)
         listener.close(done)
@@ -84,7 +87,7 @@ describe('listen', () => {
     const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
         listener.close(done)
       })
@@ -96,7 +99,7 @@ describe('listen', () => {
     const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(multiaddrs.length > 0).to.equal(true)
         expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
         listener.close(done)
@@ -109,7 +112,7 @@ describe('listen', () => {
     const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(multiaddrs.length > 0).to.equal(true)
         expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
         listener.close(done)
@@ -122,7 +125,7 @@ describe('listen', () => {
     const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
         expect(multiaddrs[0]).to.deep.equal(mh)
         listener.close(done)
@@ -157,12 +160,8 @@ describe('dial', () => {
       pull.values(['hey']),
       tcp.dial(ma),
       pull.collect((err, values) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
-        expect(
+        expect(values).to.eql([new Buffer('hey!')])
-          values
-        ).to.be.eql(
-          [new Buffer('hey!')]
-        )
         done()
       })
     )
@@ -173,7 +172,7 @@ describe('dial', () => {
     pull(
       tcp.dial(ma),
       pull.onEnd((err) => {
-        expect(err).to.exist
+        expect(err).to.exist()
         done()
       })
     )
@@ -189,13 +188,9 @@ describe('dial', () => {
         pull.values(['hey']),
         tcp.dial(ma),
         pull.collect((err, values) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
 
-          expect(
+          expect(values).to.be.eql([new Buffer('hey')])
-            values
-          ).to.be.eql([
-            new Buffer('hey')
-          ])
 
           listener.close(done)
         })
@@ -258,7 +253,7 @@ describe('dial', () => {
       pull.values(['hey']),
       conn,
       pull.collect((err, res) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(res).to.be.eql([new Buffer('hey!')])
         done()
       })
@@ -307,9 +302,9 @@ describe('valid Connection', () => {
     let dialerObsAddrs
 
     const listener = tcp.createListener((conn) => {
-      expect(conn).to.exist
+      expect(conn).to.exist()
       conn.getObservedAddrs((err, addrs) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         dialerObsAddrs = addrs
         pull(pull.empty(), conn)
       })
@@ -324,7 +319,7 @@ describe('valid Connection', () => {
 
       function endHandler () {
         conn.getObservedAddrs((err, addrs) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
           pull(pull.empty(), conn)
           closeAndAssert(listener, addrs)
         })
@@ -342,10 +337,10 @@ describe('valid Connection', () => {
 
   it('get Peer Info', (done) => {
     const listener = tcp.createListener((conn) => {
-      expect(conn).to.exist
+      expect(conn).to.exist()
       conn.getPeerInfo((err, peerInfo) => {
-        expect(err).to.exist
+        expect(err).to.exist()
-        expect(peerInfo).to.not.exist
+        expect(peerInfo).to.not.exist()
         pull(pull.empty(), conn)
       })
     })
@@ -356,8 +351,8 @@ describe('valid Connection', () => {
       pull(conn, pull.onEnd(endHandler))
       function endHandler () {
         conn.getPeerInfo((err, peerInfo) => {
-          expect(err).to.exist
+          expect(err).to.exist()
-          expect(peerInfo).to.not.exist
+          expect(peerInfo).to.not.exist()
 
           listener.close(done)
         })
@@ -367,10 +362,10 @@ describe('valid Connection', () => {
 
   it('set Peer Info', (done) => {
     const listener = tcp.createListener((conn) => {
-      expect(conn).to.exist
+      expect(conn).to.exist()
       conn.setPeerInfo('batatas')
       conn.getPeerInfo((err, peerInfo) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(peerInfo).to.equal('batatas')
         pull(pull.empty(), conn)
       })
@@ -383,7 +378,7 @@ describe('valid Connection', () => {
       function endHandler () {
         conn.setPeerInfo('arroz')
         conn.getPeerInfo((err, peerInfo) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
           expect(peerInfo).to.equal('arroz')
 
           listener.close(done)
@@ -424,11 +419,11 @@ describe('Connection wrap', () => {
       pull.values(['hey']),
       connWrap,
       pull.collect((err, chunks) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(chunks).to.be.eql([new Buffer('hey')])
 
         connWrap.getPeerInfo((err, peerInfo) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
           expect(peerInfo).to.equal('peerInfo')
           done()
         })
@@ -443,7 +438,7 @@ describe('Connection wrap', () => {
       pull.values(['hey']),
       connWrap,
       pull.collect((err, chunks) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(chunks).to.be.eql([new Buffer('hey')])
         done()
       })
@@ -459,23 +454,30 @@ describe('Connection wrap', () => {
       callback(null, 'none')
     }
     conn.getPeerInfo((err, peerInfo) => {
-      expect(err).to.exist
+      expect(err).to.exist()
     })
     connWrap.getPeerInfo((err, peerInfo) => {
-      expect(err).to.not.exist
+      expect(err).to.not.exist()
       expect(peerInfo).to.equal('none')
     })
     pull(
       pull.values(['hey']),
       connWrap,
       pull.collect((err, chunks) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(chunks).to.be.eql([new Buffer('hey')])
         done()
       })
     )
   })
 
+  it('dial error', (done) => {
+    tcp.dial(multiaddr('/ip4/999.0.0.1/tcp/1234'), (err) => {
+      expect(err).to.exist()
+      done()
+    })
+  })
+
   it('matryoshka wrap', (done) => {
     const conn = tcp.dial(ma)
     const connWrap1 = new Connection(conn)
@@ -489,10 +491,10 @@ describe('Connection wrap', () => {
       pull.values(['hey']),
       connWrap3,
       pull.collect((err, chunks) => {
-        expect(err).to.not.exist
+        expect(err).to.not.exist()
         expect(chunks).to.be.eql([new Buffer('hey')])
         connWrap3.getPeerInfo((err, peerInfo) => {
-          expect(err).to.not.exist
+          expect(err).to.not.exist()
           expect(peerInfo).to.equal('inner doll')
           done()
         })