fix: pubsub configuration (#404)

* fix: add pubsub default config (#401)

License: MIT
Signed-off-by: Matthias Knopp <[email protected]>

* docs: add default pubsub config to README (#401)

License: MIT
Signed-off-by: Matthias Knopp <[email protected]>

* fix: pass config to provided PubSub (#401)

License: MIT
Signed-off-by: Matthias Knopp <[email protected]>

* docs: adapt pubsub/example for new config (#401)

License: MIT
Signed-off-by: Matthias Knopp <[email protected]>

* Update examples/pubsub/README.md

Co-Authored-By: Jacob Heun <[email protected]>

* test: add pubsub config tests (#401)

License: MIT
Signed-off-by: Matthias Knopp <[email protected]>

Author: a1300

README.md

@@ -192,7 +192,10 @@ class Node extends Libp2p {
           }
         },
         pubsub: {
-          enabled: true
+          enabled: true,
+          emitSelf: true,      // whether the node should emit to self on publish, in the event of the topic being subscribed
+          signMessages: true,  // if messages should be signed
+          strictSigning: true  // if message signing should be required
         }
       }
     }

examples/pubsub/1.js

@@ -11,6 +11,7 @@ const Gossipsub = require('libp2p-gossipsub')
 const defaultsDeep = require('@nodeutils/defaults-deep')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
+const series = require('async/series')
 
 class MyBundle extends libp2p {
   constructor (_options) {
@@ -28,6 +29,10 @@ class MyBundle extends libp2p {
             interval: 2000,
             enabled: true
           }
+        },
+        pubsub: {
+          enabled: true,
+          emitSelf: true
         }
       }
     }
@@ -63,19 +68,36 @@ parallel([
   node1.once('peer:connect', (peer) => {
     console.log('connected to %s', peer.id.toB58String())
 
-    // Subscribe to the topic 'news'
-    node1.pubsub.subscribe('news',
-      (msg) => console.log(msg.from, msg.data.toString()),
-      () => {
+    series([
+      // node1 subscribes to "news"
+      (cb) => node1.pubsub.subscribe(
+        'news',
+        (msg) => console.log(`node1 received: ${msg.data.toString()}`),
+        cb
+      ),
+      (cb) => setTimeout(cb, 500),
+      // node2 subscribes to "news"
+      (cb) => node2.pubsub.subscribe(
+        'news',
+        (msg) => console.log(`node2 received: ${msg.data.toString()}`),
+        cb
+      ),
+      (cb) => setTimeout(cb, 500),
+      // node2 publishes "news" every second
+      (cb) => {
         setInterval(() => {
-          // Publish the message on topic 'news'
           node2.pubsub.publish(
             'news',
             Buffer.from('Bird bird bird, bird is the word!'),
-            () => {}
+            (err) => {
+              if (err) { throw err }
+            }
           )
         }, 1000)
-      }
-    )
+        cb()
+      },
+    ], (err) => {
+      if (err) { throw err }
+    })
   })
 })

examples/pubsub/README.md

@@ -1,6 +1,6 @@
 # Publish Subscribe
 
-Publish Subscribe is also included on the stack. Currently, we have on PubSub implementation which we ship by default [libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub), with many more being researched at [research-pubsub](https://github.com/libp2p/research-pubsub).
+Publish Subscribe is also included on the stack. Currently, we have two PubSub implementation available [libp2p-floodsub](https://github.com/libp2p/js-libp2p-floodsub) and [libp2p-gossipsub](https://github.com/ChainSafe/gossipsub-js), with many more being researched at [research-pubsub](https://github.com/libp2p/research-pubsub).
 
 We've seen many interesting use cases appear with this, here are some highlights:
 
@@ -12,26 +12,43 @@ We've seen many interesting use cases appear with this, here are some highlights
 
 For this example, we will use MulticastDNS for automatic Peer Discovery. This example is based the previous examples found in [Discovery Mechanisms](../discovery-mechanisms). You can find the complete version at [1.js](./1.js).
 
-Using PubSub is super simple, all you have to do is start a libp2p node with `EXPERIMENTAL.pubsub` set to true.
+Using PubSub is super simple, you only need to provide the implementation of your choice and you are ready to go. No need for extra configuration.
 
 ```JavaScript
 node1.once('peer:connect', (peer) => {
   console.log('connected to %s', peer.id.toB58String())
 
-  // Subscribe to the topic 'news'
-  node1.pubsub.subscribe('news',
-    (msg) => console.log(msg.from, msg.data.toString()),
-    () => {
+  series([
+    // node1 subscribes to "news"
+    (cb) => node1.pubsub.subscribe(
+      'news',
+      (msg) => console.log(`node1 received: ${msg.data.toString()}`),
+      cb
+    ),
+    (cb) => setTimeout(cb, 500),
+    // node2 subscribes to "news"
+    (cb) => node2.pubsub.subscribe(
+      'news',
+      (msg) => console.log(`node2 received: ${msg.data.toString()}`),
+      cb
+    ),
+    (cb) => setTimeout(cb, 500),
+    // node2 publishes "news" every second
+    (cb) => {
       setInterval(() => {
-        // Publish the message on topic 'news'
         node2.pubsub.publish(
           'news',
           Buffer.from('Bird bird bird, bird is the word!'),
-          () => {}
+          (err) => {
+            if (err) { throw err }
+          }
         )
       }, 1000)
-    }
-  )
+      cb()
+    },
+  ], (err) => {
+    if (err) { throw err }
+  })
 })
 ```
 
@@ -40,11 +57,29 @@ The output of the program should look like:
 ```
 > node 1.js
 connected to QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
-QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
+node2 received: Bird bird bird, bird is the word!
+node1 received: Bird bird bird, bird is the word!
+node2 received: Bird bird bird, bird is the word!
+node1 received: Bird bird bird, bird is the word!
+```
+
+You can change the pubsub `emitSelf` option if you don't want the publishing node to receive its own messages.
+
+```JavaScript
+const defaults = {
+  config: {
+    peerDiscovery: {
+      mdns: {
+        interval: 2000,
+        enabled: true
+      }
+    },
+    pubsub: {
+      enabled: true,
+      emitSelf: false
+    }
+  }
+}
 ```
 
 ## 2. Future work

src/config.js

@@ -63,7 +63,10 @@ const configSchema = s({
   // Pubsub config
   pubsub: s('object?', {
     // Pubsub defaults
-    enabled: true
+    enabled: true,
+    emitSelf: true,
+    signMessages: true,
+    strictSigning: true
   })
 }, {})
 

src/index.js

@@ -124,7 +124,7 @@ class Libp2p extends EventEmitter {
 
     // start pubsub
     if (this._modules.pubsub && this._config.pubsub.enabled !== false) {
-      this.pubsub = pubsub(this, this._modules.pubsub)
+      this.pubsub = pubsub(this, this._modules.pubsub, this._config.pubsub)
     }
 
     // Attach remaining APIs

src/pubsub.js

@@ -6,8 +6,8 @@ const promisify = require('promisify-es6')
 
 const errCode = require('err-code')
 
-module.exports = (node, Pubsub) => {
-  const pubsub = new Pubsub(node, { emitSelf: true })
+module.exports = (node, Pubsub, config) => {
+  const pubsub = new Pubsub(node, config)
 
   return {
     /**

test/config.spec.js

@@ -83,7 +83,10 @@ describe('configuration', () => {
           autoDial: true
         },
         pubsub: {
-          enabled: true
+          enabled: true,
+          emitSelf: true,
+          signMessages: true,
+          strictSigning: true
         },
         dht: {
           kBucketSize: 20,
@@ -145,7 +148,10 @@ describe('configuration', () => {
           }
         },
         pubsub: {
-          enabled: true
+          enabled: true,
+          emitSelf: true,
+          signMessages: true,
+          strictSigning: true
         },
         dht: {
           kBucketSize: 20,
@@ -270,7 +276,10 @@ describe('configuration', () => {
       },
       config: {
         pubsub: {
-          enabled: true
+          enabled: true,
+          emitSelf: true,
+          signMessages: true,
+          strictSigning: true
         },
         peerDiscovery: {
           autoDial: true

test/pubsub.node.js

@@ -367,4 +367,70 @@ describe('.pubsub', () => {
       })
     })
   })
+
+  describe('.pubsub config', () => {
+    it('toggle all pubsub options off (except enabled)', done => {
+      expect(3).checks(done)
+
+      class PubSubSpy {
+        constructor (node, config) {
+          expect(config).to.be.eql({
+            enabled: true,
+            selfEmit: false,
+            signMessages: false,
+            strictSigning: false
+          }).mark()
+        }
+      }
+
+      createNode('/ip4/0.0.0.0/tcp/0', {
+        modules: {
+          pubsub: PubSubSpy
+        },
+        config: {
+          pubsub: {
+            enabled: true,
+            selfEmit: false,
+            signMessages: false,
+            strictSigning: false
+          }
+        }
+      }, (err, node) => {
+        expect(err).to.not.exist().mark()
+        expect(node).to.exist().mark()
+      })
+    })
+
+    it('toggle all pubsub options on', done => {
+      expect(3).checks(done)
+
+      class PubSubSpy {
+        constructor (node, config) {
+          expect(config).to.be.eql({
+            enabled: true,
+            selfEmit: true,
+            signMessages: true,
+            strictSigning: true
+          }).mark()
+        }
+      }
+
+      createNode('/ip4/0.0.0.0/tcp/0', {
+        modules: {
+          pubsub: PubSubSpy
+        },
+        config: {
+          pubsub: {
+            enabled: true,
+            selfEmit: true,
+            signMessages: true,
+            strictSigning: true
+          }
+        }
+      }, (err, node) => {
+        expect(err).to.not.exist().mark()
+        expect(node).to.exist().mark()
+      })
+    })
+  })
 })