autobee 2.7.0 → 2.7.1

package/README.md

@@ -256,13 +256,17 @@ 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.
 
+During discovery `target` is a view opened for the candidate, and reads through it carry the fast-forward's timeout. Anything else the hook awaits is unbounded, so if it reaches beyond that view, put a timeout on it: the candidate waits on the hook, and so does closing it.
+
 #### `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.
+`view` is opened and closed through the `open` and `close` handlers, so don't build or close a db of your own. Reads through it carry the fast-forward's timeout, so a warmup that needs blocks nobody serves fails the candidate instead of hanging.
+
+Only reads through `view` are bounded. Anything else the handler awaits, such as other cores or your own network calls, is up to you to time out: the fast-forward waits on the handler, and an abandoned candidate cannot finish closing until it returns.
 
 #### `fastForward.boot`
 

package/index.js

@@ -437,15 +437,17 @@ module.exports = class Autobee extends ReadyResource {
   }
 
   // the view an oplog head points at, opened and closed through the handlers
-  openViewAt(oplog) {
+  openViewAt(oplog, { timeout } = {}) {
     const v = oplog.op.views.view
     if (!v) return null
 
-    return this.openView({ key: v.key, length: v.start + v.length })
+    return this.openView({ key: v.key, length: v.start + v.length }, { timeout })
   }
 
-  openView(head) {
-    return new ApplyView(this.bee.checkout({ key: head.key, length: head.length }), this)
+  // timeout bounds every hypercore read done through the view, defaults to the main bee's
+  openView(head, { timeout } = {}) {
+    const bee = this.bee.checkout({ key: head.key, length: head.length, timeout })
+    return new ApplyView(bee, this)
   }
 
   openCore(key) {

package/lib/fast-forward.js

@@ -56,7 +56,9 @@ class FastForward {
       return null
     }
 
-    return new FastForward(auto, batchToHead(verified.op.views.system))
+    return new FastForward(auto, batchToHead(verified.op.views.system), {
+      timeout: timeout || DEFAULT_OP_TIMEOUT
+    })
   }
 
   static async fromHeads(auto, heads, { force = false, timeout = 0 } = {}) {
@@ -107,7 +109,7 @@ class FastForward {
     candidates.sort((a, b) => b.op.views.flushes - a.op.views.flushes)
 
     for (const res of candidates) {
-      const trusted = await FastForward.mostRecentTrusted(auto, res, reference)
+      const trusted = await FastForward.mostRecentTrusted(auto, res, reference, timeout)
       if (trusted === null) continue
       if (auto.fastForwarding || auto.fastForwardTo) return null
 
@@ -130,8 +132,8 @@ class FastForward {
     }
   }
 
-  static async mostRecentTrusted(auto, head, reference) {
-    const opened = auto.openViewAt(head)
+  static async mostRecentTrusted(auto, head, reference, timeout) {
+    const opened = auto.openViewAt(head, { timeout })
     if (opened === null) return null
 
     try {
@@ -206,7 +208,7 @@ class FastForward {
   _startWarmup() {
     if (!this.auto._warmup || !this.system.view.length) return false
 
-    this.warmupView = this.auto.openView(this.system.view)
+    this.warmupView = this.auto.openView(this.system.view, { timeout: this.timeout })
 
     // ensure thenable
     this.warmup = Promise.resolve(this.auto._warmup(this.warmupView.view))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autobee",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "Bee based autobase",
   "license": "Apache-2.0",
   "author": "Holepunch Inc.",
@@ -27,7 +27,7 @@
     "autobee-wakeup": "^1.1.3",
     "b4a": "^1.8.0",
     "compact-encoding": "^3.3.0",
-    "hyperbee2": "^2.10.3",
+    "hyperbee2": "^2.16.0",
     "hypercore": "^11.33.2",
     "hypercore-id-encoding": "^1.3.0",
     "hyperschema": "^1.20.1",