style: fixing lint issues

Author: dmitriy ryajov

package.json

@@ -30,6 +30,11 @@
     "url": "https://github.com/libp2p/js-libp2p-circuit/issues"
   },
   "homepage": "https://github.com/libp2p/js-libp2p-circuit#readme",
+  "eslintConfig": {
+    "extends": [
+      "./node_modules/aegir/config/eslintrc.yml"
+    ]
+  },
   "devDependencies": {
     "aegir": "^10.0.0",
     "chai": "^3.5.0",

src/circuit-dialer.js

@@ -130,15 +130,13 @@ class CircuitDialer {
   }
 
   /**
-   * Create listener
+   * Create a listener
    *
+   * @param {Function} handler
    * @param {any} options
-   * @param {any} handler
-   * @returns {Listener}
-   *
-   * @memberOf CircuitDialer
+   * @returns {listener}
    */
-  createListener (handler) {
+  createListener (handler, options) {
     return createListener(this.swarm, handler)
   }
 

src/circuit.js renamed to src/circuit-relay.js

@@ -2,19 +2,16 @@
 
 const pull = require('pull-stream')
 const lp = require('pull-length-prefixed')
-const multiaddr = require('multiaddr')
 const Peer = require('./peer')
 const handshake = require('pull-handshake')
-const utils = require('./utils')
 const debug = require('debug')
-const includes = require('lodash/includes')
 const PeerInfo = require('peer-info')
 const PeerId = require('peer-id')
 
 const multicodec = require('./multicodec')
 
-const log = debug('libp2p:circuit:circuit')
-log.err = debug('libp2p:circuit:error:circuit')
+const log = debug('libp2p:circuit:relay')
+log.err = debug('libp2p:circuit:error:relay')
 
 class Circuit {
 
@@ -36,11 +33,13 @@ class Circuit {
   }
 
   /**
+   * The handler called to process a connection
    *
-   * @param conn
-   * @param peerInfo
-   * @param dstAddr
-   * @param cb
+   * @param {Connection} conn
+   * @param {Multiaddr} dstAddr
+   * @param {Function} cb
+   *
+   * @return {void}
    */
   handler (conn, dstAddr, cb) {
     this._circuit(conn, dstAddr, cb)
@@ -74,6 +73,15 @@ class Circuit {
     })
   }
 
+  /**
+   * Circuit two peers
+   *
+   * @param {Connection} srcConn
+   * @param {Multiaddr} dstMa
+   * @param {Function} cb
+   * @return {void}
+   * @private
+   */
   _circuit (srcConn, dstMa, cb) {
     this._dialPeer(dstMa, (err, dstConn) => {
       if (err) {
@@ -85,6 +93,11 @@ class Circuit {
       let shake = stream.handshake
 
       dstConn.getPeerInfo((err, peerInfo) => {
+        if (err) {
+          log.err(err)
+          return cb(err)
+        }
+
         pull(
           pull.values([new Buffer(`/ipfs/${peerInfo.id.toB58String()}`)]),
           lp.encode(),
@@ -111,9 +124,8 @@ class Circuit {
         dstConn,
         stream
       )
-      
     })
   }
 }
 
-module.exports = Circuit
+module.exports = Circuit

src/index.js

@@ -1,5 +1,7 @@
+'use strict'
+
 module.exports = {
-  Circuit: require('./circuit'),
+  Circuit: require('./circuit-relay'),
   CircuitDialer: require('./circuit-dialer'),
   multicodec: require('./multicodec')
-}
+}

src/listener.js

@@ -2,14 +2,13 @@
 
 const includes = require('lodash/includes')
 const pull = require('pull-stream')
-const Circuit = require('./circuit')
+const Circuit = require('./circuit-relay')
 const multicodec = require('./multicodec')
 const EE = require('events').EventEmitter
 const lp = require('pull-length-prefixed')
 const multiaddr = require('multiaddr')
 const handshake = require('pull-handshake')
 const Connection = require('interface-connection').Connection
-const abortable = require('pull-abortable')
 
 const debug = require('debug')
 
@@ -76,7 +75,7 @@ module.exports = (swarm, handler) => {
 
   listener.close = (cb) => {
     // TODO: should we close/abort connections here?
-    // spdy-transport throw a `Error: socket hang up`
+    // spdy-transport throws a `Error: socket hang up`
     // on swarm stop right now, could be an existing issue?
     swarm.unhandle(multicodec)
     listener.emit('close')

src/multicodec.js

@@ -1 +1,3 @@
-module.exports = '/ipfs/relay/circuit/1.0.0'
+'use strict'
+
+module.exports = '/ipfs/relay/circuit/1.0.0'

test/index.spec.js

@@ -3,15 +3,13 @@
 
 const PeerInfo = require('peer-info')
 const series = require('async/series')
-const parallel = require('async/parallel')
 const pull = require('pull-stream')
 const Libp2p = require('libp2p')
 
 const TCP = require('libp2p-tcp')
 const WS = require('libp2p-websockets')
 const spdy = require('libp2p-spdy')
 const multiplex = require('libp2p-multiplex')
-const waterfall = require('async/waterfall')
 const secio = require('libp2p-secio')
 
 const expect = require('chai').expect
@@ -91,12 +89,8 @@ describe('test relay', function () {
       (cb) => {
         dstNode.start(cb)
       },
-      (cb) => srcNode.dialByPeerInfo(relayPeer, (err, conn) => {
-        cb()
-      }),
-      (cb) => dstNode.dialByPeerInfo(relayPeer, (err, conn) => {
-        cb()
-      })
+      (cb) => srcNode.dialByPeerInfo(relayPeer, cb),
+      (cb) => dstNode.dialByPeerInfo(relayPeer, cb)
     ], done)
 
   }
@@ -112,7 +106,7 @@ describe('test relay', function () {
       (cb) => {
         relayNode.stop(cb)
       }
-    ], (err) => done()) // TODO: pass err to done once we figure out why spdy is throwing on stop
+    ], () => done()) // TODO: pass err to done once we figure out why spdy is throwing on stop
   }
 
   function reverse (protocol, conn) {
@@ -135,7 +129,7 @@ describe('test relay', function () {
         pull.values(['hello']),
         conn,
         pull.collect((err, data) => {
-          if (err) return cb(err)
+          if (err) return done(err)
 
           data.forEach((val, i) => {
             expect(val.toString()).to.equal(vals[i].split('').reverse().join(''))