hypercore-storage 1.17.0 → 2.0.0

package/README.md

@@ -18,11 +18,11 @@ const Storage = require('hypercore-storage')
 
 Make a new storage engine.
 
-#### `core = await store.create({ key, discoveyKey, manifest?, keyPair?, encryptionKey?, userData? })`
+#### `core = await store.createCore({ key, discoveyKey, manifest?, keyPair?, encryptionKey?, userData? })`
 
 Create a new core, returns a storage instance for that core.
 
-#### `core = await store.resume(discoveryKey)`
+#### `core = await store.resumeCore(discoveryKey)`
 
 Resume a previously make core. If it doesn't exist it returns `null`.
 
@@ -33,7 +33,7 @@ When you wanna flush your changes to the underlying storage, use `await atom.flu
 
 Internally to "listen" for when that happens you can add an sync hook with `atom.onflush(fn)`
 
-#### `bool = await store.has(discoveryKey)`
+#### `bool = await store.hasCore(discoveryKey)`
 
 Check if a core exists.
 

package/index.js

@@ -426,6 +426,9 @@ class CorestoreStorage {
     this.path = storage !== null ? storage : path.join(db.path, '..')
     this.readOnly = !!opts.readOnly
     this.allowBackup = !!opts.allowBackup
+    this.deviceFile = null
+    this.wait = !!opts.wait
+    this.lock = !!opts.lock || this.wait
 
     // tmp sync fix for simplicty since not super deployed yet
     if (this.bootstrap && !this.readOnly) tmpFixStorage(this.path)
@@ -539,9 +542,13 @@ class CorestoreStorage {
       if (this.bootstrap && !this.readOnly && !this.allowBackup) {
         const corestoreFile = path.join(this.path, 'CORESTORE')
 
-        if (!(await DeviceFile.resume(corestoreFile, { id: this.id }))) {
-          await DeviceFile.create(corestoreFile, { id: this.id })
-        }
+        this.deviceFile = new DeviceFile(corestoreFile, {
+          wait: this.wait,
+          lock: this.lock,
+          data: { id: this.id }
+        })
+
+        await this.deviceFile.ready()
       }
 
       const rx = new CorestoreRX(this.db, view)
@@ -688,6 +695,7 @@ class CorestoreStorage {
     await this._flush()
     await this.db.close()
     await this.rocks.close()
+    if (this.deviceFile) await this.deviceFile.close()
   }
 
   async clear() {
@@ -797,7 +805,7 @@ class CorestoreStorage {
     }
   }
 
-  async has(discoveryKey, { ifMigrated = false } = {}) {
+  async hasCore(discoveryKey, { ifMigrated = false } = {}) {
     if (this.version === 0) await this._migrateStore()
 
     const rx = new CorestoreRX(this.db, EMPTY)
@@ -864,7 +872,17 @@ class CorestoreStorage {
     return Promise.all(resultPromises)
   }
 
-  async resume(discoveryKey) {
+  async suspend() {
+    await this.db.suspend()
+    if (this.deviceFile) await this.deviceFile.suspend()
+  }
+
+  async resume() {
+    if (this.deviceFile) await this.deviceFile.resume()
+    await this.db.resume()
+  }
+
+  async resumeCore(discoveryKey) {
     if (this.version === 0) await this._migrateStore()
 
     if (!discoveryKey) {
@@ -978,7 +996,7 @@ class CorestoreStorage {
     return new HypercoreStorage(this, this.db.session(), ptr, EMPTY, null)
   }
 
-  async create(data) {
+  async createCore(data) {
     if (this.version === 0) await this._migrateStore()
 
     const view = await this._enter()

package/migrations/0/index.js

@@ -622,6 +622,7 @@ function getCached (read, cache, index) {
 async function getByteRangeFromStorage (read, index, roots, cache) {
   const promises = [getCached(read, cache, index), getByteOffsetFromStorage(read, index, roots, cache)]
   const [node, offset] = await Promise.all(promises)
+  if (!node) throw new Error('Node not found during migration: ' + index)
   return [offset, node.size]
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore-storage",
-  "version": "1.17.0",
+  "version": "2.0.0",
   "main": "index.js",
   "files": [
     "index.js",
@@ -10,7 +10,8 @@
   ],
   "scripts": {
     "format": "prettier --write .",
-    "test": "prettier --check . && node test/all.js",
+    "lint": "prettier --check . && lunte",
+    "test": "node test/all.js",
     "test:bare": "bare test/all.js",
     "test:generate": "brittle -r test/all.js test/*.js"
   },
@@ -32,7 +33,7 @@
     "bare-fs": "^4.0.1",
     "bare-path": "^3.0.0",
     "compact-encoding": "^2.16.0",
-    "device-file": "^1.2.2",
+    "device-file": "^2.0.0",
     "flat-tree": "^1.12.1",
     "hypercore-crypto": "^3.4.2",
     "hyperschema": "^1.7.0",
@@ -44,6 +45,7 @@
   },
   "devDependencies": {
     "brittle": "^3.7.0",
+    "lunte": "^1.2.0",
     "prettier": "^3.6.2",
     "prettier-config-holepunch": "^2.0.0",
     "test-tmp": "^1.3.1"