corestore 7.9.2 → 7.10.1

package/README.md

@@ -114,6 +114,42 @@ store.watch(function (core) {
 
 Unregister a callback used with `store.watch(callback)` so it no longer fires.
 
+#### `const handle = store.notifyGroup(topic)`
+
+> [!IMPORTANT]
+> This feature is _experimental_. The API is subject to change, and everything may break.
+
+Get a `handle` for updates from all `hypercore`s with the group `topic` set.
+
+#### `const stream = handle.update(opts = {})`
+
+Gets updates for the `topic` the handle is for.
+
+`opts` includes:
+
+```js
+{
+  since: 0,      // What timestamp to start returning updates from. Default `0` returns all updates
+  reverse: true, // Flag to return updates in reverse order. Defaults to `true` so latest returned first
+}
+```
+
+Stream returns the core's `key`:
+
+```js
+for await (const key of handle.updates()) {
+  // ...
+}
+```
+
+#### `handle.destroy()`
+
+Destroys and unregisters the `handle` from its `store`.
+
+#### `handle.on('update', callback)`
+
+Calls the callback whenever a core with the `topic` for the `handle` updates.
+
 #### `await store.suspend()`
 
 Suspend the underlying storage for the Corestore.
@@ -132,6 +168,13 @@ This is useful for creating deterministic key pairs that are unique to a peer.
 
 Fully close this Corestore instance.
 
+#### `store.on('group-active', (topic) => {})`
+
+> [!IMPORTANT]
+> This feature is _experimental_. The API is subject to change, and everything may break.
+
+The `group-active` event emits whenever an opened Hypercore in the store updates. The `topic` is the group topic the core belongs to.
+
 ### License
 
 MIT

package/index.js

@@ -8,6 +8,7 @@ const { isAndroid } = require('which-runtime')
 const { STORAGE_EMPTY, ASSERTION } = require('hypercore-errors')
 
 const auditStore = require('./lib/audit.js')
+const GroupNotifyHandle = require('./lib/notify.js')
 
 const [NS] = crypto.namespace('corestore', 1)
 const DEFAULT_NAMESPACE = b4a.alloc(32) // This is meant to be 32 0-bytes
@@ -259,8 +260,10 @@ class Corestore extends ReadyResource {
     this.watchers = null
     this.watchIndex = -1
 
+    this._groupNotifiers = new Map() // group notifications
     this._findingPeers = null // here for legacy
     this._ongcBound = this._ongc.bind(this)
+    this._onGroupActiveBound = this._onGroupActive.bind(this)
 
     if (opts.primaryKey && !this.root && !opts.unsafe) {
       throw ASSERTION(
@@ -291,6 +294,44 @@ class Corestore extends ReadyResource {
     }
   }
 
+  _onGroupActive(topic) {
+    this.emit('group-active', topic)
+
+    const topicHex = b4a.toString(topic, 'hex')
+    const handles = this._groupNotifiers.get(topicHex)
+    if (!handles) return
+    for (const handle of handles) handle.emit('update')
+  }
+
+  notifyGroup(topic) {
+    const topicHex = b4a.toString(topic, 'hex')
+    let handles = this._groupNotifiers.get(topicHex)
+
+    if (!handles) {
+      handles = []
+      this._groupNotifiers.set(topicHex, handles)
+    }
+
+    const handle = new GroupNotifyHandle(this, topic)
+    const length = handles.push(handle)
+    handle.index = length - 1
+
+    return handle
+  }
+
+  _removeGroupNotify(handle) {
+    if (handle.index === -1) return
+
+    const topicHex = b4a.toString(handle._topic, 'hex')
+    const handles = this._groupNotifiers.get(topicHex)
+    if (!handles) return
+
+    const popped = handles.pop()
+    if (popped !== handle) handles[(popped.index = handle.index)] = popped
+    if (handles.length === 0) this._groupNotifiers.delete(topicHex)
+    handle.index = -1
+  }
+
   findingPeers() {
     if (this._findingPeers === null) this._findingPeers = new FindingPeers()
     this._findingPeers.inc(this.sessions)
@@ -309,10 +350,14 @@ class Corestore extends ReadyResource {
   async suspend({ log = noop } = {}) {
     await log('Flushing db...')
     // If readOnly we don't need to flush
-    if (!this.storage.readOnly) await this.storage.db.flush()
+    if (!this.storage.readOnly) {
+      await this.storage.db.flush()
+      await log('Flusing db completed')
+    }
     if (!this.shouldSuspend) return
     await log('Suspending db...')
-    await this.storage.suspend()
+    await this.storage.suspend({ log })
+    await log('Suspending db completed')
   }
 
   resume() {
@@ -568,6 +613,7 @@ class Corestore extends ReadyResource {
 
   _makeSession(conf) {
     const session = new Hypercore(null, null, conf)
+
     if (this._findingPeers !== null) this._findingPeers.add(session)
     return session
   }
@@ -610,7 +656,8 @@ class Corestore extends ReadyResource {
       keyPair: null,
       key: null,
       discoveryKey,
-      manifest: null
+      manifest: null,
+      group: null
     }
 
     if (opts.name) {
@@ -628,6 +675,10 @@ class Corestore extends ReadyResource {
       }
     }
 
+    if (opts.group) {
+      result.group = opts.group
+    }
+
     if (opts.key) result.key = ID.decode(opts.key)
     else if (result.manifest) result.key = Hypercore.key(result.manifest)
 
@@ -644,7 +695,7 @@ class Corestore extends ReadyResource {
     const auth = this._auth(discoveryKey, opts)
 
     const id = toHex(auth.discoveryKey)
-    const existing = this.cores.resume(id)
+    const existing = this.cores.resume(id, auth.group)
     if (existing && !existing.closing) return existing
 
     const core = Hypercore.createCore(this.storage, {
@@ -663,6 +714,7 @@ class Corestore extends ReadyResource {
       keyPair: auth.keyPair,
       legacy: opts.legacy,
       manifest: auth.manifest,
+      group: auth.group,
       globalCache: opts.globalCache || this.globalCache || null,
       alias: opts.name ? { name: opts.name, namespace: this.ns } : null
     })
@@ -671,6 +723,8 @@ class Corestore extends ReadyResource {
       this.cores.gc(core)
     }
 
+    core.ongroupupdate = this._onGroupActiveBound
+
     core.replicator.ondownloading = () => {
       if (this.active) this.streamTracker.attachAll(core)
     }

package/lib/notify.js

@@ -0,0 +1,27 @@
+const { EventEmitter } = require('events')
+const { Readable } = require('streamx')
+
+class GroupNotifyHandle extends EventEmitter {
+  constructor(store, topic) {
+    super()
+    this._store = store
+    this._topic = topic
+    this.index = -1
+  }
+
+  updates(opts) {
+    return Readable.deferred(async () => {
+      const groupId = await this._store.storage.getGroup(this._topic).catch(noop)
+      if (groupId === null) return null
+      return this._store.storage.createGroupUpdateStream(groupId, opts)
+    })
+  }
+
+  destroy() {
+    this._store._removeGroupNotify(this)
+  }
+}
+
+module.exports = GroupNotifyHandle
+
+function noop() {}

package/package.json

@@ -1,20 +1,28 @@
 {
   "name": "corestore",
-  "version": "7.9.2",
+  "version": "7.10.1",
   "description": "A Hypercore factory that simplifies managing collections of cores.",
   "main": "index.js",
   "files": [
     "index.js",
     "lib/*"
   ],
+  "imports": {
+    "events": {
+      "bare": "bare-events",
+      "default": "events"
+    }
+  },
   "dependencies": {
     "b4a": "^1.6.7",
-    "hypercore": "^11.19.0",
+    "bare-events": "^2.8.3",
+    "hypercore": "^11.32.0",
     "hypercore-crypto": "^3.4.2",
     "hypercore-errors": "^1.4.0",
     "hypercore-id-encoding": "^1.3.0",
     "ready-resource": "^1.1.1",
     "sodium-universal": "^5.0.1",
+    "streamx": "^2.26.0",
     "which-runtime": "^1.2.1"
   },
   "devDependencies": {
@@ -22,15 +30,14 @@
     "lunte": "^1.3.0",
     "prettier": "^3.6.2",
     "prettier-config-holepunch": "^2.0.0",
-    "rache": "^1.0.0",
-    "test-tmp": "^1.3.0"
+    "rache": "^1.0.0"
   },
   "scripts": {
     "format": "prettier --write .",
     "test": "npm run test:node && npm run test:bare",
-    "test:bare": "brittle-bare --coverage test/*.js",
+    "test:bare": "brittle-bare --coverage test/all.js",
     "lint": "prettier --check . && lunte",
-    "test:node": "brittle-node --coverage test/*.js"
+    "test:node": "brittle-node --coverage test/all.js"
   },
   "repository": {
     "type": "git",