autobee 2.2.1 → 2.3.0

package/README.md

@@ -247,17 +247,16 @@ Called at flush time to stamp your own oplog (with your view as `target` and a `
 
 ```js
 {
-  head: { key, length },       // oplog head to boot from
-  legacy: { key, length },     // pre-2.0 pointer, see below
-  bootCondition (target, reference) {} // optional gate on the view we would land on
+  head: { key, length },  // oplog head to boot from
+  legacy: { key, length } // pre-2.0 pointer, see below
 }
 ```
 
 Pass one of `head` or `legacy`, not both.
 
-Without `bootCondition` this is a single attempt that gives up if the head cannot be read; with one it parks until the condition is satisfied, which today means indefinitely if it never is.
+`head` must be a v3 or newer oplog node. `length` is a floor: the key is searched for its latest oplog head at or past it, and the boot lands ungated on the views that head stamps. It is a single attempt: use `moveTo` if you need to retry.
 
-`legacy` is for records written before boot heads were oplog heads: the key is a _system_ head and a `0` length is resolved from the core. It boots ungated - `bootCondition` does not apply - and will be removed, so don't reach for it. A bare `{ key, length }` in place of the whole struct means the same thing, older still.
+`legacy` is the pre-2.0 pointer: a _system_ head whose `0` length resolves from the core. It will be removed, so don't reach for it. A bare `{ key, length }` in place of the whole struct means the same.
 
 #### `fastForward.conservative`
 
@@ -265,9 +264,11 @@ Defaults to `true`: only fast-forward onto a head a connected peer can serve who
 
 The check covers the oplog head only, not the system and view cores the fast-forward then reads.
 
-#### `await db.moveTo(head)`
+#### `await db.moveTo(head, [options])`
 
-Fast-forward onto an oplog head, ignoring the usual distance and conservative checks. Resolves `{ to, from }`.
+Fast-forward onto an oplog head, ignoring the usual distance and conservative checks. Resolves `{ to, from }`, or `null` if the head could not be booted.
+
+Pass `{ timeout }` to bound the reads, so a head nobody can serve fails instead of hanging.
 
 ### Encryption
 

package/index.js

@@ -14,7 +14,6 @@ const asserts = require('./lib/asserts.js')
 const boot = require('./lib/boot.js')
 const { resolveWeight, currentWeight } = require('./lib/witness.js')
 const encoding = require('./lib/encoding.js')
-const { LEGACY_OPLOG_VERSION } = require('./lib/constants.js')
 const FastForward = require('./lib/fast-forward.js')
 const System = require('./lib/system.js')
 const ApplyCalls = require('./lib/apply-calls.js')
@@ -72,7 +71,7 @@ module.exports = class Autobee extends ReadyResource {
     this.stats = { undos: 0, fastForwards: 0, drains: 0, applies: 0, appends: 0 }
 
     const systemStore = this.store.session()
-    this.system = new System(systemStore, this.name, {
+    this.system = new System(this, systemStore, {
       core: systemStore.get({ preload: this._getCorePreload('system') }),
       encrypted: this.encrypted,
       getEncryptionProvider: this.getSystemEncryption
@@ -119,7 +118,6 @@ module.exports = class Autobee extends ReadyResource {
     this._appending = []
     this._draining = null
     this._updating = null
-    this._bootWait = null
 
     this.legacyViews = handlers.legacyViews || []
 
@@ -145,7 +143,6 @@ module.exports = class Autobee extends ReadyResource {
     this.interrupted = null
     this._interrupting = false
     this._onErrorBound = this._onError.bind(this)
-    this._bumpSoonBound = this.bumpSoon.bind(this)
     this._onGroupUpdateBound = this._onGroupUpdate.bind(this)
 
     this.wakeupCapability = null
@@ -153,7 +150,7 @@ module.exports = class Autobee extends ReadyResource {
     this.previousDrain = 0
 
     this._catchupMigratedNodes = null
-    this._migratedHead = null
+    this._migrating = false
     this._prebooting = null
 
     this.ready().catch(noop)
@@ -393,7 +390,6 @@ module.exports = class Autobee extends ReadyResource {
     // rugpull the rest
     await this.store.close()
 
-    if (this._bootWait !== null) this._bootWait.resolve()
     if (this._updating) await this._updating
     if (this._draining) await this._draining
 
@@ -437,10 +433,6 @@ module.exports = class Autobee extends ReadyResource {
     return new WriterEncryption(this)
   }
 
-  getMostRecentHead() {
-    return topo.getMostRecentHead(this, this.system.bee.snapshot())
-  }
-
   async _preBoot() {
     if (this._handlers.wait) await this._handlers.wait()
 
@@ -458,7 +450,7 @@ module.exports = class Autobee extends ReadyResource {
       this.bootFrom = getBootOption(await this.bootFrom)
     }
 
-    return boot(this.store, this.key, this.legacyViews, {
+    return boot(this.store, this.key, {
       encryptionKey: this.encryptionKey,
       keyPair: this.keyPair
     })
@@ -505,37 +497,15 @@ module.exports = class Autobee extends ReadyResource {
     const system = result.system || EMPTY_HEAD
 
     await this.system.boot(system)
+    if (this.system.migration) await this._runMigration()
 
-    const migrated = await this.local.getUserData('autobee/migrated-head')
-    if (migrated) this._migratedHead = encoding.decodeMigratedHead(migrated)
-
-    let view = this.system.view
-    if (!view) view = (this._migratedHead && this._migratedHead.view) || EMPTY_HEAD
-
-    // @todo migration
     if (result.migration) {
-      if (this._handlers.migrate) {
-        view =
-          (await this._handlers.migrate(result.migration.views, result.migration.system)) ||
-          EMPTY_HEAD
-        this._catchupMigratedNodes = result.migration.catchup
-
-        this._migratedHead = {
-          system: result.migration.system,
-          view: view.length ? view : (this._migratedHead && this._migratedHead.view) || null
-        }
-
-        await this._storeMigratedHead()
-      }
+      this._migrating = true
+      this._catchupMigratedNodes = result.migration.catchup
 
       // ff boot invalidated by migration
       this.bootFrom = null
 
-      // clear legacy data
-      await this.bootstrap.setUserData('autobase/local', null)
-      await this.local.setUserData('autobase/boot', null)
-      await this.local.setUserData('autobase/encryption', null)
-
       for (const batch of result.migration.catchup) {
         const { key, length } = batch[batch.length - 1]
         this.writers.wakeup(key, length)
@@ -547,6 +517,8 @@ module.exports = class Autobee extends ReadyResource {
     await this._workingBee.core.ready()
     await this.bee.core.ready()
 
+    const view = this.system.view
+
     this._workingBee.move(view)
     this.bee.move(view)
 
@@ -592,10 +564,6 @@ module.exports = class Autobee extends ReadyResource {
   async _bump(force) {
     if (!force && !this._bootGuard.opened) await this._bootGuard.ready()
 
-    // resolve before the bootAll gate: a parked boot-from retries on any bump,
-    // and its drain is the one _bootOnline itself is waiting on
-    if (this._bootWait !== null) this._bootWait.resolve()
-
     if (!force && !this._bootOnlineGuard.opened) await this._bootOnlineGuard.ready()
 
     this.bumping++
@@ -668,12 +636,16 @@ module.exports = class Autobee extends ReadyResource {
     this.stats.drains++
 
     if (this.bootFrom) {
-      const { head = null, legacy = null, bootCondition = null, wait = false } = this.bootFrom
+      const { head = null, legacy = null } = this.bootFrom
 
       this.bootFrom = null
 
-      if (legacy) await this._bootFromSystem(legacy)
-      else if (head) await this._bootFromHead(head, bootCondition, wait)
+      if (legacy) {
+        await this._bootFromSystem(legacy)
+      } else if (head) {
+        this._wakeup.hint({ key: head.key, length: head.length || 0 })
+        await this._bootFromHead(head)
+      }
     }
 
     const changes = this._hasUpdate ? new UpdateChanges(this) : null
@@ -695,6 +667,8 @@ module.exports = class Autobee extends ReadyResource {
 
           if (this.fastForwardTo !== null) {
             await this._applyFastForward()
+            if (changes) changes.track()
+            this._needsUpdate = false
             break // revaluate conditions...
           }
 
@@ -718,7 +692,7 @@ module.exports = class Autobee extends ReadyResource {
     this._updating = updating.promise
 
     try {
-      if (this._needsUpdate) await this._update(changes)
+      if (this._needsUpdate) await this._update(changes, false)
       await this._storeBoot()
     } finally {
       this._updating = null
@@ -900,13 +874,13 @@ module.exports = class Autobee extends ReadyResource {
     }
   }
 
-  async _update(changes) {
+  async _update(changes, fastForward) {
     this._needsUpdate = false
     this.bee.update(this._workingBee.root)
 
     if (!changes) return
 
-    changes.finalise()
+    changes.finalise(fastForward)
     await this._handlers.update(this.view, changes)
   }
 
@@ -1205,9 +1179,6 @@ module.exports = class Autobee extends ReadyResource {
       this.stats.undos++
       this.trusted.clear()
       t.view = await this.system.undo(t.undo)
-      if (!t.view.length && this._migratedHead && this._migratedHead.view) {
-        t.view = this._migratedHead.view
-      }
     }
 
     return t
@@ -1288,8 +1259,9 @@ module.exports = class Autobee extends ReadyResource {
     }
   }
 
-  _storeBoot() {
+  async _storeBoot() {
     const proms = []
+
     proms.push(
       this.local.setUserData(
         'autobee/previous-drain',
@@ -1302,12 +1274,15 @@ module.exports = class Autobee extends ReadyResource {
       proms.push(this.local.setUserData('autobee/head', encoding.encodeBootRecord(boot)))
     }
 
-    return Promise.all(proms)
-  }
+    await Promise.all(proms)
 
-  _storeMigratedHead() {
-    const value = this._migratedHead ? encoding.encodeMigratedHead(this._migratedHead) : null
-    return this.local.setUserData('autobee/migrated-head', value)
+    if (this._migrating) {
+      // clear legacy data
+      await this.bootstrap.setUserData('autobase/local', null)
+      await this.local.setUserData('autobase/boot', null)
+      await this.local.setUserData('autobase/encryption', null)
+      this._migrating = false
+    }
   }
 
   static decodeValue(buf, opts) {
@@ -1404,11 +1379,11 @@ module.exports = class Autobee extends ReadyResource {
     this._localViewLength = 0
   }
 
-  async moveTo(head) {
+  async moveTo(head, { timeout = 0 } = {}) {
     if (!this._bootGuard.opened) await this._bootGuard.ready()
     if (this.closing) throw new Error('Autobee closed')
 
-    const ff = await FastForward.fromHead(this, head, null, { force: true })
+    const ff = await FastForward.fromHead(this, head, null, { force: true, timeout })
     if (ff === null) return null
 
     if (!(await this._runFastForward(ff))) return null
@@ -1427,108 +1402,20 @@ module.exports = class Autobee extends ReadyResource {
     }
   }
 
-  // the boot head seeds the view every trust decision here is made against,
-  // since our own view is still empty
-  async _bootFromHead(head, bootCondition, wait = false) {
-    // just a head: one attempt, we do not wait around if it cannot be read
-    if (bootCondition === null && !wait) {
-      try {
-        const ff = await FastForward.fromHead(this, head, null, {
-          force: true,
-          timeout: FastForward.DEFAULT_TIMEOUT
-        })
-
-        return ff !== null && (await this._runFastForward(ff))
-      } catch (err) {
-        safetyCatch(err)
-        return false
-      }
-    }
-
-    // park until the head can be read and, if a condition is set, something
-    // acceptable turns up
-    let opened = null
+  async _bootFromHead(head) {
+    const timeout = FastForward.DEFAULT_TIMEOUT
 
     try {
-      while (!this._interrupting) {
-        this._bootWait = rrp()
-
-        try {
-          if (bootCondition === null) {
-            const ff = await FastForward.fromHead(this, head, null, {
-              force: true,
-              timeout: FastForward.DEFAULT_TIMEOUT
-            })
-
-            if (ff !== null && (await this._runFastForward(ff))) return true
-          } else {
-            if (opened === null) opened = await this._bootReference(head)
-
-            if (opened !== null) {
-              if (await this._bootAttempt(head, bootCondition, opened.view)) {
-                return true
-              }
-
-              // the reference may be stale - resolve it afresh next attempt
-              await opened.close()
-              opened = null
-            } else if (await this._bootLegacyHead(head)) {
-              // boot legacy head through the migration pathway
-              return true
-            }
-          }
-        } catch (err) {
-          safetyCatch(err)
-        }
+      const oplog = await this._resolveOplogHint(head.key, head.length || 0, { timeout })
+      if (oplog === null) return false
 
-        if (this._interrupting) break
+      const ff = await FastForward.fromHead(this, oplog, null, { force: true, timeout })
 
-        await this._bootWait.promise
-      }
-    } finally {
-      this._bootWait = null
-      if (opened !== null) await opened.close()
+      return ff !== null && (await this._runFastForward(ff))
+    } catch (err) {
+      safetyCatch(err)
+      return false
     }
-
-    return false
-  }
-
-  async _bootAttempt(head, bootCondition, reference) {
-    // peek, so the hints are still there for the drain once we have booted
-    const result = await this._filterHints(this._wakeup.hints)
-
-    const candidates = await this._readCandidateHeads(result, FastForward.DEFAULT_TIMEOUT)
-
-    const ff = await FastForward.fromHeads(this, [head, ...candidates], {
-      force: true,
-      timeout: FastForward.DEFAULT_TIMEOUT,
-      condition: bootCondition,
-      reference
-    })
-
-    return ff !== null && (await this._runFastForward(ff))
-  }
-
-  async _bootLegacyHead(head) {
-    const oplog = await FastForward.flushHead(this, head, {
-      timeout: FastForward.DEFAULT_TIMEOUT
-    })
-    if (oplog === null || oplog.op.version > LEGACY_OPLOG_VERSION) return false
-
-    const ff = await FastForward.fromHead(this, head, null, {
-      force: true,
-      timeout: FastForward.DEFAULT_TIMEOUT
-    })
-
-    return ff !== null && (await this._runFastForward(ff))
-  }
-
-  async _bootReference(head) {
-    const oplog = await FastForward.flushHead(this, head, {
-      timeout: FastForward.DEFAULT_TIMEOUT
-    })
-
-    return oplog === null ? null : this.openViewAt(oplog)
   }
 
   async _runFastForward(ff) {
@@ -1554,34 +1441,32 @@ module.exports = class Autobee extends ReadyResource {
     return true
   }
 
+  async _runMigration() {
+    if (!this._handlers.migrate) {
+      throw new Error('Missing migration handler')
+    }
+
+    const migration = this.system.migration
+    this.system.migration = null
+
+    await this._handlers.migrate(migration.views, migration.head)
+  }
+
   async _applyFastForward() {
     const changes = this._hasUpdate ? new UpdateChanges(this) : null
     if (changes) changes.track()
 
-    const { head, migrate } = this.fastForwardTo
+    const { head } = this.fastForwardTo
 
     const from = this.system.bee.head()
     const to = head
 
     this.system.bee.move(head)
     await this.system.reset()
+    if (this.system.migration) await this._runMigration()
 
-    // migrate is set when fast-forwarding from a legacy head
-    if (migrate) {
-      const view = (await this._handlers.migrate(migrate, head)) || EMPTY_HEAD
-
-      this._migratedHead = {
-        system: head,
-        view: view.length ? view : (this._migratedHead && this._migratedHead.view) || null
-      }
-
-      await this._storeMigratedHead()
-      this.bee.move(view)
-      this._workingBee.move(view)
-    } else {
-      this.bee.move(this.system.view)
-      this._workingBee.move(this.system.view)
-    }
+    this.bee.move(this.system.view)
+    this._workingBee.move(this.system.view)
 
     this._approvalCheck = true
     this.fastForwardTo = null
@@ -1593,7 +1478,7 @@ module.exports = class Autobee extends ReadyResource {
     // we moved, so ask our peers to tell us their heads again
     this._requestWakeup()
 
-    await this._update(changes)
+    await this._update(changes, true)
     await this._storeBoot()
 
     this.stats.fastForwards++
@@ -1614,7 +1499,7 @@ function getBootOption(boot) {
   if (!boot) return null
 
   // oldest style, supported for now but will go away: a bare key is legacy
-  if (boot.key) return { legacy: boot, head: null, bootCondition: null }
+  if (boot.key) return { legacy: boot, head: null }
 
   asserts.assert(!(boot.head && boot.legacy), 'Boot from either a head or a legacy pointer')
 

package/lib/boot.js

@@ -5,7 +5,6 @@ const { checkAutobaseMigration } = require('./migrations.js')
 module.exports = async function boot(
   corestore,
   key,
-  legacyViews,
   { encrypt, encryptionKey, keyPair, exclusive = true } = {}
 ) {
   const result = {
@@ -95,12 +94,7 @@ module.exports = async function boot(
     await result.bootstrap.setUserData('autobee/local', result.local.key)
     await result.local.setUserData('referrer', result.key)
 
-    result.migration = await migrateWithFallback(
-      corestore,
-      result.local,
-      result.bootstrap,
-      legacyViews
-    )
+    result.migration = await migrateWithFallback(corestore, result.local, result.bootstrap)
 
     if (result.migration) {
       await result.local.setUserData(
@@ -142,9 +136,9 @@ module.exports = async function boot(
 // the bootstrap pointer names the rotated-to writer, whose legacy boot record
 // can be unusable. the namespace local still carries the pre-rotation record,
 // which points at the last system core that was actually signed
-async function migrateWithFallback(corestore, local, bootstrap, legacyViews) {
+async function migrateWithFallback(corestore, local, bootstrap) {
   try {
-    return await checkAutobaseMigration(corestore, local, bootstrap, legacyViews)
+    return await checkAutobaseMigration(corestore, local, bootstrap)
   } catch (err) {
     const prev = corestore.get({ name: 'local', active: false })
     await prev.ready()
@@ -152,7 +146,7 @@ async function migrateWithFallback(corestore, local, bootstrap, legacyViews) {
     if (b4a.equals(prev.key, local.key)) throw err
     if (!(await prev.getUserData('autobase/boot'))) throw err
 
-    return checkAutobaseMigration(corestore, prev, bootstrap, legacyViews)
+    return checkAutobaseMigration(corestore, prev, bootstrap)
   }
 }
 

package/lib/encoding.js

@@ -12,19 +12,16 @@ const SystemInfo = getEncoding('@autobee/system-info')
 const SystemWriter = getEncoding('@autobee/system-writer')
 const ManifestData = getEncoding('@autobee/manifest-data')
 const AutobaseBootRecord = getEncoding('@autobase-compat/boot-record')
-const MigratedHead = getEncoding('@autobee/migrated-head')
 
 exports.OPLOG_VERSION = OPLOG_VERSION
 
 exports.Oplog = Oplog
+
 exports.ManifestData = ManifestData
 
 exports.encodeBootRecord = encodeBootRecord
 exports.decodeBootRecord = decodeBootRecord
 
-exports.encodeMigratedHead = encodeMigratedHead
-exports.decodeMigratedHead = decodeMigratedHead
-
 exports.encodePreviousDrain = encodePreviousDrain
 exports.decodePreviousDrain = decodePreviousDrain
 
@@ -50,14 +47,6 @@ function decodeBootRecord(value) {
   return c.decode(Link, value)
 }
 
-function encodeMigratedHead(m) {
-  return c.encode(MigratedHead, m)
-}
-
-function decodeMigratedHead(value) {
-  return c.decode(MigratedHead, value)
-}
-
 function encodePreviousDrain(d) {
   return c.encode(c.uint, d)
 }