feat: auto dial discovered peers (#349)

Author: jacobheun

.aegir.js

@@ -79,7 +79,7 @@ const after = (done) => {
 }
 
 module.exports = {
-  bundlesize: { maxSize: '217kB' },
+  bundlesize: { maxSize: '218kB' },
   hooks: {
     pre: before,
     post: after

PEER_DISCOVERY.md

@@ -0,0 +1,60 @@
+# Peer Discovery and Auto Dial
+
+**Synopsis**:
+* All peers discovered are emitted via `peer:discovery` so applications can take any desired action.
+* Libp2p defaults to automatically connecting to new peers, when under the [ConnectionManager](https://github.com/libp2p/js-libp2p-connection-manager) low watermark (minimum peers).
+  * Applications can disable this via the `peerDiscovery.autoDial` config property, and handle connections themselves.
+  * Applications who have not disabled this should **never** connect on peer discovery. Applications should use the `peer:connect` event if they wish to take a specific action on new peers.
+
+## Scenarios
+In any scenario, if a peer is discovered it should be added to the PeerBook. This ensures that even if we don't dial to a node when we discover it, we know about it in the event that it becomes known as a provider for something we need. The scenarios listed below detail what actions the auto dialer will take when peers are discovered.
+
+### 1. Joining the network
+The node is new and needs to join the network. It currently has 0 peers.
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery)
+
+### Action to take
+Connect to discovered peers. This should have some degree of concurrency limiting. While the case should be low, if we immediately discover more peers than our high watermark we should avoid dialing them all.
+
+### 2. Connected to some
+The node is connected to other nodes. The current number of connections is less than the desired low watermark.
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery) and [Active Discovery](#active-discovery)
+
+### Action to take
+Connect to discovered peers. This should have some degree of concurrency limiting. The concurrency may need to be modified to reflect the current number of peers connected. The more peers we have, the lower the concurrency may need to be.
+
+### 3. Connected to enough
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery) and [Active Discovery](#active-discovery)
+
+### Action to take
+None. If we are connected to enough peers, the low watermark, we should not connect to discovered peers. As other peers discover us, they may connect to us based on their current scenario.
+
+For example, a long running node with adequate peers is on an MDNS network. A new peer joins the network and both become aware of each other. The new peer should be the peer that dials, as it has too few peers. The existing node has no reason to dial the new peer, but should keep a record of it in case it later becomes an important node due to its contents/capabilities.
+
+Avoiding dials above the low watermark also allows for a pool of connections to be reserved for application specific actions, such as connecting to a specific content provider via a DHT query to find that content (ipfs-bitswap).
+
+### 4. Connected to too many
+The node has more connections than it wants. The current number of connections is greater than the high watermark.
+
+[WIP Connection Manager v2 spec](https://github.com/libp2p/specs/pull/161)
+**Discovery Mechanisms**: [Ambient Discovery](#ambient-discovery) and [Active Discovery](#active-discovery)
+
+### Action to take
+None, the `ConnectionManager` will automatically prune connections.
+
+## Discovery Mechanisms
+Means of which a libp2p node discovers other peers.
+
+### Active Discovery
+Through active use of the libp2p network, a node may discovery peers.
+
+* Content/Peer routing (DHT, delegated, etc) provider and peer queries
+* DHT random walk
+* Rendezvous servers
+
+### Ambient Discovery
+Leveraging known addresses, or network discovery mechanisms, a node may discover peers outside of the bounds of the libp2p network.
+
+* Bootstrap
+* MDNS
+* proximity based (bluetooth, sound, etc)

README.md

@@ -160,6 +160,7 @@ class Node extends libp2p {
       // libp2p config options (typically found on a config.json)
       config: {                       // The config object is the part of the config that can go into a file, config.json.
         peerDiscovery: {
+          autoDial: true,             // Auto connect to discovered peers (limited by ConnectionManager minPeers)
           mdns: {                     // mdns options
             interval: 1000,           // ms
             enabled: true
@@ -305,6 +306,9 @@ Required keys in the `options` object:
 
 > Peer has been discovered.
 
+If `autoDial` is `true`, applications should **not** attempt to connect to the peer
+unless they are performing a specific action. See [peer discovery and auto dial](./PEER_DISCOVERY.md) for more information.
+
 - `peer`: instance of [PeerInfo][]
 
 ##### `libp2p.on('peer:connect', (peer) => {})`
@@ -509,18 +513,6 @@ Some available network protectors:
 > npm run test:browser
 ```
 
-#### Run interop tests
-
-```sh
-N/A
-```
-
-#### Run benchmark tests
-
-```sh
-N/A
-```
-
 ### Packages
 
 List of packages currently in existence for libp2p

package.json

@@ -45,7 +45,7 @@
     "libp2p-connection-manager": "~0.0.2",
     "libp2p-floodsub": "~0.15.8",
     "libp2p-ping": "~0.8.5",
-    "libp2p-switch": "~0.42.7",
+    "libp2p-switch": "~0.42.8",
     "libp2p-websockets": "~0.12.2",
     "mafmt": "^6.0.7",
     "multiaddr": "^6.0.6",

src/config.js

@@ -12,58 +12,88 @@ const transport = s.union([
   }),
   'function'
 ])
+const modulesSchema = s({
+  connEncryption: optional(list([s('object|function')])),
+  // this is hacky to simulate optional because interface doesnt work correctly with it
+  // change to optional when fixed upstream
+  connProtector: s.union(['undefined', s.interface({ protect: 'function' })]),
+  contentRouting: optional(list(['object'])),
+  dht: optional(s('null|function|object')),
+  peerDiscovery: optional(list([s('object|function')])),
+  peerRouting: optional(list(['object'])),
+  streamMuxer: optional(list([s('object|function')])),
+  transport: s.intersection([[transport], s.interface({
+    length (v) {
+      return v > 0 ? true : 'ERROR_EMPTY'
+    }
+  })])
+})
+
+const configSchema = s({
+  peerDiscovery: s('object', {
+    autoDial: true
+  }),
+  relay: s({
+    enabled: 'boolean',
+    hop: optional(s({
+      enabled: 'boolean',
+      active: 'boolean'
+    }, {
+      // HOP defaults
+      enabled: false,
+      active: false
+    }))
+  }, {
+    // Relay defaults
+    enabled: true
+  }),
+  // DHT config
+  dht: s({
+    kBucketSize: 'number',
+    enabled: 'boolean?',
+    validators: 'object?',
+    selectors: 'object?',
+    randomWalk: optional(s({
+      enabled: 'boolean?',
+      queriesPerPeriod: 'number?',
+      interval: 'number?',
+      timeout: 'number?'
+    }, {
+      // random walk defaults
+      enabled: false, // disabled waiting for https://github.com/libp2p/js-libp2p-kad-dht/issues/86
+      queriesPerPeriod: 1,
+      interval: 30000,
+      timeout: 10000
+    }))
+  }, {
+    // DHT defaults
+    enabled: false,
+    kBucketSize: 20,
+    enabledDiscovery: false
+  }),
+  // Experimental config
+  EXPERIMENTAL: s({
+    pubsub: 'boolean'
+  }, {
+    // Experimental defaults
+    pubsub: false
+  })
+}, {
+  relay: {},
+  dht: {},
+  EXPERIMENTAL: {}
+})
 
-const optionsSchema = s(
-  {
-    connectionManager: 'object?',
-    datastore: 'object?',
-    peerInfo: 'object',
-    peerBook: 'object?',
-    modules: s({
-      connEncryption: optional(list([s('object|function')])),
-      // this is hacky to simulate optional because interface doesnt work correctly with it
-      // change to optional when fixed upstream
-      connProtector: s.union(['undefined', s.interface({ protect: 'function' })]),
-      contentRouting: optional(list(['object'])),
-      dht: optional(s('null|function|object')),
-      peerDiscovery: optional(list([s('object|function')])),
-      peerRouting: optional(list(['object'])),
-      streamMuxer: optional(list([s('object|function')])),
-      transport: s.intersection([[transport], s.interface({
-        length (v) {
-          return v > 0 ? true : 'ERROR_EMPTY'
-        }
-      })])
-    }),
-    config: s({
-      peerDiscovery: 'object?',
-      relay: s({
-        enabled: 'boolean',
-        hop: optional(s({
-          enabled: 'boolean',
-          active: 'boolean'
-        },
-        { enabled: false, active: false }))
-      }, { enabled: true, hop: {} }),
-      dht: s({
-        kBucketSize: 'number',
-        enabled: 'boolean?',
-        randomWalk: optional(s({
-          enabled: 'boolean?', // disabled waiting for https://github.com/libp2p/js-libp2p-kad-dht/issues/86
-          queriesPerPeriod: 'number?',
-          interval: 'number?',
-          timeout: 'number?'
-        }, { enabled: false, queriesPerPeriod: 1, interval: 30000, timeout: 10000 })),
-        validators: 'object?',
-        selectors: 'object?'
-      }, { enabled: false, kBucketSize: 20, enabledDiscovery: false }),
-      EXPERIMENTAL: s({
-        pubsub: 'boolean'
-      }, { pubsub: false })
-    }, { relay: {}, dht: {}, EXPERIMENTAL: {} })
-  },
-  { config: {}, modules: {} }
-)
+const optionsSchema = s({
+  connectionManager: s('object', {
+    minPeers: 25
+  }),
+  datastore: 'object?',
+  peerInfo: 'object',
+  peerBook: 'object?',
+  modules: modulesSchema,
+  config: configSchema
+})
 
 module.exports.validate = (opts) => {
   const [error, options] = optionsSchema.validate(opts)
@@ -78,5 +108,9 @@ module.exports.validate = (opts) => {
     }
   }
 
+  if (options.config.peerDiscovery.autoDial === undefined) {
+    options.config.peerDiscovery.autoDial = true
+  }
+
   return options
 }