chore: release version v0.12.5

Freeze handling conns till identify is finished on the incomming multiplexed streams

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-swarm",
-  "version": "0.10.5",
+  "version": "0.12.5",
   "description": "libp2p swarm implementation in JavaScript",
   "main": "lib/index.js",
   "jsnext:main": "src/index.js",
@@ -11,8 +11,8 @@
     "test:node": "gulp test:node",
     "test:browser": "gulp test:browser",
     "release": "gulp release",
-    "release-minor": "gulp release --minor",
-    "release-major": "gulp release --major",
+    "release-minor": "gulp release --type minor",
+    "release-major": "gulp release --type major",
     "coverage": "gulp coverage",
     "coverage-publish": "aegir-coverage publish"
   },
@@ -40,25 +40,26 @@
     "bl": "^1.1.2",
     "buffer-loader": "0.0.1",
     "chai": "^3.5.0",
-    "aegir": "^2.1.0",
+    "aegir": "^3.0.0",
     "gulp": "^3.9.1",
-    "istanbul": "^0.4.2",
+    "istanbul": "^0.4.3",
     "libp2p-multiplex": "^0.2.1",
-    "libp2p-spdy": "^0.2.3",
-    "libp2p-tcp": "^0.4.0",
-    "libp2p-websockets": "^0.3.1",
-    "multiaddr": "^1.3.0",
-    "peer-id": "^0.6.0",
-    "peer-info": "^0.6.0",
+    "libp2p-spdy": "^0.3.1",
+    "libp2p-tcp": "^0.5.0",
+    "libp2p-websockets": "^0.4.1",
+    "multiaddr": "^1.4.0",
+    "peer-id": "^0.6.6",
+    "peer-info": "^0.6.2",
     "pre-commit": "^1.1.2",
     "stream-pair": "^1.0.3"
   },
   "dependencies": {
     "babel-runtime": "^6.6.1",
     "duplex-passthrough": "github:diasdavid/duplex-passthrough",
-    "ip-address": "^5.0.2",
-    "multistream-select": "^0.6.1",
-    "protocol-buffers-stream": "^1.2.0"
+    "ip-address": "^5.8.0",
+    "lodash.contains": "^2.4.3",
+    "multistream-select": "^0.6.5",
+    "protocol-buffers-stream": "^1.3.1"
   },
   "aegir": {
     "webpack": {
@@ -68,5 +69,13 @@
         }
       }
     }
-  }
-}
+  },
+  "contributors": [
+    "David Dias <daviddias.p@gmail.com>",
+    "David Dias <mail@daviddias.me>",
+    "Francisco Baio Dias <xicombd@gmail.com>",
+    "Pau Ramon Revilla <masylum@gmail.com>",
+    "Richard Littauer <richard.littauer@gmail.com>",
+    "dignifiedquire <dignifiedquire@gmail.com>"
+  ]
+}

src/identify.js

@@ -14,11 +14,7 @@ const Info = require('peer-info')
 const Id = require('peer-id')
 const multiaddr = require('multiaddr')
 
-const isNode = !global.window
-
-const identity = isNode
-  ? fs.readFileSync(path.join(__dirname, 'identify.proto'))
-  : require('buffer!./identify.proto')
+const identity = fs.readFileSync(path.join(__dirname, 'identify.proto'))
 
 const pbStream = require('protocol-buffers-stream')(identity)
 
