feat: Use pull net

.travis.yml

@@ -1,28 +1,32 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+sudo: false
 language: node_js
-cache: npm
-stages:
-  - check
-  - test
-  - cov
 
-node_js:
-  - '10'
-
-os:
-  - linux
-  - osx
-  - windows
-
-script: npx nyc -s npm run test:node
-after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
-
-jobs:
+matrix:
   include:
-    - stage: check
-      script:
-        - npx aegir commitlint --travis
-        - npx aegir dep-check
-        - npm run lint
+  - node_js: 6
+    env: CXX=g++-4.8
+  - node_js: 8
+    env: CXX=g++-4.8
+    #  - node_js: stable
+    #    env: CXX=g++-4.8
 
-notifications:
-  email: false
+script:
+  - npm run lint
+  - npm run test
+  - npm run coverage
+
+before_script:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+
+after_success:
+  - npm run coverage-publish
+
+addons:
+  firefox: 'latest'
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8

CHANGELOG.md

@@ -1,13 +1,3 @@
-<a name="0.13.0"></a>
-# [0.13.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.1...v0.13.0) (2018-09-12)
-
-
-### Features
-
-* add support for dialing over dns ([eba0b48](https://github.com/libp2p/js-libp2p-tcp/commit/eba0b48))
-
-
-
 <a name="0.12.1"></a>
 ## [0.12.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.0...v0.12.1) (2018-07-31)
 

README.md

@@ -1,14 +1,13 @@
 # js-libp2p-tcp
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tcp)
-[![](https://img.shields.io/travis/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-tcp)
+[![](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)
+[![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%3D6.0.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D10.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
 
 [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
 [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)

appveyor.yml

@@ -0,0 +1,29 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+version: "{build}"
+
+environment:
+  matrix:
+    - nodejs_version: "6"
+    - nodejs_version: "8"
+
+matrix:
+  fast_finish: true
+
+install:
+  # Install Node.js
+  - ps: Install-Product node $env:nodejs_version
+
+  # Upgrade npm
+  - npm install -g npm
+
+  # Output our current versions for debugging
+  - node --version
+  - npm --version
+
+  # Install our package dependencies
+  - npm install
+
+test_script:
+  - npm run test:node
+
+build: off

ci/Jenkinsfile

@@ -0,0 +1,2 @@
+// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+javascript()

circle.yml

@@ -0,0 +1,15 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+machine:
+  node:
+    version: stable
+
+dependencies:
+  pre:
+    - google-chrome --version
+    - curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+    - sudo dpkg -i google-chrome.deb || true
+    - sudo apt-get update
+    - sudo apt-get install -f
+    - sudo apt-get install --only-upgrade lsb-base
+    - sudo dpkg -i google-chrome.deb
+    - google-chrome --version

package.json

@@ -1,17 +1,12 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.13.0",
+  "version": "0.12.1",
   "description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
-  "files": [
-    "dist",
-    "src"
-  ],
   "scripts": {
     "lint": "aegir lint",
     "test": "aegir test -t node -f test/**/*.js",
-    "test:node": "aegir test -t node -f test/**/*.js",
     "release": "aegir release -t node --no-build",
     "release-minor": "aegir release -t node --type minor --no-build",
     "release-major": "aegir-release -t node --type major --no-build",
@@ -39,20 +34,24 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^18.2.0",
-    "chai": "^4.2.0",
+    "aegir": "^15.1.0",
+    "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
-    "interface-transport": "~0.3.7",
-    "pull-stream": "^3.6.9"
+    "interface-transport": "~0.3.6",
+    "lodash.isfunction": "^3.0.9",
+    "pull-stream": "^3.6.7"
   },
   "dependencies": {
     "class-is": "^1.1.0",
-    "debug": "^4.1.1",
-    "interface-connection": "~0.3.3",
+    "debug": "^3.1.0",
+    "interface-connection": "~0.3.2",
     "ip-address": "^5.8.9",
-    "mafmt": "^6.0.6",
-    "multiaddr": "^6.0.5",
+    "lodash.includes": "^4.3.0",
+    "lodash.isfunction": "^3.0.9",
+    "mafmt": "^6.0.0",
+    "multiaddr": "^4.0.0",
     "once": "^1.4.0",
+    "pull-net": "github:mkg20001/pull-net",
     "stream-to-pull-stream": "^1.7.2"
   },
   "contributors": [

src/get-multiaddr.js

@@ -9,22 +9,22 @@ module.exports = (socket) => {
   let ma
 
   try {
-    if (socket.remoteFamily === 'IPv6') {
-      const addr = new Address6(socket.remoteAddress)
+    if (socket.remoteAddress.family === 'IPv6') {
+      const addr = new Address6(socket.remoteAddress.address)
 
       if (addr.v4) {
         const ip4 = addr.to4().correctForm()
         ma = multiaddr('/ip4/' + ip4 +
-          '/tcp/' + socket.remotePort
+          '/tcp/' + socket.remoteAddress.port
         )
       } else {
-        ma = multiaddr('/ip6/' + socket.remoteAddress +
-          '/tcp/' + socket.remotePort
+        ma = multiaddr('/ip6/' + socket.remoteAddress.address +
+          '/tcp/' + socket.remoteAddress.port
         )
       }
     } else {
-      ma = multiaddr('/ip4/' + socket.remoteAddress +
-        '/tcp/' + socket.remotePort)
+      ma = multiaddr('/ip4/' + socket.remoteAddress.address +
+        '/tcp/' + socket.remoteAddress.port)
     }
   } catch (err) {
     log(err)

src/index.js

@@ -1,9 +1,10 @@
 'use strict'
 
-const net = require('net')
-const toPull = require('stream-to-pull-stream')
+const {connect} = require('pull-net')
 const mafmt = require('mafmt')
 const withIs = require('class-is')
+const includes = require('lodash.includes')
+const isFunction = require('lodash.isfunction')
 const Connection = require('interface-connection').Connection
 const once = require('once')
 const debug = require('debug')
@@ -15,7 +16,7 @@ function noop () {}
 
 class TCP {
   dial (ma, options, callback) {
-    if (typeof options === 'function') {
+    if (isFunction(options)) {
       callback = options
       options = {}
     }
@@ -25,23 +26,7 @@ class TCP {
     const cOpts = ma.toOptions()
     log('Connecting to %s %s', cOpts.port, cOpts.host)
 
-    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)
+    const conn = new Connection(connect(cOpts.port, cOpts.host, callback))
 
     conn.getObservedAddrs = (callback) => {
       return callback(null, [ma])
@@ -51,7 +36,7 @@ class TCP {
   }
 
   createListener (options, handler) {
-    if (typeof options === 'function') {
+    if (isFunction(options)) {
       handler = options
       options = {}
     }
@@ -67,11 +52,11 @@ class TCP {
     }
 
     return multiaddrs.filter((ma) => {
-      if (ma.protoNames().includes('p2p-circuit')) {
+      if (includes(ma.protoNames(), 'p2p-circuit')) {
         return false
       }
 
-      if (ma.protoNames().includes('ipfs')) {
+      if (includes(ma.protoNames(), 'ipfs')) {
         ma = ma.decapsulate('ipfs')
       }
 

src/listener.js

@@ -3,28 +3,24 @@
 const multiaddr = require('multiaddr')
 const Connection = require('interface-connection').Connection
 const os = require('os')
-const net = require('net')
-const toPull = require('stream-to-pull-stream')
+const includes = require('lodash.includes')
+const {createServer} = require('pull-net')
 const EventEmitter = require('events').EventEmitter
 const debug = require('debug')
 const log = debug('libp2p:tcp:listen')
 
 const getMultiaddr = require('./get-multiaddr')
-
-const CLOSE_TIMEOUT = 2000
+const IPFS_CODE = 421
 
 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)
+  const server = createServer((stream) => {
+    const addr = getMultiaddr(stream)
     if (!addr) {
-      if (socket.remoteAddress === undefined) {
+      if (stream.remoteAddress === undefined || stream.remoteAddress.address === 'undefined') {
         log('connection closed before p2p connection made')
       } else {
         log('error interpreting incoming p2p connection')
@@ -34,25 +30,16 @@ module.exports = (handler) => {
 
     log('new connection', addr.toString())
 
-    const s = toPull.duplex(socket)
-
-    s.getObservedAddrs = (cb) => {
+    stream.getObservedAddrs = (cb) => {
       cb(null, [addr])
     }
 
-    trackSocket(server, socket)
-
-    const conn = new Connection(s)
+    const conn = new Connection(stream)
     handler(conn)
     listener.emit('connection', conn)
   })
 
-  server.on('listening', () => listener.emit('listening'))
-  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.emit('listening')
 
   listener.close = (options, callback) => {
     if (typeof options === 'function') {
@@ -62,25 +49,21 @@ module.exports = (handler) => {
     callback = callback || noop
     options = options || {}
 
-    const timeout = setTimeout(() => {
-      log('unable to close graciously, destroying conns')
-      Object.keys(server.__connections).forEach((key) => {
-        log('destroying %s', key)
-        server.__connections[key].destroy()
-      })
-    }, options.timeout || CLOSE_TIMEOUT)
-
-    server.close(callback)
-
-    server.once('close', () => {
-      clearTimeout(timeout)
+    server.close((err, ...a) => {
+      listener.emit('close')
+      callback(err, ...a)
     })
   }
 
+  let ipfsId
   let listeningAddr
 
   listener.listen = (ma, callback) => {
     listeningAddr = ma
+    if (includes(ma.protoNames(), 'ipfs')) {
+      ipfsId = getIpfsId(ma)
+      listeningAddr = ma.decapsulate('ipfs')
+    }
 
     const lOpts = listeningAddr.toOptions()
     log('Listening on %s %s', lOpts.port, lOpts.host)
@@ -98,43 +81,33 @@ module.exports = (handler) => {
     // Because TCP will only return the IPv6 version
     // we need to capture from the passed multiaddr
     if (listeningAddr.toString().indexOf('ip4') !== -1) {
-      if (listeningAddr.toString().indexOf('0.0.0.0') !== -1) {
+      let m = listeningAddr.decapsulate('tcp')
+      m = m.encapsulate('/tcp/' + address.port)
+      if (ipfsId) {
+        m = m.encapsulate('/ipfs/' + ipfsId)
+      }
+
+      if (m.toString().indexOf('0.0.0.0') !== -1) {
         const netInterfaces = os.networkInterfaces()
         Object.keys(netInterfaces).forEach((niKey) => {
           netInterfaces[niKey].forEach((ni) => {
             if (ni.family === 'IPv4') {
-              multiaddrs.push(
-                multiaddr(listeningAddr.toString().replace('0.0.0.0', ni.address))
-              )
+              multiaddrs.push(multiaddr(m.toString().replace('0.0.0.0', ni.address)))
             }
           })
         })
       } else {
-        multiaddrs.push(listeningAddr)
+        multiaddrs.push(m)
       }
     }
 
     if (address.family === 'IPv6') {
-      // Listen on all available addresses when using wildcard
-      if (listeningAddr.toString().indexOf('/::/') !== -1) {
-        const netInterfaces = os.networkInterfaces()
-        Object.keys(netInterfaces).forEach((niKey) => {
-          netInterfaces[niKey].forEach((ni) => {
-            if (ni.family === address.family) {
-              const maOpts = listeningAddr.toOptions()
-              if (maOpts.host === '::') {
-                maOpts.family = address.family
-                maOpts.address = ni.address
-                multiaddrs.push(
-                  multiaddr.fromNodeAddress(maOpts, maOpts.transport)
-                )
-              }
-            }
-          })
-        })
-      } else {
-        multiaddrs.push(listeningAddr)
+      let ma = multiaddr('/ip6/' + address.address + '/tcp/' + address.port)
+      if (ipfsId) {
+        ma = ma.encapsulate('/ipfs/' + ipfsId)
       }
+
+      multiaddrs.push(ma)
     }
 
     callback(null, multiaddrs)
@@ -143,11 +116,8 @@ module.exports = (handler) => {
   return listener
 }
 
-function trackSocket (server, socket) {
-  const key = `${socket.remoteAddress}:${socket.remotePort}`
-  server.__connections[key] = socket
-
-  socket.on('close', () => {
-    delete server.__connections[key]
-  })
+function getIpfsId (ma) {
+  return ma.stringTuples().filter((tuple) => {
+    return tuple[0] === IPFS_CODE
+  })[0][1]
 }

test/compliance.spec.js

@@ -8,13 +8,11 @@ const TCP = require('../src')
 describe('interface-transport compliance', () => {
   tests({
     setup (cb) {
-      const tcp = new TCP()
+      let tcp = new TCP()
       const addrs = [
         multiaddr('/ip4/127.0.0.1/tcp/9091'),
         multiaddr('/ip4/127.0.0.1/tcp/9092'),
-        multiaddr('/ip4/127.0.0.1/tcp/9093'),
-        multiaddr('/ip6/::/tcp/9094'),
-        multiaddr('/dns4/ipfs.io')
+        multiaddr('/ip4/127.0.0.1/tcp/9093')
       ]
       cb(null, tcp, addrs)
     },

test/filter.spec.js

@@ -25,11 +25,9 @@ describe('filter addrs', () => {
     const ma4 = multiaddr(base + '/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
     const ma5 = multiaddr(base + '/tcp/9090/http' + ipfs)
     const ma6 = multiaddr('/ip4/127.0.0.1/tcp/9090/p2p-circuit' + ipfs)
-    const ma7 = multiaddr('/dns4/libp2p.io/tcp/9090')
-    const ma8 = multiaddr('/dnsaddr/libp2p.io/tcp/9090')
 
-    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8])
-    expect(valid.length).to.equal(4)
+    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6])
+    expect(valid.length).to.equal(2)
     expect(valid[0]).to.deep.equal(ma1)
     expect(valid[1]).to.deep.equal(ma4)
   })

test/listen-dial.js

@@ -1,5 +1,4 @@
 /* eslint-env mocha */
-/* eslint max-nested-callbacks: ["error", 5] */
 'use strict'
 
 const pull = require('pull-stream')
@@ -14,19 +13,14 @@ const isCI = process.env.CI
 
 describe('listen', () => {
   let tcp
-  let listener
 
   beforeEach(() => {
     tcp = new TCP()
   })
 
-  afterEach((done) => {
-    listener ? listener.close(done) : done()
-  })
-
   it('close listener with connections, through timeout', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
-    listener = tcp.createListener((conn) => {
+    const listener = tcp.createListener((conn) => {
       pull(conn, conn)
     })
 
@@ -38,106 +32,97 @@ describe('listen', () => {
       socket1.end()
       socket1.on('error', () => {})
       socket2.on('error', () => {})
-      socket1.on('connect', done)
+      socket1.on('connect', () => {
+        listener.close(done)
+      })
     })
   })
 
   it('listen on port 0', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
-    listener = tcp.createListener((conn) => {})
-    listener.listen(mh, done)
+    const listener = tcp.createListener((conn) => {})
+    listener.listen(mh, () => {
+      listener.close(done)
+    })
   })
 
   it('listen on IPv6 addr', (done) => {
     if (isCI) { return done() }
     const mh = multiaddr('/ip6/::/tcp/9090')
-    listener = tcp.createListener((conn) => {})
-    listener.listen(mh, done)
+    const listener = tcp.createListener((conn) => {})
+    listener.listen(mh, () => {
+      listener.close(done)
+    })
   })
 
   it('listen on any Interface', (done) => {
     const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
-    listener = tcp.createListener((conn) => {})
-    listener.listen(mh, done)
+    const listener = tcp.createListener((conn) => {})
+    listener.listen(mh, () => {
+      listener.close(done)
+    })
   })
 
   it('getAddrs', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
-    listener = tcp.createListener((conn) => {})
+    const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
         expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
         expect(multiaddrs[0]).to.deep.equal(mh)
-        done()
+        listener.close(done)
       })
     })
   })
 
   it('getAddrs on port 0 listen', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
-    listener = tcp.createListener((conn) => {})
+    const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
         expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
-        done()
+        listener.close(done)
       })
     })
   })
 
   it('getAddrs from listening on 0.0.0.0', (done) => {
     const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
-    listener = tcp.createListener((conn) => {})
+    const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
         expect(err).to.not.exist()
         expect(multiaddrs.length > 0).to.equal(true)
         expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
-        done()
+        listener.close(done)
       })
     })
   })
 
   it('getAddrs from listening on 0.0.0.0 and port 0', (done) => {
     const mh = multiaddr('/ip4/0.0.0.0/tcp/0')
-    listener = tcp.createListener((conn) => {})
+    const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
         expect(err).to.not.exist()
         expect(multiaddrs.length > 0).to.equal(true)
-        multiaddrs.forEach((m) => {
-          expect(m.toOptions().host).to.not.eql('0.0.0.0')
-        })
-        done()
-      })
-    })
-  })
-
-  it('getAddrs from listening on ip6 \'::\'', (done) => {
-    const mh = multiaddr('/ip6/::/tcp/9090')
-    listener = tcp.createListener((conn) => {})
-    listener.listen(mh, () => {
-      listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist()
-        expect(multiaddrs.length > 0).to.equal(true)
-        multiaddrs.forEach((m) => {
-          expect(m.toOptions().host).to.not.eql('::')
-        })
-        done()
+        expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
+        listener.close(done)
       })
     })
   })
 
   it('getAddrs preserves IPFS Id', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
-    listener = tcp.createListener((conn) => {})
+    const listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
         expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
         expect(multiaddrs[0]).to.deep.equal(mh)
-        done()
+        listener.close(done)
       })
     })
   })