chore: release version v0.10.0

https://greenkeeper.io/

.gitignore

@@ -25,5 +25,3 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
-
-docs

.npmignore

@@ -26,5 +26,4 @@ build/Release
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-test
-docs
+test

package.json

@@ -1,15 +1,14 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "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": {
     "lint": "aegir-lint",
     "test": "aegir-test --env node",
-    "docs": "aegir-docs",
-    "release": "aegir-release --env no-build --docs",
-    "release-minor": "aegir-release --type minor --env no-build --docs",
-    "release-major": "aegir-release --type major --env no-build --docs",
+    "release": "aegir-release --env no-build",
+    "release-minor": "aegir-release --type minor --env no-build",
+    "release-major": "aegir-release --type major --env no-build",
     "coverage": "aegir-coverage",
     "coverage-publish": "aegir-coverage publish"
   },
@@ -34,28 +33,32 @@
     "node": ">=4.0.0"
   },
   "devDependencies": {
-    "aegir": "^9.2.0",
+    "aegir": "^11.0.1",
     "chai": "^3.5.0",
-    "interface-transport": "^0.3.3",
+    "dirty-chai": "^1.2.2",
+    "interface-transport": "~0.3.5",
     "lodash.isfunction": "^3.0.8",
-    "pre-commit": "^1.1.3",
+    "pre-commit": "^1.2.2",
     "pull-stream": "^3.5.0"
   },
   "dependencies": {
-    "interface-connection": "0.3.0",
-    "ip-address": "^5.8.2",
+    "interface-connection": "~0.3.2",
+    "ip-address": "^5.8.6",
     "lodash.includes": "^4.3.0",
-    "mafmt": "^2.1.2",
-    "multiaddr": "^2.1.1",
+    "lodash.isfunction": "^3.0.8",
+    "mafmt": "^2.1.7",
+    "multiaddr": "^2.2.3",
+    "once": "^1.4.0",
     "stream-to-pull-stream": "^1.7.2"
   },
   "contributors": [
     "David Dias <daviddias.p@gmail.com>",
     "Evan Schwartz <evan.mark.schwartz@gmail.com>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
+    "Greenkeeper <support@greenkeeper.io>",
     "João Antunes <j.goncalo.antunes@gmail.com>",
+    "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
-    "Stephen Whitmore <stephen.whitmore@gmail.com>",
-    "greenkeeperio-bot <support@greenkeeper.io>"
+    "Stephen Whitmore <stephen.whitmore@gmail.com>"
   ]
-}
+}

src/index.js

@@ -6,43 +6,40 @@ 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')
 
-/**
- *
- */
-class TCP {
-  /**
-   * Dial to another peer.
-   *
-   * @param {Multiaddr} ma - The address of the peer we want to dial to.
-   * @param {Object} [options={}]
-   * @param {function(Error?, Array<Multiaddr>?)} [callback]
-   * @returns {Connection}
-   */
-  dial (ma, options, callback) {
+module.exports = class TCP {
+  dial (ma, options, cb) {
     if (isFunction(options)) {
-      callback = options
+      cb = options
       options = {}
     }
 
-    if (!callback) {
-      callback = () => {}
+    if (!cb) {
+      cb = () => {}
     }
 
+    cb = once(cb)
     const cOpts = ma.toOptions()
     log('Connecting to %s %s', cOpts.port, cOpts.host)
 
-    const rawSocket = net.connect(cOpts, callback)
-
+    const rawSocket = net.connect(cOpts)
     rawSocket.once('timeout', () => {
       log('timeout')
       rawSocket.emit('error', new Error('Timeout'))
     })
 
+    rawSocket.once('error', cb)
+
+    rawSocket.once('connect', () => {
+      rawSocket.removeListener('error', cb)
+      cb()
+    })
+
     const socket = toPull.duplex(rawSocket)
 
     const conn = new Connection(socket)
@@ -54,13 +51,6 @@ class TCP {
     return conn
   }
 
-  /**
-   * Listen for incoming `TCP` connetions.
-   *
-   * @param {Object} [options={}]
-   * @param {function(Connection)} [handler] - Called with newly incomin connections.
-   * @returns {Listener}
-   */
   createListener (options, handler) {
     if (isFunction(options)) {
       handler = options
@@ -72,13 +62,6 @@ class TCP {
     return createListener(handler)
   }
 
-  /**
-   * Filter a list of multiaddrs for those which contain
-   * valid `TCP` addresses.
-   *
-   * @param {Multiaddr|Array<Multiaddr>} multiaddrs
-   * @returns {Array<Multiaddr>}
-   */
   filter (multiaddrs) {
     if (!Array.isArray(multiaddrs)) {
       multiaddrs = [multiaddrs]
@@ -91,5 +74,3 @@ class TCP {
     })
   }
 }
-
-module.exports = TCP

src/listener.js

@@ -15,49 +15,7 @@ const getMultiaddr = require('./get-multiaddr')
 const IPFS_CODE = 421
 const CLOSE_TIMEOUT = 2000
 
-/**
- * Listening for incoming connections.
- *
- * @event listening
- * @instance
- * @memberof Listener
- */
-
-/**
- * The server closes.
- *
- * @event close
- * @instance
- * @memberof Listener
- */
-
-/**
- * New connection established.
- *
- * @event connection
- * @instance
- * @type {Connection}
- * @memberof Listener
- */
-
-/**
- * The underlying server encountered an error.
- *
- * @event error
- * @instance
- * @type {Error}
- * @memberof Listener
- */
-
 module.exports = (handler) => {
-  /**
-   * @alias Listener
-   * @type {Eventemitter}
-   * @fires Listener#listening
-   * @fires Listener#close
-   * @fires Listener#connection
-   * @fires Listener#error
-   */
   const listener = new EventEmitter()
 
   const server = net.createServer((socket) => {

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(
-          values
-        ).to.be.eql(
-          [new Buffer('hey!')]
-        )
+        expect(err).to.not.exist()
+        expect(values).to.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(
-            values
-          ).to.be.eql([
-            new Buffer('hey')
-          ])
+          expect(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(peerInfo).to.not.exist
+        expect(err).to.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(peerInfo).to.not.exist
+          expect(err).to.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()
         })