fix: cleanup, moving setup code outside of dialer

Author: dryajov

src/circuit/dialer.js

@@ -3,7 +3,6 @@
 require('safe-buffer')
 
 const Connection = require('interface-connection').Connection
-const mafmt = require('mafmt')
 const isFunction = require('lodash.isfunction')
 const multiaddr = require('multiaddr')
 const constants = require('./constants')
@@ -31,46 +30,6 @@ class Dialer {
     this.relayPeers = new Map()
     this.options = options
     this.utils = utilsFactory(swarm)
-
-    // get all the relay addresses for this swarm
-    const relays = this.filter(swarm._peerInfo.multiaddrs.toArray())
-
-    // if no explicit relays, add a default relay addr
-    if (relays.length === 0) {
-      this.swarm
-        ._peerInfo
-        .multiaddrs
-        .add(`/p2p-circuit/ipfs/${this.swarm._peerInfo.id.toB58String()}`)
-    }
-
-    this.swarm.on('peer-mux-established', this.dialRelay.bind(this))
-    this.swarm.on('peer-mux-closed', (peerInfo) => {
-      this.relayPeers.delete(peerInfo.id.toB58String())
-    })
-
-    this.dialSwarmRelays(relays)
-  }
-
-  /**
-   * Dial the relays in the Addresses.Swarm config
-   *
-   * @param {Array} relays
-   * @return {void}
-   */
-  dialSwarmRelays (relays) {
-    // if we have relay addresses in swarm config, then dial those relays
-    this.swarm.on('listening', () => {
-      relays.forEach((relay) => {
-        let relaySegments = relay
-          .toString()
-          .split('/p2p-circuit')
-          .filter(segment => segment.length)
-
-        relaySegments.forEach((relaySegment) => {
-          this.dialRelay(this.utils.peerInfoFromMa(multiaddr(relaySegment)))
-        })
-      })
-    })
   }
 
   /**
@@ -222,24 +181,6 @@ class Dialer {
       cb(null, relayConn)
     }))
   }
-
-  /**
-   * Filter check for all multiaddresses
-   * that this transport can dial on
-   *
-   * @param {any} multiaddrs
-   * @returns {Array<multiaddr>}
-   *
-   * @memberOf Dialer
-   */
-  filter (multiaddrs) {
-    if (!Array.isArray(multiaddrs)) {
-      multiaddrs = [multiaddrs]
-    }
-    return multiaddrs.filter((ma) => {
-      return mafmt.Circuit.matches(ma)
-    })
-  }
 }
 
 module.exports = Dialer

src/circuit/relay.js

