autobee 2.2.1 → 2.3.0

package/lib/fast-forward.js

@@ -1,10 +1,8 @@
 const safetyCatch = require('safety-catch')
-const b4a = require('b4a')
 const Hypercore = require('hypercore')
 
 const System = require('./system.js')
 const migrations = require('./migrations.js')
-const { LEGACY_AUTOBASE_VERSION } = require('./constants.js')
 
 const DEFAULT_OP_TIMEOUT = 5_000
 const MIN_FF_GAP = 32
@@ -17,7 +15,7 @@ module.exports = class FastForward {
 
     // 'reboot' is a storage namespace: renaming it would derive a different
     // scratch core on disk, so it stays as is
-    this.system = new System(auto.store.namespace('reboot'), null, {
+    this.system = new System(auto, auto.store.namespace('reboot'), {
       getEncryptionProvider: this.auto.getSystemEncryption,
       encrypted: this.encrypted,
       activeRequests: this.activeRequests
@@ -34,12 +32,7 @@ module.exports = class FastForward {
 
   static DEFAULT_TIMEOUT = DEFAULT_OP_TIMEOUT
 
-  static async fromHead(
-    auto,
-    head,
-    trusted,
-    { force = false, timeout = 0, condition = null, reference = null } = {}
-  ) {
+  static async fromHead(auto, head, trusted, { force = false, timeout = 0 } = {}) {
     const conservative = !force && auto._conservativeFF
     const timeoutOpts = timeout ? { timeout } : null
 
@@ -59,19 +52,11 @@ module.exports = class FastForward {
       return null
     }
 
-    if (condition !== null && !(await FastForward.accepts(auto, verified, condition, reference))) {
-      return null
-    }
-
     return new FastForward(auto, batchToHead(verified.op.views.system))
   }
 
-  static async fromHeads(
-    auto,
-    heads,
-    { force = false, timeout = 0, condition = null, reference = null } = {}
-  ) {
-    if (reference === null) reference = auto._workingView.view
+  static async fromHeads(auto, heads, { force = false, timeout = 0 } = {}) {
+    const reference = auto._workingView.view
 
     const promises = []
 
@@ -112,12 +97,7 @@ module.exports = class FastForward {
     }
 
     if (bestTrusted !== null) {
-      return FastForward.fromHead(auto, bestTrusted, null, {
-        force,
-        timeout,
-        condition,
-        reference
-      })
+      return FastForward.fromHead(auto, bestTrusted, null, { force, timeout })
     }
 
     candidates.sort((a, b) => b.op.views.flushes - a.op.views.flushes)
@@ -127,12 +107,7 @@ module.exports = class FastForward {
       if (trusted === null) continue
       if (auto.fastForwarding || auto.fastForwardTo) return null
 
-      const ff = await FastForward.fromHead(auto, res, trusted, {
-        force,
-        timeout,
-        condition,
-        reference
-      })
+      const ff = await FastForward.fromHead(auto, res, trusted, { force, timeout })
       if (ff !== null) return ff
     }
 
@@ -151,17 +126,6 @@ module.exports = class FastForward {
     }
   }
 
-  static async accepts(auto, oplog, condition, reference) {
-    const opened = auto.openViewAt(oplog)
-    if (opened === null) return false
-
-    try {
-      return !!(await condition(opened.view, reference))
-    } finally {
-      await opened.close()
-    }
-  }
-
   static async mostRecentTrusted(auto, head, reference) {
     const opened = auto.openViewAt(head)
     if (opened === null) return null
@@ -198,38 +162,6 @@ module.exports = class FastForward {
 
     await this.system.boot(this.head, { timeout: this.timeout })
 
-    // a legacy system needs migrating rather than a plain fast-forward
-    if (this.system.version <= LEGACY_AUTOBASE_VERSION) {
-      const migrated = this.auto._migratedHead && this.auto._migratedHead.system
-      if (
-        migrated &&
-        b4a.equals(migrated.key, this.head.key) &&
-        migrated.length >= this.head.length
-      ) {
-        return null
-      }
-
-      const result = await this._migrate()
-      if (result === null || result.autobee === null) return result
-
-      // an indexer of the newest legacy generation already moved to autobee -
-      // fast-forward straight onto its announced head instead of migrating,
-      // falling back to the legacy migration if the head cannot be booted
-      try {
-        this.head = result.autobee
-        await this.system.boot(this.head, { timeout: this.timeout })
-        if (this.system.version <= LEGACY_AUTOBASE_VERSION) {
-          throw new Error('Expected an autobee system')
-        }
-      } catch (err) {
-        safetyCatch(err)
-        this.head = result.head
-        return { head: result.head, migrate: result.migrate }
-      }
-
-      // fall through to the plain fast-forward below
-    }
-
     const promises = []
 
     // ensure local key is locally available always
@@ -252,70 +184,12 @@ module.exports = class FastForward {
     await Promise.all(promises)
     if (this.destroyed) return null
 
-    if (this.destroyed) return null
-
     return {
       head: this.head,
       migrate: null
     }
   }
 
-  // Upgrade a legacy (pre-AUTOBEE_VERSION) system in place. The system already
-  // booted above (coerced to the current struct), but the original v1/v2 struct
-  // is needed to recover the indexers/views/entropy, so decode the raw block.
-  //
-  // A head may be arbitrarily old: an indexer rotation freezes the system core
-  // and moves the indexers to a successor. The frozen core cannot reveal its
-  // successor (the promotion only lands in its unsigned tail), but the
-  // indexers' newest oplog digests stamp the newest system they know - chase
-  // those so the migration lands on the newest generation instead of the head
-  // we were given.
-  async _migrate() {
-    let head = { key: this.head.key, length: this.head.length }
-    const seen = new Set()
-
-    for (let hops = 0; hops < migrations.MAX_MIGRATE_HOPS; hops++) {
-      seen.add(b4a.toString(head.key, 'hex'))
-
-      const core = this.auto.store.get({ key: head.key, encryption: null })
-      this.cores.push(core)
-      await core.ready()
-
-      // setup encryption
-      await core.setEncryption(this.auto.getSystemEncryption())
-
-      // successors are resolved by key only - wait for the replicated length
-      if (!head.length) head.length = await migrations.coreLength(core, this.timeout)
-      if (!head.length || this.destroyed) return null
-
-      const info = await migrations.readLegacySystemInfo(core, head.length, {
-        timeout: this.timeout,
-        activeRequests: this.activeRequests
-      })
-
-      const { legacy, autobee } = await migrations.findNewestSystem(this, info)
-      if (this.destroyed) return null
-
-      if (legacy !== null && !seen.has(b4a.toString(legacy, 'hex'))) {
-        head = { key: legacy, length: 0 }
-        continue
-      }
-
-      this.head = head
-
-      const views = await migrations.resolveLegacyViews(this, info)
-      if (views === null || this.destroyed) return null
-
-      return {
-        head,
-        migrate: views,
-        autobee: autobee === null ? null : batchToHead(autobee.op.views.system)
-      }
-    }
-
-    return null
-  }
-
   async _resolveLength() {
     const core = this.auto.store.get({ key: this.head.key })
     this.cores.push(core)

package/lib/migrations.js

@@ -6,7 +6,6 @@ const { decodeBlock } = require('hyperbee2/lib/encoding.js')
 
 const encoding = require('./encoding.js')
 const { assert, bail } = require('./asserts.js')
-const { LEGACY_OPLOG_VERSION } = require('./constants.js')
 
 const { getEncoding } = require('../encoding/spec/autobee')
 
@@ -18,23 +17,52 @@ const INDEX_VERSION = 1
 const INFO = b4a.from([0x00, 0x00, 0x69, 0x6e, 0x66, 0x6f])
 const [NS_SIGNER_NAMESPACE] = crypto.namespace('autobase', 1)
 
-// indexer rotations chain legacy systems - how many generations we chase
-const MAX_MIGRATE_HOPS = 64
-
 module.exports = {
-  MAX_MIGRATE_HOPS,
+  getCoreManifest,
+  getViewMap,
   checkAutobaseMigration,
-  readLegacySystemInfo,
-  findNewestSystem,
-  resolveLegacyViews,
   inflateLegacyOplog,
-  decodeLegacySystemInfo,
-  deriveNamespace,
   coreLength
 }
 
+async function getCoreManifest(store, key, { timeout, wait = true } = {}) {
+  const core = store.get(key)
+  await core.ready()
+  try {
+    if (!core.manifest && core.length === 0) await core.get(0, { timeout, wait })
+    return core.manifest
+  } finally {
+    await core.close()
+  }
+}
+
+// local-only probes: the manifests are expected in storage already (prefetched
+// by the reset path), so a violation skips instead of hanging on the network
+async function getViewMap(store, bootstrap, encryptionKey, info, legacyViews) {
+  const getIndexerManifest = ({ key }) => getCoreManifest(store, key, { wait: false })
+  const indexerManifests = await Promise.all(info.indexers.map(getIndexerManifest))
+  const entropy = legacyEntropy(info, indexerManifests)
+  const mappedViews = new Map()
+
+  for (const name of legacyViews) {
+    const v = await findViewByName(
+      store,
+      bootstrap.key,
+      encryptionKey,
+      indexerManifests,
+      info.views,
+      entropy,
+      name
+    )
+
+    mappedViews.set(name, v)
+  }
+
+  return mappedViews
+}
+
 // boot-time migration of local legacy autobase storage
-async function checkAutobaseMigration(store, local, bootstrap, legacyViews) {
+async function checkAutobaseMigration(store, local, bootstrap) {
   const bootRecord = await local.getUserData('autobase/boot')
   if (!bootRecord) return null
 
@@ -60,41 +88,19 @@ async function checkAutobaseMigration(store, local, bootstrap, legacyViews) {
     await session.close()
   }
 
-  const info = await readLegacySystemInfo(core, length, { wait: false })
+  // nothing reads the info here anymore, but a legacy system that will not
+  // decode has to throw for migrateWithFallback pathway
+  await readLegacySystemInfo(core, length, { wait: false })
 
   const nodes = await Promise.all(
     catchup.map((n) => getWriterBatch(store, n, bootstrap.key, encryptionKey))
   )
 
-  const indexerManifests = await Promise.all(
-    info.indexers.map((idx) => storeCoreManifest(store, idx.key))
-  )
-  const views = await Promise.all(info.views.map((v) => getPersistedView(store, v)))
-  const entropy = legacyEntropy(info, indexerManifests)
-
-  const getManifest = (key) => storeCoreManifest(store, key)
-
-  const mappedViews = new Map()
-  for (const name of legacyViews) {
-    const v = await findViewByName(
-      getManifest,
-      bootstrap.key,
-      encryptionKey,
-      indexerManifests,
-      views,
-      entropy,
-      name
-    )
-
-    mappedViews.set(name, v)
-  }
-
   await core.close()
 
   return {
     encryptionKey,
     system,
-    views: mappedViews,
     catchup: nodes
   }
 }
@@ -112,95 +118,6 @@ async function readLegacySystemInfo(core, length, opts = null) {
   return decodeLegacySystemInfo(node.keys[0].value)
 }
 
-// read each indexer's newest legacy oplog stamp - its digest/checkpoint mark
-// the newest legacy system that indexer knows. take the majority vote. an
-// indexer that already moved to autobee announces its live autobee state
-// instead - keep the newest of those as a direct fast-forward candidate and
-// bisect down to its buried legacy stamps so its vote still counts
-async function findNewestSystem(ff, info) {
-  const tally = new Map()
-
-  let autobee = null
-
-  for (const idx of info.indexers) {
-    const core = ff.auto.openCore(idx.key)
-    ff.cores.push(core)
-    await core.ready()
-
-    const length = await coreLength(core, ff.timeout)
-    if (!length || ff.destroyed) continue
-
-    let oplog = await flushHead(ff.auto, { key: idx.key, length }, { timeout: ff.timeout })
-    if (oplog === null || !oplog.op.views) continue
-
-    if (oplog.op.version > LEGACY_OPLOG_VERSION) {
-      if (autobee === null || oplog.op.views.flushes > autobee.op.views.flushes) {
-        autobee = oplog
-      }
-
-      const boundary = await findLegacyBoundary(ff, core, idx.length, oplog.length - 1)
-      if (!boundary || ff.destroyed) continue
-
-      oplog = await flushHead(ff.auto, { key: idx.key, length: boundary }, { timeout: ff.timeout })
-      if (oplog === null || !oplog.op.views) continue
-      if (oplog.op.version > LEGACY_OPLOG_VERSION) continue
-    }
-
-    const sys = oplog.op.views.system
-    if (!sys || !sys.key) continue
-
-    const hex = b4a.toString(sys.key, 'hex')
-    const t = tally.get(hex) || { key: sys.key, votes: 0, length: sys.length }
-
-    t.votes++
-    if (sys.length > t.length) t.length = sys.length
-    tally.set(hex, t)
-  }
-
-  const majority = (info.indexers.length >> 1) + 1
-
-  let best = null
-  for (const t of tally.values()) {
-    if (t.votes >= majority && (best === null || t.length > best.length)) best = t
-  }
-
-  return { legacy: best === null ? null : best.key, autobee }
-}
-
-// map the legacy views recorded in the system info by name
-async function resolveLegacyViews(ff, info) {
-  const indexerManifests = await Promise.all(
-    info.indexers.map((idx) => ffCoreManifest(ff, idx.key, idx.length))
-  )
-  if (ff.destroyed || indexerManifests.some((m) => m === null)) return null
-
-  const entropy = legacyEntropy(info, indexerManifests)
-
-  const getManifest = (key, length) => ffCoreManifest(ff, key, length)
-
-  const views = new Map()
-
-  await Promise.all(
-    ff.auto.legacyViews.map(async (name) => {
-      const v = await findViewByName(
-        getManifest,
-        ff.auto.key,
-        ff.auto.encryptionKey,
-        indexerManifests,
-        info.views,
-        entropy,
-        name
-      )
-
-      if (v) views.set(name, v)
-    })
-  )
-
-  if (ff.destroyed) return null
-
-  return views
-}
-
 // legacy nodes always inflate, but only indexers carry the digest/checkpoint
 // stamps that synthesise system info - callers must check op.views
 async function inflateLegacyOplog(buf, core, seq, timeout) {
@@ -309,32 +226,12 @@ function coreLength(core, timeout) {
   })
 }
 
-// a writer's oplog is a legacy prefix followed by autobee-format nodes -
-// bisect for the boundary. lo is a length known to be legacy (the legacy
-// system's recorded length for this writer), hi a seq known to be autobee.
-// returns the legacy prefix length
-async function findLegacyBoundary(ff, core, lo, hi) {
-  while (lo < hi) {
-    const mid = (lo + hi) >>> 1
-
-    const block = await core.get(mid, {
-      timeout: ff.timeout,
-      activeRequests: ff.activeRequests
-    })
-
-    if (encoding.decodeRawOplog(block).version > LEGACY_OPLOG_VERSION) hi = mid
-    else lo = mid + 1
-  }
-
-  return lo
-}
-
 function legacyEntropy(info, indexerManifests) {
   return info.version > 1 && info.entropy ? info.entropy : indexerManifests[0].signers[0].namespace
 }
 
 async function findViewByName(
-  getManifest,
+  store,
   bootstrap,
   encryptionKey,
   indexerManifests,
@@ -347,7 +244,7 @@ async function findViewByName(
   const namespace = deriveNamespace(name, bootstrap, entropy, encryptionKey)
 
   for (const v of views) {
-    const manifest = await getManifest(v.key, v.length)
+    const manifest = await getCoreManifest(store, v.key, { wait: false })
     if (!manifest) continue
 
     if (manifest.signers.length === 0) continue
@@ -360,50 +257,6 @@ async function findViewByName(
   return null
 }
 
-// request-tracked manifest read over replication
-async function ffCoreManifest(ff, key, length) {
-  const core = ff.auto.store.get(key)
-  ff.cores.push(core)
-
-  await core.ready()
-
-  try {
-    if (!core.manifest) {
-      await core.get(length - 1, {
-        timeout: ff.timeout,
-        activeRequests: ff.activeRequests
-      })
-    }
-  } catch {
-    return null
-  }
-
-  return core.manifest
-}
-
-// local-storage manifest read
-async function storeCoreManifest(store, key) {
-  const core = store.get(key)
-  await core.ready()
-
-  const manifest = core.manifest
-  await core.close()
-
-  return manifest
-}
-
-async function getPersistedView(store, view) {
-  const core = store.get(view.key)
-  await core.ready()
-
-  // core.length can run past what was downloaded - the system's recorded
-  // length is the last one we know is local
-  const length = Math.min(core.length, view.length)
-  await core.close()
-
-  return { key: view.key, length }
-}
-
 function getOplog(info, batch) {
   if (batch.length === 1) return batch[0].keys[0]
 
@@ -489,9 +342,3 @@ async function getWriterBatch(store, head, key, encryptionKey, nodes = []) {
 
   return batch
 }
-
-// lazy to avoid the require cycle - fast-forward imports this module
-function flushHead(auto, head, opts) {
-  const FastForward = require('./fast-forward.js')
-  return FastForward.flushHead(auto, head, opts)
-}

package/lib/system.js

@@ -2,7 +2,9 @@ const Hyperbee = require('hyperbee2')
 const Promotions = require('./promotions.js')
 const b4a = require('b4a')
 
-const { AUTOBEE_VERSION } = require('./constants')
+const { getViewMap, getCoreManifest } = require('./migrations.js')
+
+const { AUTOBEE_VERSION, LEGACY_AUTOBASE_VERSION } = require('./constants')
 const encoding = require('./encoding.js')
 const topo = require('./topo.js')
 
@@ -33,12 +35,13 @@ class SystemSnapshot {
 }
 
 module.exports = class Systembee {
-  constructor(store, name, opts = {}) {
-    this.name = name // for debuggin
+  constructor(auto, store, opts = {}) {
+    this.auto = auto
     this.store = store
     this.bee = new Hyperbee(store, opts)
     this.view = null
     this.heads = []
+    this.migration = null
     this.version = 0
     this.timestamp = 0
     this.flushes = 0
@@ -48,6 +51,10 @@ module.exports = class Systembee {
     this.promotions = new Promotions(this.bee)
   }
 
+  get name() {
+    return this.auto.name
+  }
+
   async addWriter(
     key,
     { length = 0, weight = 1, isGenesis = false, coord = null, carrier = -1, anchor = false } = {}
@@ -127,9 +134,17 @@ module.exports = class Systembee {
 
     this.version = info ? info.version : 0
     this.view = info ? info.view : EMPTY_HEAD
+    this.migration = null
     this.heads = info ? info.heads : []
     this.timestamp = info ? info.timestamp : 0
     this.flushes = info ? info.flushes : 0
+
+    if (this.version <= LEGACY_AUTOBASE_VERSION) {
+      // ~~~ good enough estimation
+      this.flushes = Math.floor(this.bee.core.length / 2)
+      this.view = await this._migrate(info, { timeout })
+    }
+
     this.updates.clear()
     this.writers.clear()
     this.promotions.reset(info)
@@ -139,6 +154,29 @@ module.exports = class Systembee {
     }
   }
 
+  async _migrate(info, { timeout } = {}) {
+    if (!info) return EMPTY_HEAD
+    const a = this.auto
+
+    const toManifests = ({ key }) => getCoreManifest(a.store, key, { timeout })
+    const promises = [...info.indexers.map(toManifests), ...info.views.map(toManifests)]
+
+    await Promise.all(promises)
+
+    const views = await getViewMap(a.store, a.bootstrap, a.encryptionKey, info, a.legacyViews)
+
+    // the handler only runs once the head is locked in - see auto._runMigration
+    this.migration = { views, head: this.bee.head() }
+
+    // legacyViews is ordered by preference, so the first one that resolved wins
+    for (const name of a.legacyViews) {
+      const view = views.get(name)
+      if (view) return view
+    }
+
+    return EMPTY_HEAD
+  }
+
   bootRecord() {
     const system = this.bee.head()
     return system.length ? system : null
@@ -441,21 +479,3 @@ module.exports = class Systembee {
     return this.promotions.hint(key, opts)
   }
 }
-
-function getInfo(data) {
-  for (const { keys } of data.batch) {
-    for (const k of keys) {
-      const prefix = k.key[0]
-
-      if (prefix === 0) {
-        try {
-          return encoding.decodeSystemInfo(k.value)
-        } catch {
-          return null
-        }
-      }
-    }
-  }
-
-  return null
-}

package/lib/topo.js

@@ -7,15 +7,11 @@ const { LEGACY_OPLOG_VERSION } = require('./constants.js')
 const EMPTY_HEAD = { length: 0, key: null }
 const INFO_LEGACY_KEY = b4a.concat([b4a.from([0, 0]), b4a.from('info')])
 
-const DEFAULT_OP_TIMEOUT = 5000
-
 exports.sort = sort
 exports.replay = replay
-exports.getMostRecentHead = getMostRecentHead
 
 exports.isLinking = isLinking
 exports.isLinkingAll = isLinkingAll
-exports.isLegacyNode = isLegacyNode
 
 class Clock {
   constructor() {
@@ -35,19 +31,6 @@ class Clock {
   }
 }
 
-async function getMostRecentHead(auto, system) {
-  const ch = system.createChangesStream()
-  for await (const data of ch) {
-    const refs = getOplogCompat(data)
-    if (!refs.length) continue
-
-    const { oplog } = refs[0]
-    return { key: oplog.key, length: oplog.length }
-  }
-
-  return null
-}
-
 // nodes we cannot resolve are returned as null rather than dropped, so callers
 // can tell an incomplete replay from a short one
 async function replay(auto) {
@@ -181,7 +164,7 @@ function cmp(a, b) {
   return a.length < b.length ? -1 : 1
 }
 
-async function inflate(auto, reorder, { wait = true, timeout = DEFAULT_OP_TIMEOUT } = {}) {
+async function inflate(auto, reorder, { wait = true, timeout = 0 } = {}) {
   const readOpts = wait ? { timeout } : { wait: false }
 
   const promises = []
@@ -233,7 +216,7 @@ async function getOplogBatch(undo, core, length, weight, index, readOpts = null)
   const legacy = oplog.version <= LEGACY_OPLOG_VERSION
 
   // if this is legacy the start pointer is always 0, fix
-  if (legacy) {
+  if (legacy && !oplog.links.length) {
     for (let i = length - 1; i > 0; i--) {
       const block = await core.get(i - 1, readOpts)
       if (block === null) return null // wait: false in replay helper
@@ -241,6 +224,7 @@ async function getOplogBatch(undo, core, length, weight, index, readOpts = null)
       const oplog = encoding.decodeOplog(block)
       if (oplog.batch.end === 0) break
       head.batch.start++
+      if (oplog.links.length > 0) break // always start of batch in legacy
     }
   }
 
@@ -345,6 +329,8 @@ function getOplogCompat(data) {
   const candidates = []
 
   for (const { keys } of data.batch) {
+    if (!keys) continue
+
     for (const k of keys) {
       if (k.key[0] !== 1) continue