fix: not started yet (#297)

* fix: callback when not started rather than throwing asserts

* fix: dont remove transports until the switch has stopped

* test: update connection check logic

* test: fix variable reference

* chore: update switch dep

* chore: update switch dep

Author: jacobheun

package.json

@@ -50,7 +50,7 @@
     "libp2p-connection-manager": "~0.0.2",
     "libp2p-floodsub": "~0.15.1",
     "libp2p-ping": "~0.8.3",
-    "libp2p-switch": "~0.41.2",
+    "libp2p-switch": "~0.41.3",
     "libp2p-websockets": "~0.12.0",
     "mafmt": "^6.0.2",
     "multiaddr": "^5.0.2",

src/index.js

@@ -2,10 +2,10 @@
 
 const FSM = require('fsm-event')
 const EventEmitter = require('events').EventEmitter
-const assert = require('assert')
 const debug = require('debug')
 const log = debug('libp2p')
 log.error = debug('libp2p:error')
+const errCode = require('err-code')
 
 const each = require('async/each')
 const series = require('async/series')
@@ -24,7 +24,12 @@ const pubsub = require('./pubsub')
 const getPeerInfo = require('./get-peer-info')
 const validateConfig = require('./config').validate
 
-const NOT_STARTED_ERROR_MESSAGE = 'The libp2p node is not started yet'
+const notStarted = (action, state) => {
+  return errCode(
+    new Error(`libp2p cannot ${action} when not started; state is ${state}`),
+    'ERR_NODE_NOT_STARTED'
+  )
+}
 
 /**
  * @fires Node#error Emitted when an error occurs
@@ -217,8 +222,6 @@ class Node extends EventEmitter {
    * @returns {void}
    */
   dial (peer, callback) {
-    assert(this.isStarted(), NOT_STARTED_ERROR_MESSAGE)
-
     this.dialProtocol(peer, null, callback)
   }
 
@@ -233,7 +236,9 @@ class Node extends EventEmitter {
    * @returns {void}
    */
   dialProtocol (peer, protocol, callback) {
-    assert(this.isStarted(), NOT_STARTED_ERROR_MESSAGE)
+    if (!this.isStarted()) {
+      return callback(notStarted('dial', this.state._state))
+    }
 
     if (typeof protocol === 'function') {
       callback = protocol
@@ -261,7 +266,9 @@ class Node extends EventEmitter {
    * @returns {void}
    */
   dialFSM (peer, protocol, callback) {
-    assert(this.isStarted(), NOT_STARTED_ERROR_MESSAGE)
+    if (!this.isStarted()) {
+      return callback(notStarted('dial', this.state._state))
+    }
 
     if (typeof protocol === 'function') {
       callback = protocol
@@ -282,8 +289,6 @@ class Node extends EventEmitter {
   }
 
   hangUp (peer, callback) {
-    assert(this.isStarted(), NOT_STARTED_ERROR_MESSAGE)
-
     this._getPeerInfo(peer, (err, peerInfo) => {
       if (err) { return callback(err) }
 
@@ -293,7 +298,7 @@ class Node extends EventEmitter {
 
   ping (peer, callback) {
     if (!this.isStarted()) {
-      return callback(new Error(NOT_STARTED_ERROR_MESSAGE))
+      return callback(notStarted('ping', this.state._state))
     }
 
     this._getPeerInfo(peer, (err, peerInfo) => {
@@ -463,13 +468,13 @@ class Node extends EventEmitter {
         }
         cb()
       },
-      (cb) => {
-        // Ensures idempotency for restarts
-        this._switch.transport.removeAll(cb)
-      },
       (cb) => {
         this.connectionManager.stop()
         this._switch.stop(cb)
+      },
+      (cb) => {
+        // Ensures idempotent restarts
+        this._switch.transport.removeAll(cb)
       }
     ], (err) => {
       if (err) {

test/fsm.spec.js

@@ -114,5 +114,29 @@ describe('libp2p state machine (fsm)', () => {
 
       node.start()
     })
+
+    it('should not dial when the node is stopped', (done) => {
+      node.on('stop', () => {
+        node.dial(null, (err) => {
+          expect(err).to.exist()
+          expect(err.code).to.eql('ERR_NODE_NOT_STARTED')
+          done()
+        })
+      })
+
+      node.stop()
+    })
+
+    it('should not dial (fsm) when the node is stopped', (done) => {
+      node.on('stop', () => {
+        node.dialFSM(null, null, (err) => {
+          expect(err).to.exist()
+          expect(err.code).to.eql('ERR_NODE_NOT_STARTED')
+          done()
+        })
+      })
+
+      node.stop()
+    })
   })
 })

test/stream-muxing.node.js

@@ -215,7 +215,7 @@ describe('stream muxing', () => {
 
         nodeA.dial(nodeB.peerInfo, (err) => {
           expect(err).to.not.exist()
-          expect(Object.keys(nodeA._switch.muxedConns)).to.have.length(0)
+          expect(nodeA._switch.connection.getAll()).to.have.length(0)
           cb()
         })
       },

test/transports.browser.js

@@ -102,7 +102,7 @@ describe('transports', () => {
         function check () {
           const peers = nodeA.peerBook.getAll()
           expect(Object.keys(peers)).to.have.length(1)
-          expect(Object.keys(nodeA._switch.muxedConns)).to.have.length(0)
+          expect(nodeA._switch.connection.getAll()).to.have.length(0)
           done()
         }
       })
@@ -142,7 +142,7 @@ describe('transports', () => {
           const peers = nodeA.peerBook.getAll()
           expect(err).to.not.exist()
           expect(Object.keys(peers)).to.have.length(1)
-          expect(Object.keys(nodeA._switch.muxedConns)).to.have.length(0)
+          expect(nodeA._switch.connection.getAll()).to.have.length(0)
           done()
         }
       })
@@ -153,16 +153,17 @@ describe('transports', () => {
         expect(err).to.not.exist()
 
         connFSM.once('muxed', () => {
-          expect(nodeA._switch.muxedConns).to.have.any.keys(
-            peerB.id.toB58String()
-          )
+          expect(
+            nodeA._switch.connection.getAllById(peerB.id.toB58String())
+          ).to.have.length(1)
 
           connFSM.once('error', done)
           connFSM.once('close', () => {
             // ensure the connection is closed
-            expect(nodeA._switch.muxedConns).to.not.have.any.keys([
-              peerB.id.toB58String()
-            ])
+            expect(
+              nodeA._switch.connection.getAllById(peerB.id.toB58String())
+            ).to.have.length(0)
+
             done()
           })
 
@@ -312,7 +313,7 @@ describe('transports', () => {
         function check () {
           const peers = node1.peerBook.getAll()
           expect(Object.keys(peers)).to.have.length(1)
-          expect(Object.keys(node1._switch.muxedConns)).to.have.length(0)
+          expect(node1._switch.connection.getAll()).to.have.length(0)
           done()
         }
       })
@@ -326,7 +327,7 @@ describe('transports', () => {
 
         function check () {
           // Verify both nodes are connected to node 3
-          if (node1._switch.muxedConns[b58Id] && node2._switch.muxedConns[b58Id]) {
+          if (node1._switch.connection.getAllById(b58Id) && node2._switch.connection.getAllById(b58Id)) {
             done()
           }
         }
@@ -417,7 +418,7 @@ describe('transports', () => {
         function check () {
           const peers = node1.peerBook.getAll()
           expect(Object.keys(peers)).to.have.length(1)
-          expect(Object.keys(node1._switch.muxedConns)).to.have.length(0)
+          expect(node1._switch.connection.getAll()).to.have.length(0)
           done()
         }
       })
@@ -430,8 +431,8 @@ describe('transports', () => {
 
       function check () {
         if (++counter === 3) {
-          expect(Object.keys(node1._switch.muxedConns).length).to.equal(1)
-          expect(Object.keys(node2._switch.muxedConns).length).to.equal(1)
+          expect(node1._switch.connection.getAll()).to.have.length(1)
+          expect(node2._switch.connection.getAll()).to.have.length(1)
           done()
         }
       }