chore: update deps and more non Travis ci

chore: improve test listener closures

License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>

.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

.travis.yml

@@ -1,32 +1,28 @@
-# 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
 
-matrix:
+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:
   include:
-  - node_js: 6
-    env: CXX=g++-4.8
-  - node_js: 8
-    env: CXX=g++-4.8
-    #  - node_js: stable
-    #    env: CXX=g++-4.8
+    - stage: check
+      script:
+        - npx aegir commitlint --travis
+        - npx aegir dep-check
+        - npm run lint
 
-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
+notifications:
+  email: false

CHANGELOG.md

@@ -1,3 +1,13 @@
+<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,13 +1,14 @@
 # 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)
+[![](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)
 [![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%3D6.0.0-orange.svg?style=flat-square)
+![](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://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

@@ -1,29 +0,0 @@
-# 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

@@ -1,2 +0,0 @@
-// 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

@@ -1,15 +0,0 @@
-# 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,12 +1,17 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "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",
@@ -34,22 +39,19 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^15.1.0",
-    "chai": "^4.1.2",
+    "aegir": "^18.2.0",
+    "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
-    "interface-transport": "~0.3.6",
-    "lodash.isfunction": "^3.0.9",
-    "pull-stream": "^3.6.7"
+    "interface-transport": "~0.3.7",
+    "pull-stream": "^3.6.9"
   },
   "dependencies": {
     "class-is": "^1.1.0",
-    "debug": "^3.1.0",
-    "interface-connection": "~0.3.2",
+    "debug": "^4.1.1",
+    "interface-connection": "~0.3.3",
     "ip-address": "^5.8.9",
-    "lodash.includes": "^4.3.0",
-    "lodash.isfunction": "^3.0.9",
-    "mafmt": "^6.0.0",
-    "multiaddr": "^4.0.0",
+    "mafmt": "^6.0.6",
+    "multiaddr": "^6.0.5",
     "once": "^1.4.0",
     "stream-to-pull-stream": "^1.7.2"
   },

src/index.js

@@ -4,8 +4,6 @@ const net = require('net')
 const toPull = require('stream-to-pull-stream')
 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,20 +13,9 @@ const createListener = require('./listener')
 
 function noop () {}
 
-/**
- *
- */
 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) {
-    if (isFunction(options)) {
+    if (typeof options === 'function') {
       callback = options
       options = {}
     }
@@ -63,15 +50,8 @@ 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)) {
+    if (typeof options === 'function') {
       handler = options
       options = {}
     }
@@ -81,24 +61,17 @@ 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]
     }
 
     return multiaddrs.filter((ma) => {
-      if (includes(ma.protoNames(), 'p2p-circuit')) {
+      if (ma.protoNames().includes('p2p-circuit')) {
         return false
       }
 
-      if (includes(ma.protoNames(), 'ipfs')) {
+      if (ma.protoNames().includes('ipfs')) {
         ma = ma.decapsulate('ipfs')
       }
 

src/listener.js

@@ -3,7 +3,6 @@
 const multiaddr = require('multiaddr')
 const Connection = require('interface-connection').Connection
 const os = require('os')
-const includes = require('lodash.includes')
 const net = require('net')
 const toPull = require('stream-to-pull-stream')
 const EventEmitter = require('events').EventEmitter
@@ -12,54 +11,11 @@ const log = debug('libp2p:tcp:listen')
 
 const getMultiaddr = require('./get-multiaddr')
 
-const IPFS_CODE = 421
 const CLOSE_TIMEOUT = 2000
 
 function noop () {}
 
-/**
- * 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) => {
@@ -121,15 +77,10 @@ module.exports = (handler) => {
     })
   }
 
-  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)
@@ -147,33 +98,43 @@ 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) {
-      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) {
+      if (listeningAddr.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(m.toString().replace('0.0.0.0', ni.address)))
+              multiaddrs.push(
+                multiaddr(listeningAddr.toString().replace('0.0.0.0', ni.address))
+              )
             }
           })
         })
       } else {
-        multiaddrs.push(m)
+        multiaddrs.push(listeningAddr)
       }
     }
 
     if (address.family === 'IPv6') {
-      let ma = multiaddr('/ip6/' + address.address + '/tcp/' + address.port)
-      if (ipfsId) {
-        ma = ma.encapsulate('/ipfs/' + ipfsId)
+      // 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)
       }
-
-      multiaddrs.push(ma)
     }
 
     callback(null, multiaddrs)
@@ -182,12 +143,6 @@ module.exports = (handler) => {
   return listener
 }
 
-function getIpfsId (ma) {
-  return ma.stringTuples().filter((tuple) => {
-    return tuple[0] === IPFS_CODE
-  })[0][1]
-}
-
 function trackSocket (server, socket) {
   const key = `${socket.remoteAddress}:${socket.remotePort}`
   server.__connections[key] = socket

test/compliance.spec.js

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

test/filter.spec.js

@@ -25,9 +25,11 @@ 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])
-    expect(valid.length).to.equal(2)
+    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8])
+    expect(valid.length).to.equal(4)
     expect(valid[0]).to.deep.equal(ma1)
     expect(valid[1]).to.deep.equal(ma4)
   })

test/listen-dial.spec.js

@@ -1,4 +1,5 @@
 /* eslint-env mocha */
+/* eslint max-nested-callbacks: ["error", 5] */
 'use strict'
 
 const pull = require('pull-stream')
@@ -13,14 +14,19 @@ 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')
-    const listener = tcp.createListener((conn) => {
+    listener = tcp.createListener((conn) => {
       pull(conn, conn)
     })
 
@@ -32,97 +38,106 @@ describe('listen', () => {
       socket1.end()
       socket1.on('error', () => {})
       socket2.on('error', () => {})
-      socket1.on('connect', () => {
-        listener.close(done)
-      })
+      socket1.on('connect', done)
     })
   })
 
   it('listen on port 0', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
-    const listener = tcp.createListener((conn) => {})
-    listener.listen(mh, () => {
-      listener.close(done)
-    })
+    listener = tcp.createListener((conn) => {})
+    listener.listen(mh, done)
   })
 
   it('listen on IPv6 addr', (done) => {
     if (isCI) { return done() }
     const mh = multiaddr('/ip6/::/tcp/9090')
-    const listener = tcp.createListener((conn) => {})
-    listener.listen(mh, () => {
-      listener.close(done)
-    })
+    listener = tcp.createListener((conn) => {})
+    listener.listen(mh, done)
   })
 
   it('listen on any Interface', (done) => {
     const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
-    const listener = tcp.createListener((conn) => {})
-    listener.listen(mh, () => {
-      listener.close(done)
-    })
+    listener = tcp.createListener((conn) => {})
+    listener.listen(mh, done)
   })
 
   it('getAddrs', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
-    const listener = tcp.createListener((conn) => {})
+    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)
-        listener.close(done)
+        done()
       })
     })
   })
 
   it('getAddrs on port 0 listen', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
-    const listener = tcp.createListener((conn) => {})
+    listener = tcp.createListener((conn) => {})
     listener.listen(mh, () => {
       listener.getAddrs((err, multiaddrs) => {
         expect(err).to.not.exist()
         expect(multiaddrs.length).to.equal(1)
-        listener.close(done)
+        done()
       })
     })
   })
 
   it('getAddrs from listening on 0.0.0.0', (done) => {
     const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
-    const listener = tcp.createListener((conn) => {})
+    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)
-        listener.close(done)
+        done()
       })
     })
   })
 
   it('getAddrs from listening on 0.0.0.0 and port 0', (done) => {
     const mh = multiaddr('/ip4/0.0.0.0/tcp/0')
-    const listener = tcp.createListener((conn) => {})
+    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)
-        listener.close(done)
+        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()
       })
     })
   })
 
   it('getAddrs preserves IPFS Id', (done) => {
     const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
-    const listener = tcp.createListener((conn) => {})
+    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)
-        listener.close(done)
+        done()
       })
     })
   })