chore: release version v0.13.2

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

.travis.yml

@@ -1,5 +1,7 @@
 language: node_js
 cache: npm
+sudo: false
+
 stages:
   - check
   - test
@@ -7,19 +9,24 @@ stages:
 
 node_js:
   - '10'
+  - '12'
 
 os:
   - linux
   - osx
   - windows
 
-script: npx nyc -s npm run test:node
+before_script:
+  - if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6'; fi
+script: npx nyc -s npm run test:node -- --bail
 after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
 
 jobs:
   include:
     - stage: check
+      os: linux
       script:
+        - npx aegir build --bundlesize
         - npx aegir commitlint --travis
         - npx aegir dep-check
         - npm run lint

CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="0.13.2"></a>
+## [0.13.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.1...v0.13.2) (2019-09-24)
+
+
+### Bug Fixes
+
+* support multiaddr 7 ([#115](https://github.com/libp2p/js-libp2p-tcp/issues/115)) ([37cea53](https://github.com/libp2p/js-libp2p-tcp/commit/37cea53))
+
+
+
+<a name="0.13.1"></a>
+## [0.13.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.0...v0.13.1) (2019-08-08)
+
+
+
 <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)
 

README.md

@@ -3,12 +3,11 @@
 [![](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)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
 [![](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%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)

package.json

@@ -1,17 +1,13 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "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",
+    "test": "aegir test -t node",
+    "test:node": "aegir test -t node",
     "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,21 +35,24 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^18.2.0",
+    "aegir": "^20.0.0",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
-    "interface-transport": "~0.3.7",
-    "pull-stream": "^3.6.9"
+    "interface-transport": "~0.3.6",
+    "pull-stream": "^3.6.14",
+    "multiaddr7": "npm:multiaddr@^7.0.0"
   },
   "dependencies": {
     "class-is": "^1.1.0",
     "debug": "^4.1.1",
     "interface-connection": "~0.3.3",
-    "ip-address": "^5.8.9",
-    "mafmt": "^6.0.6",
-    "multiaddr": "^6.0.5",
+    "ip-address": "^6.1.0",
+    "lodash.includes": "^4.3.0",
+    "lodash.isfunction": "^3.0.9",
+    "mafmt": "^6.0.7",
+    "multiaddr": "^6.1.0",
     "once": "^1.4.0",
-    "stream-to-pull-stream": "^1.7.2"
+    "stream-to-pull-stream": "^1.7.3"
   },
   "contributors": [
     "Alan Shaw <alan@tableflip.io>",
@@ -67,10 +66,12 @@
     "Jacob Heun <jacobheun@gmail.com>",
     "Jacob Heun <jake@andyet.net>",
     "João Antunes <j.goncalo.antunes@gmail.com>",
+    "Linus Unnebäck <linus@folkdatorn.se>",
     "Pedro Teixeira <i@pgte.me>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Stephen Whitmore <stephen.whitmore@gmail.com>",
-    "TomCoded <tomtinkerer@gmail.com>"
+    "TomCoded <tomtinkerer@gmail.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>"
   ]
 }

src/index.js

@@ -4,6 +4,8 @@ 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,7 +17,7 @@ function noop () {}
 
 class TCP {
   dial (ma, options, callback) {
-    if (typeof options === 'function') {
+    if (isFunction(options)) {
       callback = options
       options = {}
     }
@@ -51,7 +53,7 @@ class TCP {
   }
 
   createListener (options, handler) {
-    if (typeof options === 'function') {
+    if (isFunction(options)) {
       handler = options
       options = {}
     }
@@ -67,11 +69,13 @@ 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 (typeof ma.decapsulateCode === 'function') {
+        ma = ma.decapsulateCode(421) // multiaddr 7
+      } else if (includes(ma.protoNames(), 'ipfs')) {
         ma = ma.decapsulate('ipfs')
       }
 

src/listener.js

@@ -3,6 +3,7 @@
 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
@@ -11,6 +12,7 @@ const log = debug('libp2p:tcp:listen')
 
 const getMultiaddr = require('./get-multiaddr')
 
+const IPFS_CODE = 421
 const CLOSE_TIMEOUT = 2000
 
 function noop () {}
@@ -77,10 +79,18 @@ module.exports = (handler) => {
     })
   }
 
+  let ipfsId
   let listeningAddr
 
   listener.listen = (ma, callback) => {
     listeningAddr = ma
+    if (typeof ma.decapsulateCode === 'function') {
+      ipfsId = getIpfsId(ma)
+      listeningAddr = ma.decapsulateCode(IPFS_CODE)
+    } else 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 +108,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,6 +143,12 @@ 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

@@ -13,7 +13,6 @@ describe('interface-transport compliance', () => {
         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')
       ]
       cb(null, tcp, addrs)

test/filter.spec.js

@@ -7,6 +7,7 @@ const expect = chai.expect
 chai.use(dirtyChai)
 const TCP = require('../src')
 const multiaddr = require('multiaddr')
+const multiaddr7 = require('multiaddr7')
 
 describe('filter addrs', () => {
   const base = '/ip4/127.0.0.1'
@@ -27,11 +28,13 @@ describe('filter addrs', () => {
     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 ma9 = multiaddr7(base + '/tcp/9090/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
 
-    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, ma7, ma8, ma9])
+    expect(valid.length).to.equal(5)
     expect(valid[0]).to.deep.equal(ma1)
     expect(valid[1]).to.deep.equal(ma4)
+    expect(valid[4]).to.deep.equal(ma9)
   })
 
   it('filter a single addr for this transport', () => {

test/listen-dial.spec.js

@@ -1,5 +1,4 @@
 /* eslint-env mocha */
-/* eslint max-nested-callbacks: ["error", 5] */
 'use strict'
 
 const pull = require('pull-stream')
@@ -10,23 +9,19 @@ chai.use(dirtyChai)
 const TCP = require('../src')
 const net = require('net')
 const multiaddr = require('multiaddr')
+const multiaddr7 = require('multiaddr7')
 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 +33,110 @@ 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)
+      })
+    })
+  })
+
+  it('getAddrs preserves IPFS Id (multiaddr 7)', (done) => {
+    const mh = multiaddr7('/ip4/127.0.0.1/tcp/9090/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
+    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)
+        listener.close(done)
       })
     })
   })
@@ -271,4 +270,19 @@ describe('dial', () => {
       })
     )
   })
+
+  it('dial on IPv4 with IPFS Id multiaddr7', (done) => {
+    const ma = multiaddr7('/ip4/127.0.0.1/tcp/9090/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
+    const conn = tcp.dial(ma)
+
+    pull(
+      pull.values(['hey']),
+      conn,
+      pull.collect((err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.be.eql([Buffer.from('hey!')])
+        done()
+      })
+    )
+  })
 })