passive-core-watcher 0.0.2 → 1.0.1

package/README.md

@@ -10,7 +10,7 @@ npm i passive-core-watcher
 
 #### `const watcher = new PassiveCoreWatcher(corestore, { watch, open })`
 
-Create a new passive core watcher.
+Create a new passive core watcher, and start watching new cores. Existing cores are also processed (e.g. `open` will be called for all existing cores for which `watch` returns true).
 
 `corestore` is a Corestore
 
@@ -22,13 +22,7 @@ The session emits a `close` event when it is closing. If teardown of the side ef
 
 `session.on('close', () => { /* run teardown logic for side effects */ } )`
 
-#### `await watcher.ready()`
-
-Setup the passive watcher, so it starts listening for new hypercores.
-
-This also checks which of the already-opened hypercores need to be watched, and calls the `open` function for those.
-
-#### `await watcher.close()`
+#### `watcher.destroy()`
 
 Stops watching the corestore for new cores, and closes all weak sessions.
 
@@ -39,3 +33,9 @@ Stops watching the corestore for new cores, and closes all weak sessions.
 If the hypercore is open in the corestore, it is added to the watcher lifecycle, and the `open` method is called (does nothing otherwise).
 
 Useful when the `watch` condition might be false when the core first opens, but became true later.
+
+#### `watcher.on('oncoreopen-error', e)`
+
+Emitted when an error is thrown while a new core is being processed (for example during the passed-in `watch` or `open` functions). Useful for debugging and logging.
+
+`e` is an error object.

package/index.js

@@ -1,31 +1,38 @@
-const ReadyResource = require('ready-resource')
+const { EventEmitter } = require('events')
 const Hypercore = require('hypercore')
 const b4a = require('b4a')
 const HypCrypto = require('hypercore-crypto')
 const IdEnc = require('hypercore-id-encoding')
+const safetyCatch = require('safety-catch')
 
-class PassiveCoreWatcher extends ReadyResource {
+class PassiveCoreWatcher extends EventEmitter {
   constructor (corestore, { watch, open }) {
     super()
-
     this.store = corestore
     this.watch = watch
     this.open = open
 
     this._oncoreopenBound = this._oncoreopen.bind(this)
     this._openCores = new Map()
-  }
 
-  async _open () {
-    this.store.watch(this._oncoreopenBound)
-    await Promise.all(
-      [...this.store.cores.map.values()].map(this._oncoreopenBound)
-    )
+    this.destroyed = false
+
+    // Give time to add event handlers
+    queueMicrotask(() => {
+      if (this.destroyed) return
+      this.store.watch(this._oncoreopenBound)
+      for (const core of this.store.cores.map.values()) {
+        this._oncoreopenBound(core) // never rejects
+      }
+    })
   }
 
-  async _close () {
+  destroy () {
+    this.destroyed = true
     this.store.unwatch(this._oncoreopenBound)
-    await Promise.allSettled([...this._openCores.values()].map(c => c.close()))
+    for (const core of this._openCores.values()) {
+      core.close().catch(safetyCatch)
+    }
   }
 
   async _oncoreopen (core) { // not allowed to throw
@@ -59,6 +66,7 @@ class PassiveCoreWatcher extends ReadyResource {
 
     session.on('close', () => {
       this._openCores.delete(discKey)
+      this.emit('gc', discKey)
     })
 
     await this.open(session)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "passive-core-watcher",
-  "version": "0.0.2",
+  "version": "1.0.1",
   "description": "Run conditional logic on a corestore's hypercores",
   "main": "index.js",
   "scripts": {
-    "test": "standard"
+    "test": "standard && brittle test.js"
   },
   "repository": {
     "type": "git",
@@ -13,6 +13,12 @@
   "files": [
     "index.js"
   ],
+  "imports": {
+    "events": {
+      "bare": "bare-events",
+      "default": "events"
+    }
+  },
   "keywords": [
     "Corestore",
     "hypercore"
@@ -24,13 +30,17 @@
   },
   "homepage": "https://github.com/holepunchto/passive-core-watcher#readme",
   "devDependencies": {
-    "standard": "^17.1.2"
+    "brittle": "^3.10.0",
+    "corestore": "^7.0.0",
+    "standard": "^17.1.2",
+    "test-tmp": "^1.4.0"
   },
   "dependencies": {
     "b4a": "^1.6.7",
+    "bare-events": "^2.5.4",
     "hypercore": "^11.0.0",
     "hypercore-crypto": "^3.4.2",
     "hypercore-id-encoding": "^1.3.0",
-    "ready-resource": "^1.1.1"
+    "safety-catch": "^1.0.2"
   }
 }