chore: release version v0.10.0

https://greenkeeper.io/

.gitignore

@@ -25,6 +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
-
-lib
-dist

.travis.yml

@@ -1,9 +1,13 @@
 sudo: false
 language: node_js
-node_js:
-  - 4
-  - 5
-  - stable
+matrix:
+  include:
+  - node_js: 4
+    env: CXX=g++-4.8
+  - node_js: 6
+    env: CXX=g++-4.8
+  - node_js: stable
+    env: CXX=g++-4.8
 
 # Make sure we have new NPM.
 before_install:
@@ -14,12 +18,16 @@ script:
   - npm test
   - npm run coverage
 
-addons:
-  firefox: 'latest'
-
 before_script:
   - export DISPLAY=:99.0
   - sh -e /etc/init.d/xvfb start
 
 after_success:
   - npm run coverage-publish
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 David Dias
+Copyright (c) 2015-2016 David Dias
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -3,22 +3,44 @@
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
 [![Build Status](https://travis-ci.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-tcp)
-![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-tcp/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-tcp?branch=master)
 [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D4.0.0-orange.svg?style=flat-square)
 
 ![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)
 ![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)
 
 > Node.js implementation of the TCP module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/interface-connection) interface for dial/listen.
 
-## Description
-
 `libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
 
 **Note:** This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
 
-## Example
+## Table of Contents
+
+- [Install](#install)
+  - [npm](#npm)
+- [Usage](#usage)
+  - [Example](#example)
+  - [This module uses `pull-streams`](#this-module-uses-pull-streams)
+    - [Converting `pull-streams` to Node.js Streams](#converting-pull-streams-to-nodejs-streams)
+- [API](#api)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
+
+### npm
+
+```sh
+> npm i libp2p-tcp
+```
+
+## Usage
+
+### Example
 
 ```js
 const TCP = require('libp2p-tcp')
@@ -51,25 +73,17 @@ listener.listen(() => {
 })
 ```
 
-outputs
+Outputs:
 
-```
+```sh
 listening
 new connection opened
 hello
 ```
 
-## Installation
+### This module uses `pull-streams`
 
-### npm
-
-```sh
-> npm i libp2p-tcp
-```
-
-## This module uses `pull-streams`
-
-We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about what took us to make this migration, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
+We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
 
 You can learn more about pull-streams at:
 
@@ -78,22 +92,22 @@ You can learn more about pull-streams at:
 - [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
 - [pull-streams documentation](https://pull-stream.github.io/)
 
-### Converting `pull-streams` to Node.js Streams
+#### Converting `pull-streams` to Node.js Streams
 
-If you are a Node.js streams user, you can convert a pull-stream to Node.js Stream using the module `pull-stream-to-stream`, giving you an instance of a Node.js stream that is linked to the pull-stream. Example:
+If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/dominictarr/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
 
-```
+```js
 const pullToStream = require('pull-stream-to-stream')
 
 const nodeStreamInstance = pullToStream(pullStreamInstance)
 // nodeStreamInstance is an instance of a Node.js Stream
 ```
 
-To learn more about his utility, visit https://pull-stream.github.io/#pull-stream-to-stream
+To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
 
 ## API
 
-[![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https://github.com/diasdavid/interface-transport)
+[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
 
 `libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e:
 
@@ -102,6 +116,18 @@ To learn more about his utility, visit https://pull-stream.github.io/#pull-strea
 
 Both for dialing and listening.
 
+## Contribute
+
+Contributions are welcome! The libp2p implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
+
+- [Check out the existing issues](//github.com/libp2p/js-libp2p-tcp/issues).
+- **Perform code reviews**.
+- **Add tests**. There can never be enough tests.
+
+Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+
 ## License
 
-MIT
+[MIT](LICENSE) © 2015-2016 David Dias

package.json

@@ -1,16 +1,14 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.8.0",
+  "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": "lib/index.js",
-  "jsnext:main": "src/index.js",
+  "main": "src/index.js",
   "scripts": {
     "lint": "aegir-lint",
-    "build": "aegir-build --env node",
     "test": "aegir-test --env node",
-    "release": "aegir-release --env node",
-    "release-minor": "aegir-release --type minor --env node",
-    "release-major": "aegir-release --type major --env node",
+    "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"
   },
@@ -20,7 +18,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/diasdavid/js-libp2p-tcp.git"
+    "url": "https://github.com/libp2p/js-libp2p-tcp.git"
   },
   "keywords": [
     "IPFS"
@@ -28,32 +26,39 @@
   "author": "David Dias <daviddias@ipfs.io>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/diasdavid/js-libp2p-tcp/issues"
+    "url": "https://github.com/libp2p/js-libp2p-tcp/issues"
+  },
+  "homepage": "https://github.com/libp2p/js-libp2p-tcp",
+  "engines": {
+    "node": ">=4.0.0"
   },
-  "homepage": "https://github.com/diasdavid/js-libp2p-tcp",
   "devDependencies": {
-    "aegir": "^6.0.1",
+    "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.2"
+    "pre-commit": "^1.2.2",
+    "pull-stream": "^3.5.0"
   },
   "dependencies": {
-    "interface-connection": "0.2.1",
-    "ip-address": "^5.8.0",
-    "lodash.contains": "^2.4.3",
-    "mafmt": "^2.1.2",
-    "multiaddr": "^2.0.2",
-    "pull": "^2.1.1",
-    "stream-to-pull-stream": "^1.7.0"
+    "interface-connection": "~0.3.2",
+    "ip-address": "^5.8.6",
+    "lodash.includes": "^4.3.0",
+    "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>",
-    "dignifiedquire <dignifiedquire@gmail.com>",
-    "greenkeeperio-bot <support@greenkeeper.io>"
+    "Stephen Whitmore <stephen.whitmore@gmail.com>"
   ]
 }

src/index.js

@@ -3,9 +3,10 @@
 const net = require('net')
 const toPull = require('stream-to-pull-stream')
 const mafmt = require('mafmt')
-const contains = require('lodash.contains')
+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')
 
@@ -22,16 +23,23 @@ module.exports = class TCP {
       cb = () => {}
     }
 
+    cb = once(cb)
     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', cb)
+
+    rawSocket.once('connect', () => {
+      rawSocket.removeListener('error', cb)
+      cb()
+    })
+
     const socket = toPull.duplex(rawSocket)
 
     const conn = new Connection(socket)
@@ -59,7 +67,7 @@ module.exports = class TCP {
       multiaddrs = [multiaddrs]
     }
     return multiaddrs.filter((ma) => {
-      if (contains(ma.protoNames(), 'ipfs')) {
+      if (includes(ma.protoNames(), 'ipfs')) {
         ma = ma.decapsulate('ipfs')
       }
       return mafmt.TCP.matches(ma)

src/listener.js

@@ -3,7 +3,7 @@
 const multiaddr = require('multiaddr')
 const Connection = require('interface-connection').Connection
 const os = require('os')
-const contains = require('lodash.contains')
+const includes = require('lodash.includes')
 const net = require('net')
 const toPull = require('stream-to-pull-stream')
 const EventEmitter = require('events').EventEmitter
@@ -78,7 +78,7 @@ module.exports = (handler) => {
 
   listener.listen = (ma, cb) => {
     listeningAddr = ma
-    if (contains(ma.protoNames(), 'ipfs')) {
+    if (includes(ma.protoNames(), 'ipfs')) {
       ipfsId = getIpfsId(ma)
       listeningAddr = ma.decapsulate('ipfs')
     }

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()
         })