corestore 6.6.0 → 6.8.0

package/README.md

@@ -29,12 +29,15 @@ Create a new Corestore instance.
 
 `storage` can be either a random-access-storage module, a string, or a function that takes a path and returns an random-access-storage instance.
 
-#### `const core = store.get(key | { name: 'a-name', ...hypercoreOpts})`
+#### `const core = store.get(key | { name: 'a-name', exclusive, ...hypercoreOpts})`
 Loads a Hypercore, either by name (if the `name` option is provided), or from the provided key (if the first argument is a Buffer, or if the `key` options is set).
 
 If that Hypercore has previously been loaded, subsequent calls to `get` will return a new Hypercore session on the existing core.
 
-All other options besides `name` and `key` will be forwarded to the Hypercore constructor.
+If you set the `exclusive` option and you are opening a writable session it will wait for all other exclusive writable to close before
+opening the Hypercore effectively meaning any op on the core will wait until its exclusive.
+
+All other options besides `name` and `key` and `exclusive` will be forwarded to the Hypercore constructor.
 
 #### `const stream = store.replicate(optsOrStream)`
 Creates a replication stream that's capable of replicating all Hypercores that are managed by the Corestore, assuming the remote peer has the correct capabilities.

package/index.js

@@ -5,6 +5,7 @@ const Hypercore = require('hypercore')
 const Xache = require('xache')
 const b4a = require('b4a')
 const ReadyResource = require('ready-resource')
+const RW = require('read-write-mutexify')
 
 const [NS] = crypto.namespace('corestore', 1)
 const DEFAULT_NAMESPACE = b4a.alloc(32) // This is meant to be 32 0-bytes
@@ -33,9 +34,11 @@ module.exports = class Corestore extends ReadyResource {
     this._root = root || this
     this._replicationStreams = root ? root._replicationStreams : []
     this._overwrite = opts.overwrite === true
+    this._readonly = opts.writable === false
 
     this._sessions = new Set() // sessions for THIS namespace
     this._rootStoreSessions = new Set()
+    this._locks = root ? root._locks : new Map()
 
     this._findingPeersCount = 0
     this._findingPeers = []
@@ -171,20 +174,45 @@ module.exports = class Corestore extends ReadyResource {
     core.writable = true
   }
 
+  _getLock (id) {
+    let rw = this._locks.get(id)
+
+    if (!rw) {
+      rw = new RW()
+      this._locks.set(id, rw)
+    }
+
+    return rw
+  }
+
   async _preload (opts) {
     if (!this.primaryKey) await this.ready()
 
     const { discoveryKey, keyPair, auth } = await this._generateKeys(opts)
     const id = b4a.toString(discoveryKey, 'hex')
 
-    while (this.cores.has(id)) {
-      const existing = this.cores.get(id)
-      if (existing.opened && !existing.closing) return { from: existing, keyPair, auth }
-      if (existing.closing) {
-        await existing.close()
-      } else {
-        await existing.ready().catch(safetyCatch)
+    const rw = (opts && opts.exclusive && opts.writable !== false && keyPair) ? this._getLock(id) : null
+
+    if (rw) await rw.write.lock()
+    const release = () => {
+      if (!rw) return
+      rw.write.unlock()
+      if (rw.write.waiting === 0) this._locks.delete(id)
+    }
+
+    try {
+      while (this.cores.has(id)) {
+        const existing = this.cores.get(id)
+        if (existing.opened && !existing.closing) return { from: existing, keyPair, auth }
+        if (existing.closing) {
+          await existing.close()
+        } else {
+          await existing.ready().catch(safetyCatch)
+        }
       }
+    } catch (err) {
+      release()
+      throw err
     }
 
     const userData = {}
@@ -222,10 +250,12 @@ module.exports = class Corestore extends ReadyResource {
       }
     }, () => {
       this.cores.delete(id)
+      release()
     })
     core.once('close', () => {
       this._emitCore('core-close', core)
       this.cores.delete(id)
+      release()
     })
     core.on('conflict', (len, fork, proof) => {
       this.emit('conflict', core, len, fork, proof)
@@ -263,6 +293,7 @@ module.exports = class Corestore extends ReadyResource {
     }
 
     const core = new Hypercore(null, {
+      writable: !this._readonly,
       ...opts,
       name: null,
       preload: () => this._preload(opts)
@@ -311,17 +342,18 @@ module.exports = class Corestore extends ReadyResource {
     return stream
   }
 
-  namespace (name) {
+  namespace (name, opts) {
     if (name instanceof Hypercore) {
-      return this.session({ _bootstrap: name })
+      return this.session({ ...opts, _bootstrap: name })
     }
-    return this.session({ namespace: generateNamespace(this._namespace, name) })
+    return this.session({ ...opts, namespace: generateNamespace(this._namespace, name) })
   }
 
   session (opts) {
     const session = new Corestore(this.storage, {
       namespace: this._namespace,
       cache: this.cache,
+      writable: !this._readonly,
       _root: this._root,
       ...opts
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "corestore",
-  "version": "6.6.0",
+  "version": "6.8.0",
   "description": "A Hypercore factory that simplifies managing collections of cores.",
   "main": "index.js",
   "scripts": {
@@ -30,8 +30,9 @@
   },
   "dependencies": {
     "b4a": "^1.3.1",
-    "hypercore": "^10.10.0",
+    "hypercore": "^10.12.0",
     "hypercore-crypto": "^3.2.1",
+    "read-write-mutexify": "^2.1.0",
     "ready-resource": "^1.0.0",
     "safety-catch": "^1.0.1",
     "sodium-universal": "^4.0.0",