feat: discovery modules from transports should be added (#510)

* feat: discovery modules from transports should be added

* chore: apply suggestions from code review

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

* chore: address review

* chore: apply suggestions from code review

Co-Authored-By: Jacob Heun <jacobheun@gmail.com>

test/peer-discovery/index.spec.js

@@ -10,57 +10,109 @@ const defer = require('p-defer')
 const mergeOptions = require('merge-options')
 
 const MulticastDNS = require('libp2p-mdns')
+const WebRTCStar = require('libp2p-webrtc-star')
 
 const Libp2p = require('../../src')
 const baseOptions = require('../utils/base-options.browser')
 const { createPeerInfo } = require('../utils/creators/peer')
 
 describe('peer discovery', () => {
-  let peerInfo
-  let remotePeerInfo
-  let libp2p
+  describe('basic functions', () => {
+    let peerInfo
+    let remotePeerInfo
+    let libp2p
 
-  before(async () => {
-    [peerInfo, remotePeerInfo] = await createPeerInfo({ number: 2 })
-  })
-
-  afterEach(async () => {
-    libp2p && await libp2p.stop()
-    sinon.reset()
-  })
-
-  it('should dial know peers on startup', async () => {
-    libp2p = new Libp2p({
-      ...baseOptions,
-      peerInfo
+    before(async () => {
+      [peerInfo, remotePeerInfo] = await createPeerInfo({ number: 2 })
     })
-    libp2p.peerStore.add(remotePeerInfo)
-    const deferred = defer()
-    sinon.stub(libp2p.dialer, 'connectToPeer').callsFake((remotePeerInfo) => {
-      expect(remotePeerInfo).to.equal(remotePeerInfo)
-      deferred.resolve()
-    })
-    const spy = sinon.spy()
-    libp2p.on('peer:discovery', spy)
 
-    libp2p.start()
-    await deferred.promise
-    expect(spy.getCall(0).args).to.eql([remotePeerInfo])
+    afterEach(async () => {
+      libp2p && await libp2p.stop()
+      sinon.reset()
+    })
+
+    it('should dial know peers on startup', async () => {
+      libp2p = new Libp2p({
+        ...baseOptions,
+        peerInfo
+      })
+      libp2p.peerStore.add(remotePeerInfo)
+      const deferred = defer()
+      sinon.stub(libp2p.dialer, 'connectToPeer').callsFake((remotePeerInfo) => {
+        expect(remotePeerInfo).to.equal(remotePeerInfo)
+        deferred.resolve()
+      })
+      const spy = sinon.spy()
+      libp2p.on('peer:discovery', spy)
+
+      libp2p.start()
+      await deferred.promise
+      expect(spy.getCall(0).args).to.eql([remotePeerInfo])
+    })
+
+    it('should ignore self on discovery', async () => {
+      libp2p = new Libp2p(mergeOptions(baseOptions, {
+        peerInfo,
+        modules: {
+          peerDiscovery: [MulticastDNS]
+        }
+      }))
+
+      await libp2p.start()
+      const discoverySpy = sinon.spy()
+      libp2p.on('peer:discovery', discoverySpy)
+      libp2p._discovery.get('mdns').emit('peer', libp2p.peerInfo)
+
+      expect(discoverySpy.called).to.eql(false)
+    })
   })
 
-  it('should ignore self on discovery', async () => {
-    libp2p = new Libp2p(mergeOptions(baseOptions, {
-      peerInfo,
-      modules: {
-        peerDiscovery: [MulticastDNS]
-      }
-    }))
+  describe('discovery modules from transports', () => {
+    let peerInfo, libp2p
 
-    await libp2p.start()
-    const discoverySpy = sinon.spy()
-    libp2p.on('peer:discovery', discoverySpy)
-    libp2p._discovery[0].emit('peer', libp2p.peerInfo)
+    before(async () => {
+      [peerInfo] = await createPeerInfo()
+    })
 
-    expect(discoverySpy.called).to.eql(false)
+    it('should add discovery module if present in transports and enabled', async () => {
+      libp2p = new Libp2p(mergeOptions(baseOptions, {
+        peerInfo,
+        modules: {
+          transport: [WebRTCStar]
+        },
+        config: {
+          peerDiscovery: {
+            webRTCStar: {
+              enabled: true
+            }
+          }
+        }
+      }))
+
+      await libp2p.start()
+
+      expect(libp2p._discovery.size).to.eql(1)
+      expect(libp2p._discovery.has('webRTCStar')).to.eql(true)
+    })
+
+    it('should not add discovery module if present in transports but disabled', async () => {
+      libp2p = new Libp2p(mergeOptions(baseOptions, {
+        peerInfo,
+        modules: {
+          transport: [WebRTCStar]
+        },
+        config: {
+          peerDiscovery: {
+            webRTCStar: {
+              enabled: false
+            }
+          }
+        }
+      }))
+
+      await libp2p.start()
+
+      expect(libp2p._discovery.size).to.eql(0)
+    })
   })
 })