migrate from ssb-gossip to ssb-conn

Author: staltz

lib/depject/invite/invite.js

@@ -6,7 +6,7 @@ const nest = require('depnest')
 
 exports.needs = nest({
   'sbot.async.publish': 'first',
-  'sbot.async.gossipConnect': 'first',
+  'sbot.async.connRememberConnect': 'first',
   'contact.async.followerOf': 'first',
   'keys.sync.id': 'first',
   'config.sync.load': 'first'
@@ -26,7 +26,7 @@ exports.create = function (api) {
 
     if (!data) return cb(new Error('Not a valid invite code. Please make sure you copied the entire code and try again.'))
 
-    api.sbot.async.gossipConnect(data.remote, function (err) {
+    api.sbot.async.connRememberConnect(data.remote, {type: 'pub'}, (err) => {
       if (err) console.log(err)
     })
 

lib/depject/page/html/render/public.js

@@ -6,9 +6,11 @@ exports.needs = nest({
     obs: {
       connectedPeers: 'first',
       localPeers: 'first',
+      stagedPeers: 'first',
       connection: 'first'
     }
   },
+  'sbot.async.connConnect': 'first',
   'sbot.pull.stream': 'first',
   'sbot.pull.resumeStream': 'first',
   'about.html.image': 'first',
@@ -30,6 +32,7 @@ exports.needs = nest({
   'contact.obs.following': 'first',
   'contact.obs.followers': 'first',
   'contact.obs.blocking': 'first',
+  'contact.async.follow': 'first',
   'channel.obs': {
     subscribed: 'first',
     recent: 'first'
@@ -58,8 +61,10 @@ exports.create = function (api) {
     const recentChannels = api.channel.obs.recent(8)
     const channelsLoading = computed([subscribedChannels.sync, recentChannels.sync], (...args) => !args.every(Boolean))
     const connectedPeers = api.sbot.obs.connectedPeers()
+    const stagedPeers = api.sbot.obs.stagedPeers()
     const localPeers = api.sbot.obs.localPeers()
-    const connectedPubs = computed([connectedPeers, localPeers], (c, l) => c.filter(x => !l.includes(x)))
+    const localPeersKeys = map(api.sbot.obs.localPeers(), peer => peer.data.key)
+    const connectedPubs = computed([connectedPeers, localPeersKeys], (c, l) => c.filter(x => !l.includes(x.data.key)))
     const contact = api.profile.obs.contact(id)
 
     const prepend = [
@@ -102,7 +107,7 @@ exports.create = function (api) {
     return result
 
     function getSidebar () {
-      const whoToFollow = computed([api.profile.obs.recentlyUpdated(), following, blocking, localPeers], (recent, ...ignoreFeeds) => {
+      const whoToFollow = computed([api.profile.obs.recentlyUpdated(), following, blocking, localPeersKeys ], (recent, ...ignoreFeeds) => {
         return recent.filter(x => x !== id && !ignoreFeeds.some(f => f.includes(x))).slice(0, 10)
       })
       return [
@@ -145,6 +150,7 @@ exports.create = function (api) {
         ]),
 
         PeerList(localPeers, i18n('Local')),
+        SuggestedPeerList(stagedPeers, i18n('Possible connections')),
         PeerList(connectedPubs, i18n('Connected Pubs')),
 
         when(computed(whoToFollow, x => x.length), h('h2', i18n('Who to follow'))),
@@ -167,14 +173,16 @@ exports.create = function (api) {
       ]
     }
 
-    function PeerList (ids, title) {
+    function PeerList (peers, title) {
       return [
-        when(computed(ids, x => x.length), h('h2', title)),
+        when(computed(peers, arr => arr.length), h('h2', title)),
         h('div', {
           classList: 'ProfileList'
         }, [
-          map(ids, (id) => {
-            const connected = computed([connectedPeers, id], (peers, id) => peers.includes(id))
+          map(peers, peer => {
+            const address = peer.address
+            const connected = peer.data.state === 'connected'
+            const id = peer.data.key
             return h('a.profile', {
               classList: [
                 when(connected, '-connected')
@@ -189,7 +197,28 @@ exports.create = function (api) {
                 api.progress.html.peer(id)
               ]),
               h('div.controls', [
-                h('a.disconnect', { href: '#', 'ev-click': send(disconnect, id), title: i18n('Force Disconnect') }, ['x'])
+                h('a.disconnect', { href: '#', 'ev-click': send(disconnect, address), title: i18n('Force Disconnect') }, ['x'])
+              ])
+            ])
+          })
+        ])
+      ]
+    }
+
+    function SuggestedPeerList (peers, title) {
+      return [
+        when(computed(peers, arr => arr.length), h('h2', title)),
+        h('div', {
+          classList: 'ProfileList'
+        }, [
+          map(peers, peer => {
+            const id = peer.data.key
+            return h('a.profile', { href: id }, [
+              h('div.main', [
+                h('div.name', [api.about.obs.name(id)])
+              ]),
+              h('div.controls', [
+                h('a.connect', { href: '#', 'ev-click': send(connect, peer), title: i18n('Connect') }, [i18n('Connect')])
               ])
             ])
           })
@@ -224,9 +253,13 @@ exports.create = function (api) {
       return api.feed.html.followerWarning(shownWhen, explanation)
     }
 
-    function disconnect (id) {
-      onceTrue(api.sbot.obs.connection, (sbot) => {
-        sbot.patchwork.disconnect(id)
+    function connect (peer) {
+      api.sbot.async.connConnect(peer.address, peer.data, () => {})
+    }
+
+    function disconnect (addr) {
+      onceTrue(api.sbot.obs.connection, sbot => {
+        sbot.patchwork.disconnect(addr)
       })
     }
   }

lib/depject/sbot.js

@@ -27,7 +27,8 @@ exports.gives = {
       get: true,
       publish: true,
       addBlob: true,
-      gossipConnect: true,
+      connConnect: true,
+      connRememberConnect: true,
       friendsGet: true,
       acceptDHT: true,
       createDHT: true
@@ -46,7 +47,8 @@ exports.gives = {
       connectionStatus: true,
       connection: true,
       connectedPeers: true,
-      localPeers: true
+      localPeers: true,
+      stagedPeers: true
     }
   }
 }
@@ -61,6 +63,7 @@ exports.create = function (api) {
   const connectionStatus = Value()
   const connectedPeers = MutantSet()
   const localPeers = MutantSet()
+  const stagedPeers = MutantSet()
 
   const rec = Reconnect(function (isConn) {
     function notify (value) {
@@ -96,40 +99,22 @@ exports.create = function (api) {
     })
   })
 
-  setInterval(function () {
-    if (sbot) {
-      sbot.gossip.peers((err, peers) => {
-        if (err) return console.error(err)
-        localPeers.set(peers.filter(x => x.source === 'local').map(x => x.key))
-        connectedPeers.set(peers.filter(x => x.state === 'connected').map(x => x.key))
-      })
-    }
-  }, 1000 * 60)
-
   watch(connection, (sbot) => {
     if (sbot) {
-      sbot.gossip.peers((err, peers) => {
-        if (err) return console.error(err)
-        connectedPeers.set(peers.filter(x => x.state === 'connected').map(x => x.key))
-        localPeers.set(peers.filter(x => x.source === 'local').map(x => x.key))
-      })
       pull(
-        sbot.gossip.changes(),
-        pull.drain(data => {
-          if (data.peer) {
-            if (data.type === 'remove' || data.type === 'disconnect') {
-              connectedPeers.delete(data.peer.key)
-            } else {
-              if (data.peer.source === 'local') {
-                localPeers.add(data.peer.key)
-              }
-              if (data.peer.state === 'connected') {
-                connectedPeers.add(data.peer.key)
-              } else {
-                connectedPeers.delete(data.peer.key)
-              }
-            }
-          }
+        sbot.conn.peers(),
+        pull.drain(entries => {
+          var peers = entries.filter(([, x]) => !!x.key).map(([address, data]) => ({ address, data }))
+          localPeers.set(peers.filter(peer => peer.data.type === 'lan'))
+          connectedPeers.set(peers.filter(peer => peer.data.state === 'connected'))
+        })
+      )
+
+      pull(
+        sbot.conn.stagedPeers(),
+        pull.drain(entries => {
+          var peers = entries.filter(([, x]) => !!x.key).map(([address, data]) => ({ address, data }))
+          stagedPeers.set(peers)
         })
       )
     }
@@ -215,8 +200,14 @@ exports.create = function (api) {
             sbot.blobs.add(cb)
           )
         }),
-        gossipConnect: rec.async(function (opts, cb) {
-          sbot.gossip.connect(opts, cb)
+        connConnect: rec.async(function (address, data, cb) {
+          sbot.conn.connect(address, data, cb)
+        }),
+        connRememberConnect: rec.async(function (address, data, cb) {
+          sbot.conn.remember(address, {autoconnect: true, ...data}, (err) => {
+            if (err) cb(err)
+            else sbot.conn.connect(address, data, cb)
+          })
         }),
         friendsGet: rec.async(function (opts, cb) {
           sbot.friends.get(opts, cb)
@@ -276,7 +267,8 @@ exports.create = function (api) {
         connectionStatus: (listener) => connectionStatus(listener),
         connection,
         connectedPeers: () => connectedPeers,
-        localPeers: () => localPeers
+        localPeers: () => localPeers,
+        stagedPeers: () => stagedPeers
       }
     }
   }

lib/plugins/index.js

@@ -70,16 +70,9 @@ exports.init = function (ssb, config) {
     getSubscriptions: subscriptions.get,
     liveBacklinks: LiveBacklinks(ssb),
 
-    disconnect: function (opts, cb) {
-      if (ref.isFeed(opts)) opts = { key: opts }
-      if (opts && (opts.key || opts.host)) {
-        ssb.gossip.peers().find(peer => {
-          if (peer.state === 'connected' && (peer.key === opts.key || peer.host === opts.host)) {
-            ssb.gossip.disconnect(peer, cb)
-            return true
-          }
-        })
-      }
+    disconnect: function (addr, cb) {
+      ssb.conn.disconnect(addr, cb)
+      return true
     }
   }
 
@@ -88,22 +81,6 @@ exports.init = function (ssb, config) {
   }
 
   // CONNECTIONS
-  // prioritize friends for pub connections and remove blocked pubs (on startup)
-  patchwork.contacts.raw.get((err, graph) => {
-    if (!err) {
-      ssb.gossip.peers().slice().forEach((peer) => {
-        if (graph && graph[ssb.id]) {
-          const value = graph[ssb.id][peer.key]
-          if (value === true) { // following pub
-            ssb.gossip.add(peer, 'friends')
-          } else if (value === false) { // blocked pub
-            ssb.gossip.remove(peer.key)
-          }
-        }
-      })
-    }
-  })
-
   // refuse connections from blocked peers
   ssb.auth.hook(function (fn, args) {
     const self = this
@@ -129,9 +106,9 @@ exports.init = function (ssb, config) {
         pull.drain(function (value) {
           if (value.sync && config.gossip && config.gossip.prune) {
             // clean up pubs announced by peers more than 2 hops away if `--gossip.prune=true`
-            ssb.gossip.peers().slice().forEach(peer => {
-              if (!discovered.has(peer.key)) {
-                ssb.gossip.remove(peer, 'pub')
+            ssb.conn.query().peersConnectable('db').forEach(([addr, data]) => {
+              if (!discovered.has(data.key)) {
+                ssb.conn.forget(addr)
               }
             })
           }
@@ -142,7 +119,10 @@ exports.init = function (ssb, config) {
             const blocking = graph && graph[ssb.id] && graph[ssb.id][address.key] === false
             if (!blocking) {
               discovered.add(address.key)
-              ssb.gossip.add(address, 'pub')
+              try {
+                const msAddr = ref.toMultiServerAddress(address);
+                ssb.conn.remember(msAddr, {type: 'pub', key: address.key, autoconnect: true});
+              } catch (err) {}
             }
           }
         })
@@ -162,18 +142,6 @@ exports.init = function (ssb, config) {
 
         // request (or unrequest) the feed
         ssb.replicate.request(feedId, state[feedId] === true)
-
-        // if blocking and a pub, drop connection and remove from peer table
-        if (state[feedId] === false) {
-          const peer = ssb.gossip.get(feedId)
-          if (peer) {
-            if (peer.state === 'connected') {
-              ssb.gossip.disconnect(peer, () => {
-                ssb.gossip.remove(peer)
-              })
-            }
-          }
-        }
       }
     })
   )

lib/server-process.js

@@ -21,14 +21,14 @@ const fixPath = require('fix-path')
 
 const createSbot = require('secret-stack')()
   .use(require('ssb-db'))
-  .use(require('ssb-legacy-conn'))
-  .use(require('ssb-local'))
+  .use(require('ssb-conn'))
+  .use(require('ssb-lan'))
   .use(require('ssb-logging'))
   .use(require('ssb-master'))
   .use(require('ssb-no-auth'))
   .use(require('ssb-replicate'))
   .use(require('ssb-unix-socket'))
-  // .use(require('ssb-friends')) // woah! (being handled in sbot/index.js and sbot/contacts.js)
+  .use(require('ssb-friends')) // not strictly required, but helps ssb-conn a lot
   .use(require('ssb-blobs'))
   .use(require('ssb-backlinks'))
   .use(require('ssb-about'))

locales/en.json

@@ -311,5 +311,7 @@
 	"eo": "eo",
 	"zh-TW": "zh-TW",
 	"Blocking": "Blocking",
-	"Automatically delete messages from blocked authors. This is irreversible and will cause problems with clients that share the database but do not support deleted messages. Enable at your own risk!": "Automatically delete messages from blocked authors. This is irreversible and will cause problems with clients that share the database but do not support deleted messages. Enable at your own risk!"
-}
+	"Automatically delete messages from blocked authors. This is irreversible and will cause problems with clients that share the database but do not support deleted messages. Enable at your own risk!": "Automatically delete messages from blocked authors. This is irreversible and will cause problems with clients that share the database but do not support deleted messages. Enable at your own risk!",
+	"Possible connections": "Possible connections",
+	"Connect": "Connect"
+}