@@ -45,7 +41,7 @@ exports.exec = (rawConn, muxer, peerInfo, callback) => {
 
       pbs.on('identify', (msg) => {
         if (msg.observedAddr.length > 0) {
-          peerInfo.multiaddr.addSafe(msg.observedAddr)
+          peerInfo.multiaddr.addSafe(multiaddr(msg.observedAddr))
         }
 
         const peerId = Id.createFromPubKey(msg.publicKey)
@@ -63,7 +59,7 @@ exports.exec = (rawConn, muxer, peerInfo, callback) => {
         protocolVersion: 'na',
         agentVersion: 'na',
         publicKey: peerInfo.id.pubKey,
-        listenAddrs: peerInfo.multiaddrs.map((mh) => { return mh.buffer }),
+        listenAddrs: peerInfo.multiaddrs.map((mh) => mh.buffer),
         observedAddr: obsMultiaddr ? obsMultiaddr.buffer : new Buffer('')
       })
 
@@ -74,15 +70,15 @@ exports.exec = (rawConn, muxer, peerInfo, callback) => {
 }
 
 exports.handler = (peerInfo, swarm) => {
-  return function (conn) {
+  return (conn) => {
     // 1. receive incoming observed info about me
     // 2. update my own information (on peerInfo)
     // 3. send back what I see from the other (get from swarm.muxedConns[incPeerID].conn.getObservedAddrs()
     var pbs = pbStream()
 
-    pbs.on('identify', function (msg) {
+    pbs.on('identify', (msg) => {
       if (msg.observedAddr.length > 0) {
-        peerInfo.multiaddr.addSafe(msg.observedAddr)
+        peerInfo.multiaddr.addSafe(multiaddr(msg.observedAddr))
       }
 
       const peerId = Id.createFromPubKey(msg.publicKey)
@@ -93,9 +89,7 @@ exports.handler = (peerInfo, swarm) => {
         protocolVersion: 'na',
         agentVersion: 'na',
         publicKey: peerInfo.id.pubKey,
-        listenAddrs: peerInfo.multiaddrs.map(function (ma) {
-          return ma.buffer
-        }),
+        listenAddrs: peerInfo.multiaddrs.map((ma) => ma.buffer),
         observedAddr: obsMultiaddr ? obsMultiaddr.buffer : new Buffer('')
       })
       pbs.finalize()

src/index.js

@@ -3,9 +3,14 @@
 const multistream = require('multistream-select')
 const identify = require('./identify')
 const DuplexPassThrough = require('duplex-passthrough')
+const contains = require('lodash.contains')
+const util = require('util')
+const EE = require('events').EventEmitter
 
 exports = module.exports = Swarm
 
+util.inherits(Swarm, EE)
+
 function Swarm (peerInfo) {
   if (!(this instanceof Swarm)) {
     return new Swarm(peerInfo)
@@ -87,7 +92,16 @@ function Swarm (peerInfo) {
     // if no callback is passed, we pass conns to connHandler
     if (!handler) { handler = connHandler }
 
-    const multiaddrs = this.transports[key].filter(peerInfo.multiaddrs)
+    const multiaddrs = this.transports[key].filter(
+      peerInfo.multiaddrs.map((addr) => {
+        // ipfs multiaddrs are not dialable so we drop them here
+        if (contains(addr.protoNames(), 'ipfs')) {
+          return addr.decapsulate('ipfs')
+        }
+
+        return addr
+      })
+    )
 
     this.transports[key].createListener(multiaddrs, handler, (err, maUpdate) => {
       if (err) {
@@ -134,7 +148,23 @@ function Swarm (peerInfo) {
     // for listening
     this.handle(muxer.multicodec, (conn) => {
       const muxedConn = muxer(conn, true)
+
+      var peerIdForConn
+
       muxedConn.on('stream', (conn) => {
+        function gotId () {
+          if (peerIdForConn) {
+            conn.peerId = peerIdForConn
+            connHandler(conn)
+          } else {
+            setTimeout(gotId, 100)
+          }
+        }
+
+        if (this.identify) {
+          return gotId()
+        }
+
         connHandler(conn)
       })
 
@@ -144,9 +174,18 @@ function Swarm (peerInfo) {
           if (err) {
             return console.log('Identify exec failed', err)
           }
+
+          peerIdForConn = pi.id
           this.muxedConns[pi.id.toB58String()] = {}
           this.muxedConns[pi.id.toB58String()].muxer = muxedConn
           this.muxedConns[pi.id.toB58String()].conn = conn // to be able to extract addrs
+
+          self.emit('peer-mux-established', pi)
+
+          muxedConn.on('close', () => {
+            delete self.muxedConns[pi.id.toB58String()]
+            self.emit('peer-mux-closed', pi)
+          })
         })
       }
     })
@@ -173,15 +212,19 @@ function Swarm (peerInfo) {
 
   // higher level (public) API
   this.dial = (pi, protocol, callback) => {
-    var pt = null
     if (typeof protocol === 'function') {
       callback = protocol
       protocol = null
-    } else {
-      pt = new DuplexPassThrough()
     }
 
+    if (!callback) {
+      callback = function noop () {}
+    }
+
+    const pt = new DuplexPassThrough()
+
     const b58Id = pi.id.toB58String()
+
     if (!this.muxedConns[b58Id]) {
       if (!this.conns[b58Id]) {
         attemptDial(pi, (err, conn) => {
@@ -274,14 +317,25 @@ function Swarm (peerInfo) {
             self.muxedConns[b58Id].muxer = muxedConn
             self.muxedConns[b58Id].conn = conn
 
+            self.emit('peer-mux-established', pi)
+
+            muxedConn.on('close', () => {
+              delete self.muxedConns[pi.id.toB58String()]
+              self.emit('peer-mux-closed', pi)
+            })
+
             // in case identify is on
-            muxedConn.on('stream', connHandler)
+            muxedConn.on('stream', (conn) => {
+              conn.peerId = pi.id
+              connHandler(conn)
+            })
 
             cb(null, muxedConn)
           })
         })
       }
     }
+
     function openConnInMuxedConn (muxer, cb) {
       cb(muxer.newStream())
     }
@@ -295,6 +349,7 @@ function Swarm (peerInfo) {
           }
 
           pt.wrapStream(conn)
+          pt.peerId = pi.id
           callback(null, pt)
         })
       })

test/01-transport-tcp.node.js

@@ -46,9 +46,17 @@ describe('transport - tcp', function () {
     function ready () {
       if (++count === 2) {
         expect(peerA.multiaddrs.length).to.equal(1)
-        expect(peerA.multiaddrs[0]).to.deep.equal(multiaddr('/ip4/127.0.0.1/tcp/9888'))
+        expect(
+          peerA.multiaddrs[0].equals(multiaddr('/ip4/127.0.0.1/tcp/9888'))
+        ).to.be.equal(
+          true
+        )
         expect(peerB.multiaddrs.length).to.equal(1)
-        expect(peerB.multiaddrs[0]).to.deep.equal(multiaddr('/ip4/127.0.0.1/tcp/9999'))
+        expect(
+          peerB.multiaddrs[0].equals(multiaddr('/ip4/127.0.0.1/tcp/9999'))
+        ).to.be.equal(
+          true
+        )
         done()
       }
     }
@@ -124,7 +132,11 @@ describe('transport - tcp', function () {
 
     function ready () {
       expect(peer.multiaddrs.length).to.equal(1)
-      expect(peer.multiaddrs[0]).to.deep.equal(multiaddr('/ip4/0.0.0.0/tcp/9050'))
+      expect(
+        peer.multiaddrs[0].equals(multiaddr('/ip4/0.0.0.0/tcp/9050'))
+      ).to.be.equal(
+        true
+      )
       swarm.close(done)
     }
   })

test/03-transport-websockets.node.js

@@ -46,9 +46,17 @@ describe('transport - websockets', function () {
     function ready () {
       if (++count === 2) {
         expect(peerA.multiaddrs.length).to.equal(1)
-        expect(peerA.multiaddrs[0]).to.deep.equal(multiaddr('/ip4/127.0.0.1/tcp/9888/websockets'))
+        expect(
+          peerA.multiaddrs[0].equals(multiaddr('/ip4/127.0.0.1/tcp/9888/websockets'))
+        ).to.be.equal(
+          true
+        )
         expect(peerB.multiaddrs.length).to.equal(1)
-        expect(peerB.multiaddrs[0]).to.deep.equal(multiaddr('/ip4/127.0.0.1/tcp/9999/websockets'))
+        expect(
+          peerB.multiaddrs[0].equals(multiaddr('/ip4/127.0.0.1/tcp/9999/websockets'))
+        ).to.equal(
+          true
+        )
         done()
       }
     }

test/08-swarm-without-muxing.node.js

@@ -21,7 +21,7 @@ describe('high level API - 1st without stream multiplexing (on TCP)', function (
     peerB = new Peer()
 
     peerA.multiaddr.add(multiaddr('/ip4/127.0.0.1/tcp/9001'))
-    peerB.multiaddr.add(multiaddr('/ip4/127.0.0.1/tcp/9002'))
+    peerB.multiaddr.add(multiaddr('/ip4/127.0.0.1/tcp/9002/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC'))
 
     swarmA = new Swarm(peerA)
     swarmB = new Swarm(peerB)

test/09-swarm-with-muxing.node.js

@@ -49,7 +49,7 @@ describe('high level API - with everything mixed all together!', function () {
 
     swarmA.close(closed)
     swarmB.close(closed)
-    swarmC.close(closed)
+    // swarmC.close(closed)
     swarmD.close(closed)
     swarmE.close(closed)
 
@@ -135,6 +135,14 @@ describe('high level API - with everything mixed all together!', function () {
       conn.pipe(conn)
     })
 
+    swarmB.once('peer-mux-established', (peerInfo) => {
+      expect(peerInfo.id.toB58String()).to.equal(peerA.id.toB58String())
+    })
+
+    swarmA.once('peer-mux-established', (peerInfo) => {
+      expect(peerInfo.id.toB58String()).to.equal(peerB.id.toB58String())
+    })
+
     swarmA.dial(peerB, '/anona/1.0.0', (err, conn) => {
       expect(err).to.not.exist
       expect(Object.keys(swarmA.muxedConns).length).to.equal(1)
@@ -182,11 +190,13 @@ describe('high level API - with everything mixed all together!', function () {
 
   it('dial from tcp+ws to tcp+ws', (done) => {
     swarmC.handle('/mamao/1.0.0', (conn) => {
+      expect(conn.peerId).to.exist
       conn.pipe(conn)
     })
 
     swarmA.dial(peerC, '/mamao/1.0.0', (err, conn) => {
       expect(err).to.not.exist
+      expect(conn.peerId).to.exist
       expect(Object.keys(swarmA.muxedConns).length).to.equal(2)
       conn.end()
 
@@ -194,4 +204,11 @@ describe('high level API - with everything mixed all together!', function () {
       conn.on('end', done)
     })
   })
+
+  it('close a muxer emits event', (done) => {
+    swarmC.close(() => {})
+    swarmA.once('peer-mux-closed', (peerInfo) => {
+      done()
+    })
+  })
 })