fix: add support for p2p protocol

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

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)
 

package.json

@@ -1,6 +1,6 @@
 {
   "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",
@@ -34,24 +34,23 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^15.1.0",
+    "aegir": "^17.1.1",
-    "chai": "^4.1.2",
+    "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
     "interface-transport": "~0.3.6",
     "lodash.isfunction": "^3.0.9",
-    "pull-stream": "^3.6.7"
+    "pull-stream": "^3.6.9"
   },
   "dependencies": {
     "class-is": "^1.1.0",
-    "debug": "^3.1.0",
+    "debug": "^4.1.0",
     "interface-connection": "~0.3.2",
     "ip-address": "^5.8.9",
     "lodash.includes": "^4.3.0",
     "lodash.isfunction": "^3.0.9",
-    "mafmt": "^6.0.0",
+    "mafmt": "^6.0.3",
-    "multiaddr": "^4.0.0",
+    "multiaddr": "^6.0.1",
     "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.remoteAddress.family === 'IPv6') {
+    if (socket.remoteFamily === 'IPv6') {
-      const addr = new Address6(socket.remoteAddress.address)
+      const addr = new Address6(socket.remoteAddress)
 
       if (addr.v4) {
         const ip4 = addr.to4().correctForm()
         ma = multiaddr('/ip4/' + ip4 +
-          '/tcp/' + socket.remoteAddress.port
+          '/tcp/' + socket.remotePort
         )
       } else {
-        ma = multiaddr('/ip6/' + socket.remoteAddress.address +
+        ma = multiaddr('/ip6/' + socket.remoteAddress +
-          '/tcp/' + socket.remoteAddress.port
+          '/tcp/' + socket.remotePort
         )
       }
     } else {
-      ma = multiaddr('/ip4/' + socket.remoteAddress.address +
+      ma = multiaddr('/ip4/' + socket.remoteAddress +
-        '/tcp/' + socket.remoteAddress.port)
+        '/tcp/' + socket.remotePort)
     }
   } catch (err) {
     log(err)

src/index.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const {connect} = require('pull-net')
+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')
@@ -26,7 +27,23 @@ class TCP {
     const cOpts = ma.toOptions()
     log('Connecting to %s %s', cOpts.port, cOpts.host)
 
-    const conn = new Connection(connect(cOpts.port, cOpts.host, callback))
+    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)
 
     conn.getObservedAddrs = (callback) => {
       return callback(null, [ma])
@@ -56,8 +73,8 @@ class TCP {
         return false
       }
 
-      if (includes(ma.protoNames(), 'ipfs')) {
+      if (ma.protoNames().includes('p2p')) {
-        ma = ma.decapsulate('ipfs')
+        ma = ma.decapsulate('p2p')
       }
 
       return mafmt.TCP.matches(ma)

src/listener.js

@@ -4,23 +4,29 @@ const multiaddr = require('multiaddr')
 const Connection = require('interface-connection').Connection
 const os = require('os')
 const includes = require('lodash.includes')
-const {createServer} = require('pull-net')
+const net = require('net')
+const toPull = require('stream-to-pull-stream')
 const EventEmitter = require('events').EventEmitter
 const debug = require('debug')
 const log = debug('libp2p:tcp:listen')
 
 const getMultiaddr = require('./get-multiaddr')
-const IPFS_CODE = 421
+
+const P2P_CODE = 421
+const CLOSE_TIMEOUT = 2000
 
 function noop () {}
 
 module.exports = (handler) => {
   const listener = new EventEmitter()
 
-  const server = createServer((stream) => {
+  const server = net.createServer((socket) => {
-    const addr = getMultiaddr(stream)
+    // Avoid uncaught errors cause by unstable connections
+    socket.on('error', noop)
+
+    const addr = getMultiaddr(socket)
     if (!addr) {
-      if (stream.remoteAddress === undefined || stream.remoteAddress.address === 'undefined') {
+      if (socket.remoteAddress === undefined) {
         log('connection closed before p2p connection made')
       } else {
         log('error interpreting incoming p2p connection')
@@ -30,16 +36,25 @@ module.exports = (handler) => {
 
     log('new connection', addr.toString())
 
-    stream.getObservedAddrs = (cb) => {
+    const s = toPull.duplex(socket)
+
+    s.getObservedAddrs = (cb) => {
       cb(null, [addr])
     }
 
-    const conn = new Connection(stream)
+    trackSocket(server, socket)
+
+    const conn = new Connection(s)
     handler(conn)
     listener.emit('connection', conn)
   })
 
-  listener.emit('listening')
+  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.close = (options, callback) => {
     if (typeof options === 'function') {
@@ -49,20 +64,29 @@ module.exports = (handler) => {
     callback = callback || noop
     options = options || {}
 
-    server.close((err, ...a) => {
+    const timeout = setTimeout(() => {
-      listener.emit('close')
+      log('unable to close graciously, destroying conns')
-      callback(err, ...a)
+      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)
     })
   }
 
-  let ipfsId
+  let p2pId
   let listeningAddr
 
   listener.listen = (ma, callback) => {
     listeningAddr = ma
-    if (includes(ma.protoNames(), 'ipfs')) {
+    if (includes(ma.protoNames(), 'p2p')) {
-      ipfsId = getIpfsId(ma)
+      p2pId = getp2pId(ma)
-      listeningAddr = ma.decapsulate('ipfs')
+      listeningAddr = ma.decapsulate('p2p')
     }
 
     const lOpts = listeningAddr.toOptions()
@@ -83,8 +107,8 @@ module.exports = (handler) => {
     if (listeningAddr.toString().indexOf('ip4') !== -1) {
       let m = listeningAddr.decapsulate('tcp')
       m = m.encapsulate('/tcp/' + address.port)
-      if (ipfsId) {
+      if (p2pId) {
-        m = m.encapsulate('/ipfs/' + ipfsId)
+        m = m.encapsulate('/p2p/' + p2pId)
       }
 
       if (m.toString().indexOf('0.0.0.0') !== -1) {
@@ -103,8 +127,8 @@ module.exports = (handler) => {
 
     if (address.family === 'IPv6') {
       let ma = multiaddr('/ip6/' + address.address + '/tcp/' + address.port)
-      if (ipfsId) {
+      if (p2pId) {
-        ma = ma.encapsulate('/ipfs/' + ipfsId)
+        ma = ma.encapsulate('/p2p/' + p2pId)
       }
 
       multiaddrs.push(ma)
@@ -116,8 +140,17 @@ module.exports = (handler) => {
   return listener
 }
 
-function getIpfsId (ma) {
+function getp2pId (ma) {
   return ma.stringTuples().filter((tuple) => {
-    return tuple[0] === IPFS_CODE
+    return tuple[0] === P2P_CODE
   })[0][1]
 }
+
+function trackSocket (server, socket) {
+  const key = `${socket.remoteAddress}:${socket.remotePort}`
+  server.__connections[key] = socket
+
+  socket.on('close', () => {
+    delete server.__connections[key]
+  })
+}

test/compliance.spec.js

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