chore: release version v0.22.0

Configuration for the peer discovery modules is now optional so this does not need to be validated. This also cleans up the config module to reduce repetition.

License: MIT
Signed-off-by: Alan Shaw <alan@tableflip.io>

CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="0.22.0"></a>
+# [0.22.0](https://github.com/libp2p/js-libp2p/compare/v0.21.0...v0.22.0) (2018-06-29)
+
+
+### Bug Fixes
+
+* add null property guards ([80f0b60](https://github.com/libp2p/js-libp2p/commit/80f0b60))
+* do not mutate the config object ([ac5cacb](https://github.com/libp2p/js-libp2p/commit/ac5cacb))
+* remove .only ([be9eafe](https://github.com/libp2p/js-libp2p/commit/be9eafe))
+* remove peer discovery module config checks ([4ad70ef](https://github.com/libp2p/js-libp2p/commit/4ad70ef))
+* typo in fixture and fail for correct reason ([1af5ba9](https://github.com/libp2p/js-libp2p/commit/1af5ba9))
+
+
+### Features
+
+* enable peer discovery modules by default ([e320854](https://github.com/libp2p/js-libp2p/commit/e320854))
+
+
+
 <a name="0.21.0"></a>
 # [0.21.0](https://github.com/libp2p/js-libp2p/compare/v0.20.4...v0.21.0) (2018-06-28)
 

README.md

@@ -12,7 +12,6 @@
 </p>
 
 <p align="center">
-  <a href="https://travis-ci.org/libp2p/js-libp2p"><img src="https://travis-ci.org/libp2p/js-libp2p.svg?branch=master" /></a>
   <a href="https://circleci.com/gh/libp2p/js-libp2p"><img src="https://circleci.com/gh/libp2p/js-libp2p.svg?style=svg" /></a>
   <a href="https://coveralls.io/github/libp2p/js-libp2p?branch=master"><img src="https://coveralls.io/repos/github/libp2p/js-libp2p/badge.svg?branch=master"></a>
   <br>

ci/Jenkinsfile

@@ -1,2 +1,2 @@
 // Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
-javascript(['nodejs_versions': ['8.11.3']])
+javascript()

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "JavaScript base class for libp2p bundles",
   "leadMaintainer": "David Dias <daviddias@ipfs.io>",
   "main": "src/index.js",
@@ -36,7 +36,7 @@
     "joi": "joi-browser"
   },
   "dependencies": {
-    "async": "^2.6.0",
+    "async": "^2.6.1",
     "joi": "^13.4.0",
     "joi-browser": "^13.4.0",
     "libp2p-connection-manager": "~0.0.2",
@@ -61,7 +61,7 @@
     "libp2p-kad-dht": "~0.10.0",
     "libp2p-mdns": "~0.12.0",
     "libp2p-mplex": "~0.8.0",
-    "libp2p-railing": "~0.9.1",
+    "libp2p-railing": "~0.9.2",
     "libp2p-secio": "~0.10.0",
     "libp2p-spdy": "~0.12.1",
     "libp2p-tcp": "~0.12.0",
@@ -72,10 +72,11 @@
     "pull-goodbye": "0.0.2",
     "pull-serializer": "~0.3.2",
     "pull-stream": "^3.6.8",
-    "sinon": "^5.0.7",
-    "wrtc": "0.1.1"
+    "sinon": "^6.0.1",
+    "wrtc": "~0.1.6"
   },
   "contributors": [
+    "Alan Shaw <alan@tableflip.io>",
     "Chris Bratlien <chrisbratlien@gmail.com>",
     "Chris Dostert <chrisdostert@users.noreply.github.com>",
     "Daijiro Wachi <daijiro.wachi@gmail.com>",
@@ -88,6 +89,7 @@
     "Giovanni T. Parra <fiatjaf@gmail.com>",
     "Hugo Dias <hugomrdias@gmail.com>",
     "Irakli Gozalishvili <rfobic@gmail.com>",
+    "Jacob Heun <jacobheun@gmail.com>",
     "Joel Gustafson <joelg@mit.edu>",
     "John Rees <johnrees@users.noreply.github.com>",
     "João Santos <joaosantos15@users.noreply.github.com>",

src/config.js

@@ -2,40 +2,19 @@
 
 const Joi = require('joi')
 
-const schema = Joi.object({
+const ModuleSchema = Joi.alternatives().try(Joi.func(), Joi.object())
+
+const OptionsSchema = Joi.object({
   // TODO: create proper validators for the generics
   connectionManager: Joi.object(),
   peerInfo: Joi.object().required(),
   peerBook: Joi.object(),
   modules: Joi.object().keys({
-    transport: Joi.array().items(
-      Joi.alternatives().try(
-        Joi.func(),
-        Joi.object()
-      )
-    ).min(1).required(),
-    streamMuxer: Joi.array().items(
-      Joi.alternatives().try(
-        Joi.func(),
-        Joi.object()
-      )
-    ).allow(null),
-    connEncryption: Joi.array().items(
-      Joi.alternatives().try(
-        Joi.func(),
-        Joi.object()
-      )
-    ).allow(null),
-    peerDiscovery: Joi.array().items(
-      Joi.alternatives().try(
-        Joi.func(),
-        Joi.object()
-      )
-    ).allow(null),
-    dht: Joi.alternatives().try(
-      Joi.func(),
-      Joi.object()
-    ).allow(null)
+    transport: Joi.array().items(ModuleSchema).min(1).required(),
+    streamMuxer: Joi.array().items(ModuleSchema).allow(null),
+    connEncryption: Joi.array().items(ModuleSchema).allow(null),
+    peerDiscovery: Joi.array().items(ModuleSchema).allow(null),
+    dht: ModuleSchema.allow(null)
   }).required(),
   config: Joi.object().keys({
     peerDiscovery: Joi.object().allow(null),
@@ -57,27 +36,12 @@ const schema = Joi.object({
 })
 
 module.exports.validate = (options) => {
-  let newSchema = schema
-  // Throw an intial error early for required props
-  let config = Joi.attempt(options, newSchema)
-
-  // Ensure discoveries are properly configured
-  if (config.modules.peerDiscovery) {
-    config.modules.peerDiscovery.forEach((discovery) => {
-      // If it's a function, validate we have configs for it
-      if (typeof discovery === 'function') {
-        Joi.reach(schema, 'config.peerDiscovery').keys({
-          [discovery.tag]: Joi.object().required()
-        })
-      }
-    })
-  }
+  options = Joi.attempt(options, OptionsSchema)
 
   // Ensure dht is correct
-  if (config.config.EXPERIMENTAL && config.config.EXPERIMENTAL.dht) {
-    newSchema = newSchema.requiredKeys('modules.dht')
+  if (options.config.EXPERIMENTAL.dht) {
+    Joi.assert(options.modules.dht, ModuleSchema.required())
   }
 
-  // Finish validation and return the updated config
-  return Joi.attempt(config, newSchema)
+  return options
 }

src/index.js

@@ -87,7 +87,7 @@ class Node extends EventEmitter {
     }
 
     // enable/disable pubsub
-    if (this._config.EXPERIMENTAL && this._config.EXPERIMENTAL.pubsub) {
+    if (this._config.EXPERIMENTAL.pubsub) {
       this.pubsub = pubsub(this)
     }
 
@@ -154,15 +154,25 @@ class Node extends EventEmitter {
         }
 
         // all transports need to be setup before discover starts
-        if (this._modules.peerDiscovery && this._config.peerDiscovery) {
+        if (this._modules.peerDiscovery) {
           each(this._modules.peerDiscovery, (D, _cb) => {
+            let config = {}
+
+            if (D.tag &&
+              this._config.peerDiscovery &&
+              this._config.peerDiscovery[D.tag]) {
+              config = this._config.peerDiscovery[D.tag]
+            }
+
+            // If not configured to be enabled/disabled then enable by default
+            const enabled = config.enabled == null ? true : config.enabled
+
             // If enabled then start it
-            if (this._config.peerDiscovery[D.tag].enabled) {
+            if (enabled) {
               let d
 
               if (typeof D === 'function') {
-                this._config.peerDiscovery[D.tag].peerInfo = this.peerInfo
-                d = new D(this._config.peerDiscovery[D.tag])
+                d = new D(Object.assign({}, config, { peerInfo: this.peerInfo }))
               } else {
                 d = D
               }

test/config.spec.js

@@ -113,21 +113,4 @@ describe('configuration', () => {
 
     expect(() => validateConfig(options)).to.throw()
   })
-
-  it('should require a non instanced peerDiscovery module to have associated options', () => {
-    const options = {
-      peerInfo,
-      modules: {
-        transport: [ WS ],
-        peerDiscover: [ Bootstrap ]
-      },
-      config: {
-        EXPERIMENTAL: {
-          dht: true
-        }
-      }
-    }
-
-    expect(() => validateConfig(options)).to.throw()
-  })
 })

test/peer-discovery.node.js

@@ -4,8 +4,10 @@
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
+const sinon = require('sinon')
 const signalling = require('libp2p-webrtc-star/src/sig-server')
 const parallel = require('async/parallel')
+const crypto = require('crypto')
 
 const createNode = require('./utils/create-node')
 const echo = require('./utils/echo')
@@ -57,12 +59,193 @@ describe('peer discovery', () => {
     })
   }
 
+  describe('module registration', () => {
+    it('should enable by default a module passed as an object', (done) => {
+      const mockDiscovery = {
+        on: sinon.stub(),
+        start: sinon.stub().callsArg(0),
+        stop: sinon.stub().callsArg(0)
+      }
+
+      const options = { modules: { peerDiscovery: [ mockDiscovery ] } }
+
+      createNode(['/ip4/0.0.0.0/tcp/0'], options, (err, node) => {
+        expect(err).to.not.exist()
+
+        node.start((err) => {
+          expect(err).to.not.exist()
+          expect(mockDiscovery.start.called).to.be.true()
+          node.stop(done)
+        })
+      })
+    })
+
+    it('should enable by default a module passed as a function', (done) => {
+      const mockDiscovery = {
+        on: sinon.stub(),
+        start: sinon.stub().callsArg(0),
+        stop: sinon.stub().callsArg(0)
+      }
+
+      const MockDiscovery = sinon.stub().returns(mockDiscovery)
+
+      const options = { modules: { peerDiscovery: [ MockDiscovery ] } }
+
+      createNode(['/ip4/0.0.0.0/tcp/0'], options, (err, node) => {
+        expect(err).to.not.exist()
+
+        node.start((err) => {
+          expect(err).to.not.exist()
+          expect(mockDiscovery.start.called).to.be.true()
+          node.stop(done)
+        })
+      })
+    })
+
+    it('should enable module by configutation', (done) => {
+      const mockDiscovery = {
+        on: sinon.stub(),
+        start: sinon.stub().callsArg(0),
+        stop: sinon.stub().callsArg(0),
+        tag: 'mockDiscovery'
+      }
+
+      const enabled = sinon.stub().returns(true)
+
+      const options = {
+        modules: { peerDiscovery: [ mockDiscovery ] },
+        config: {
+          peerDiscovery: {
+            mockDiscovery: {
+              get enabled () {
+                return enabled()
+              }
+            }
+          }
+        }
+      }
+
+      createNode(['/ip4/0.0.0.0/tcp/0'], options, (err, node) => {
+        expect(err).to.not.exist()
+
+        node.start((err) => {
+          expect(err).to.not.exist()
+          expect(mockDiscovery.start.called).to.be.true()
+          expect(enabled.called).to.be.true()
+          node.stop(done)
+        })
+      })
+    })
+
+    it('should disable module by configutation', (done) => {
+      const mockDiscovery = {
+        on: sinon.stub(),
+        start: sinon.stub().callsArg(0),
+        stop: sinon.stub().callsArg(0),
+        tag: 'mockDiscovery'
+      }
+
+      const disabled = sinon.stub().returns(false)
+
+      const options = {
+        modules: { peerDiscovery: [ mockDiscovery ] },
+        config: {
+          peerDiscovery: {
+            mockDiscovery: {
+              get enabled () {
+                return disabled()
+              }
+            }
+          }
+        }
+      }
+
+      createNode(['/ip4/0.0.0.0/tcp/0'], options, (err, node) => {
+        expect(err).to.not.exist()
+
+        node.start((err) => {
+          expect(err).to.not.exist()
+          expect(mockDiscovery.start.called).to.be.false()
+          expect(disabled.called).to.be.true()
+          node.stop(done)
+        })
+      })
+    })
+
+    it('should register module passed as function', (done) => {
+      const mockDiscovery = {
+        on: sinon.stub(),
+        start: sinon.stub().callsArg(0),
+        stop: sinon.stub().callsArg(0)
+      }
+
+      const MockDiscovery = sinon.stub().returns(mockDiscovery)
+      MockDiscovery.tag = 'mockDiscovery'
+
+      const options = {
+        modules: { peerDiscovery: [ MockDiscovery ] },
+        config: {
+          peerDiscovery: {
+            mockDiscovery: {
+              enabled: true,
+              time: Date.now()
+            }
+          }
+        }
+      }
+
+      createNode(['/ip4/0.0.0.0/tcp/0'], options, (err, node) => {
+        expect(err).to.not.exist()
+
+        node.start((err) => {
+          expect(err).to.not.exist()
+          expect(mockDiscovery.start.called).to.be.true()
+          expect(MockDiscovery.called).to.be.true()
+          // Ensure configuration was passed
+          expect(MockDiscovery.firstCall.args[0])
+            .to.deep.include(options.config.peerDiscovery.mockDiscovery)
+          node.stop(done)
+        })
+      })
+    })
+
+    it('should register module passed as object', (done) => {
+      const mockDiscovery = {
+        on: sinon.stub(),
+        start: sinon.stub().callsArg(0),
+        stop: sinon.stub().callsArg(0),
+        tag: 'mockDiscovery'
+      }
+
+      const options = {
+        modules: { peerDiscovery: [ mockDiscovery ] },
+        config: {
+          peerDiscovery: {
+            mockDiscovery: { enabled: true }
+          }
+        }
+      }
+
+      createNode(['/ip4/0.0.0.0/tcp/0'], options, (err, node) => {
+        expect(err).to.not.exist()
+
+        node.start((err) => {
+          expect(err).to.not.exist()
+          expect(mockDiscovery.start.called).to.be.true()
+          node.stop(done)
+        })
+      })
+    })
+  })
+
   describe('MulticastDNS', () => {
     setup({
       config: {
         peerDiscovery: {
           mdns: {
-            enabled: true
+            enabled: true,
+            // use a random tag to prevent CI collision
+            serviceTag: crypto.randomBytes(10).toString('hex')
           }
         }
       }
@@ -81,7 +264,15 @@ describe('peer discovery', () => {
 
   // TODO needs a delay (this test is already long)
   describe.skip('WebRTCStar', () => {
-    setup({ webRTCStar: true })
+    setup({
+      config: {
+        peerDiscovery: {
+          webRTCStar: {
+            enabled: true
+          }
+        }
+      }
+    })
 
     it('find a peer', function (done) {
       this.timeout(15 * 1000)
@@ -98,7 +289,9 @@ describe('peer discovery', () => {
       config: {
         peerDiscovery: {
           mdns: {
-            enabled: true
+            enabled: true,
+            // use a random tag to prevent CI collision
+            serviceTag: crypto.randomBytes(10).toString('hex')
           },
           webRTCStar: {
             enabled: true