@@ -33,9 +33,9 @@ class Relay extends EE {
    */
   constructor (options) {
     super()
-    this.config = Object.assign({Active: false}, options)
+    this.config = Object.assign({active: false}, options)
     this.swarm = null
-    this.active = this.config.Active
+    this.active = this.config.active
   }
 
   _writeErr (streamHandler, errCode, cb) {
@@ -112,11 +112,7 @@ class Relay extends EE {
     this.swarm.handle(multicodec.hop, (proto, conn) => {
       const streamHandler = new StreamHandler(conn, 1000 * 60)
       waterfall([
-        (cb) => {
-          this._readDstAddr(streamHandler, (err, dstMa) => {
-            cb(err, dstMa)
-          })
-        },
+        (cb) => this._readDstAddr(streamHandler, cb),
         (dstMa, cb) => {
           this._readSrcAddr(streamHandler, (err, srcMa) => {
             cb(err, dstMa, srcMa)
@@ -128,7 +124,7 @@ class Relay extends EE {
           return
         }
 
-        return this.circuit(streamHandler.rest(), dstMa, srcMa, (err) => {
+        return this._circuit(streamHandler.rest(), dstMa, srcMa, (err) => {
           if (err) {
             log.err(err)
             setImmediate(() => this.emit('circuit:error', err))
@@ -151,7 +147,7 @@ class Relay extends EE {
    *
    * @return {void}
    */
-  circuit (conn, dstAddr, srcAddr, cb) {
+  _circuit (conn, dstAddr, srcAddr, cb) {
     this._dialPeer(dstAddr, (err, dstConn) => {
       let streamHandler = null
 

src/dialer.js

@@ -1,10 +1,13 @@
 'use strict'
 
-const debug = require('debug')
-const constants = require('./circuit/constants')
+const mafmt = require('mafmt')
+const multiaddr = require('multiaddr')
 
+const constants = require('./circuit/constants')
 const OnionDialer = require('./circuit/onion-dialer')
+const utilsFactory = require('./circuit/utils')
 
+const debug = require('debug')
 const log = debug('libp2p:circuit:transportdialer')
 log.err = debug('libp2p:circuit:error:transportdialer')
 
@@ -23,9 +26,50 @@ class Dialer {
 
     this.swarm = swarm
     this.dialer = null
+    this.utils = utilsFactory(swarm)
 
-    // TODO: add flag for other types of dialers, ie telescope
+    // get all the relay addresses for this swarm
+    const relays = this.filter(swarm._peerInfo.multiaddrs.toArray())
+
+    // if no explicit relays, add a default relay addr
+    if (relays.length === 0) {
+      this.swarm
+        ._peerInfo
+        .multiaddrs
+        .add(`/p2p-circuit/ipfs/${this.swarm._peerInfo.id.toB58String()}`)
+    }
+
+    // TODO: add flag for other types of dealers, ie telescope
     this.dialer = new OnionDialer(swarm, options)
+
+    this.swarm.on('peer-mux-established', this.dialer.dialRelay.bind(this.dialer))
+    this.swarm.on('peer-mux-closed', (peerInfo) => {
+      this.dialer.relayPeers.delete(peerInfo.id.toB58String())
+    })
+
+    this._dialSwarmRelays(relays)
+  }
+
+  /**
+   * Dial the relays in the Addresses.Swarm config
+   *
+   * @param {Array} relays
+   * @return {void}
+   */
+  _dialSwarmRelays (relays) {
+    // if we have relay addresses in swarm config, then dial those relays
+    this.swarm.on('listening', () => {
+      relays.forEach((relay) => {
+        let relaySegments = relay
+          .toString()
+          .split('/p2p-circuit')
+          .filter(segment => segment.length)
+
+        relaySegments.forEach((relaySegment) => {
+          this.dialer.dialRelay(this.utils.peerInfoFromMa(multiaddr(relaySegment)))
+        })
+      })
+    })
   }
 
   get priority () {
@@ -76,7 +120,12 @@ class Dialer {
    * @memberOf Dialer
    */
   filter (multiaddrs) {
-    return this.dialer.filter(multiaddrs)
+    if (!Array.isArray(multiaddrs)) {
+      multiaddrs = [multiaddrs]
+    }
+    return multiaddrs.filter((ma) => {
+      return mafmt.Circuit.matches(ma)
+    })
   }
 }
 

src/listener.js

@@ -94,7 +94,8 @@ module.exports = (swarm, options, handler) => {
 
     // get all the explicit relay addrs excluding self
     let p2pAddrs = addrs.filter((addr) => {
-      return mafmt.Circuit.matches(addr) && !addr.toString().includes(swarm._peerInfo.id.toB58String())
+      return mafmt.Circuit.matches(addr) &&
+        !addr.toString().includes(swarm._peerInfo.id.toB58String())
     })
 
     // use the explicit relays instead of any relay

test/relay.spec.js

@@ -62,7 +62,7 @@ describe('relay', function () {
         relay._readSrcAddr.callThrough()
         relay._writeErr.callThrough()
         relay.mount(swarm) // mount the swarm
-        relay.circuit.callsArg(3, null, toConn)
+        relay._circuit.callsArg(3, null, toConn)
 
         dialer.relayConns = new Map()
         dialer.negotiateRelay.callThrough()
@@ -74,7 +74,7 @@ describe('relay', function () {
       relay.mount.reset()
       relay.emit.reset()
       relay.on.reset()
-      relay.circuit.reset()
+      relay._circuit.reset()
       relay._readDstAddr.reset()
       relay._readSrcAddr.reset()
       relay._readSrcAddr.reset()
@@ -84,7 +84,7 @@ describe('relay', function () {
     it(`handle a valid circuit request`, function (done) {
       relay.active = true
       relay.on('circuit:success', () => {
-        expect(relay.circuit.calledWith(sinon.match.any, dstMa)).to.be.ok
+        expect(relay._circuit.calledWith(sinon.match.any, dstMa)).to.be.ok
         done()
       })