hypercore 10.0.0-alpha.33 → 10.0.0-alpha.34

package/README.md

@@ -280,6 +280,13 @@ const socket = net.connect(...)
 socket.pipe(localCore.replicate(true)).pipe(socket)
 ```
 
+#### `const done = core.findingPeers()`
+
+Create a hook that tells Hypercore you are finding peers for this core in the background. Call `done` when your current discovery iteration is done.
+If you're using Hyperswarm, you'd normally call this after a `swarm.flush()` finishes.
+
+This allows `core.update` to wait for either the `findingPeers` hook to finish or one peer to appear before deciding whether it should wait for a merkle tree update before returning.
+
 #### `core.on('append')`
 
 Emitted when the core has been appended to (i.e. has a new length / byteLength), either locally or remotely.

package/index.js

@@ -74,6 +74,7 @@ module.exports = class Hypercore extends EventEmitter {
 
     this._preappend = preappend.bind(this)
     this._snapshot = opts.snapshot || null
+    this._findingPeers = 0
   }
 
   [inspect] (depth, opts) {
@@ -184,6 +185,7 @@ module.exports = class Hypercore extends EventEmitter {
     this._passCapabilities(from)
     this.sessions = from.sessions
     this.storage = from.storage
+    this.replicator.findingPeers += this._findingPeers
 
     this.sessions.push(this)
   }
@@ -271,6 +273,8 @@ module.exports = class Hypercore extends EventEmitter {
       onupload: this._onupload.bind(this)
     })
 
+    this.replicator.findingPeers += this._findingPeers
+
     if (!this.encryption && opts.encryptionKey) {
       this.encryption = new BlockEncryption(opts.encryptionKey, this.key)
     }
@@ -301,9 +305,12 @@ module.exports = class Hypercore extends EventEmitter {
     for (const ext of gc) ext.destroy()
 
     if (this.replicator !== null) {
+      this.replicator.findingPeers -= this._findingPeers
       this.replicator.clearRequests(this.activeRequests)
     }
 
+    this._findingPeers = 0
+
     if (this.sessions.length) {
       // if this is the last session and we are auto closing, trigger that first to enforce error handling
       if (this.sessions.length === 1 && this.autoClose) await this.sessions[0].close()
@@ -432,6 +439,22 @@ module.exports = class Hypercore extends EventEmitter {
     return null
   }
 
+  findingPeers () {
+    this._findingPeers++
+    if (this.replicator !== null && !this.closing) this.replicator.findingPeers++
+
+    let once = true
+
+    return () => {
+      if (this.closing || !once) return
+      once = false
+      this._findingPeers--
+      if (this.replicator !== null && --this.replicator.findingPeers === 0) {
+        this.replicator.updateAll()
+      }
+    }
+  }
+
   async update (opts) {
     if (this.opened === false) await this.opening
 
@@ -441,6 +464,7 @@ module.exports = class Hypercore extends EventEmitter {
     const activeRequests = (opts && opts.activeRequests) || this.activeRequests
     const req = this.replicator.addUpgrade(activeRequests)
 
+    // TODO: if snapshot, also update the length/byteLength to latest
     return req.promise
   }
 

package/lib/replicator.js

@@ -842,6 +842,7 @@ module.exports = class Replicator {
     this.onpeerupdate = onpeerupdate
     this.onupload = onupload
     this.peers = []
+    this.findingPeers = 0 // updateable from the outside
 
     this._inflight = new InflightTracker()
     this._blocks = new BlockTracker(core)
@@ -854,6 +855,7 @@ module.exports = class Replicator {
     this._reorgs = []
     this._ranges = []
 
+    this._hadPeers = false
     this._ifAvailable = 0
     this._updatesPending = 0
     this._applyingReorg = false
@@ -959,6 +961,7 @@ module.exports = class Replicator {
   // Do this when we have more tests.
   _checkUpgradeIfAvailable () {
     if (this._ifAvailable > 0 || this._upgrade === null || this._upgrade.refs.length === 0) return
+    if (this._hadPeers === false && this.findingPeers > 0) return
 
     // check if a peer can upgrade us
 
@@ -1047,6 +1050,7 @@ module.exports = class Replicator {
   }
 
   _addPeer (peer) {
+    this._hadPeers = true
     this.peers.push(peer)
     this.updatePeer(peer)
     this.onpeerupdate(true, peer)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore",
-  "version": "10.0.0-alpha.33",
+  "version": "10.0.0-alpha.34",
   "description": "Hypercore 10",
   "main": "index.js",
   "scripts": {