autobee 2.5.5 → 2.6.0

package/README.md

@@ -81,6 +81,7 @@ Options:
   optimistic: true,              // allow optimistic writes from unknown writers
   isTrusted (key, reference) {}, // do we trust this writer, see Fast-forward
   mostRecentTrusted (target, reference) {}, // the head we vouch for, see Fast-forward
+  warmup (view) {},              // prepare a candidate view, see Fast-forward
   ackThreshold: 32,              // flushes we may fall behind before acking, see Acking
   fastForward: {}                // see Fast-forward
 }
@@ -255,6 +256,14 @@ Return the oplog head you most recently vouched for, given the `target` view bei
 
 Called at flush time to stamp your own oplog (with your view as `target` and a `null` reference), and again per candidate during discovery.
 
+#### `warmup(view)`
+
+Prepare a candidate `view` before the fast-forward onto it is applied.
+
+Called as soon as the candidate's view head is known, and runs alongside the block downloads the fast-forward is already doing rather than after them. Throw or reject to reject the candidate: the fast-forward is abandoned and the usual apply path catches up instead.
+
+`view` is opened and closed through the `open` and `close` handlers, so don't build or close a db of your own.
+
 #### `fastForward.boot`
 
 ```js

package/index.js

@@ -134,6 +134,7 @@ module.exports = class Autobee extends ReadyResource {
     this._now = handlers.now || Date.now // overridable for clock-drift tests
     this._preapply = handlers.preapply || null
     this._preApplied = false
+    this._warmup = handlers.warmup || null
     this._hasApply = !!handlers.apply
     this._hasUpdate = !!handlers.update
     this._needsUpdate = false
@@ -440,7 +441,11 @@ module.exports = class Autobee extends ReadyResource {
     const v = oplog.op.views.view
     if (!v) return null
 
-    return new ApplyView(this.bee.checkout({ key: v.key, length: v.start + v.length }), this)
+    return this.openView({ key: v.key, length: v.start + v.length })
+  }
+
+  openView(head) {
+    return new ApplyView(this.bee.checkout({ key: head.key, length: head.length }), this)
   }
 
   openCore(key) {

package/lib/fast-forward.js

@@ -30,6 +30,8 @@ class FastForward {
     this.running = null
     this.failed = false
     this.cores = []
+    this.warmup = null
+    this.warmupView = null
   }
 
   static DEFAULT_TIMEOUT = DEFAULT_OP_TIMEOUT
@@ -170,6 +172,8 @@ class FastForward {
 
     const promises = []
 
+    if (this._startWarmup()) promises.push(this.warmup)
+
     // ensure local key is locally available always
     promises.push(this.system.get(this.auto.local.key, { timeout: this.timeout }))
 
@@ -199,6 +203,17 @@ class FastForward {
     }
   }
 
+  _startWarmup() {
+    if (!this.auto._warmup || !this.system.view.length) return false
+
+    this.warmupView = this.auto.openView(this.system.view)
+
+    // ensure thenable
+    this.warmup = Promise.resolve(this.auto._warmup(this.warmupView.view))
+
+    return true
+  }
+
   async _resolveLength() {
     const core = this.auto.store.get({ key: this.head.key })
     this.cores.push(core)
@@ -278,6 +293,22 @@ class FastForward {
   async close() {
     this.destroyed = true
     this.clearRequests()
+
+    // close view to cancel inflight reads
+    if (this.warmupView) {
+      const view = this.warmupView
+      this.warmupView = null
+      await view.close()
+    }
+
+    if (this.warmup) {
+      try {
+        await this.warmup
+      } catch (err) {
+        safetyCatch(err)
+      }
+    }
+
     if (this.system) await this.system.close()
     for (const core of this.cores) await core.close()
   }

package/lib/writers.js

@@ -134,10 +134,20 @@ class ActiveWriters {
     // peeked batches were read against the pre-reboot system, drop them
     this._pendingBuffer.clear()
 
-    if (this.localWriter && !this.localWriter.isClosed) {
-      await this.updateLocalState()
+    const local = this.localWriter && !this.localWriter.isClosed ? this.localWriter : null
+
+    const info = []
+    for (const w of this.active.values()) {
+      if (w.isFrozen && w !== this.localWriter) continue
+      info.push(w.system.get(w.core.key))
     }
 
+    if (local) info.push(local.system.get(local.core.key))
+
+    await Promise.all(info)
+
+    if (local) await this.updateLocalState()
+
     for (const writer of this.active.values()) {
       if (writer.isFrozen && writer !== this.localWriter) await writer.detachAndClose()
       else await writer.reset()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autobee",
-  "version": "2.5.5",
+  "version": "2.6.0",
   "description": "Bee based autobase",
   "license": "Apache-2.0",
   "author": "Holepunch Inc.",