n0-computer / n0-computer/iroh-docs
(sync) Reliable event subscriptions or hooks for documents
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 74
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Users will want to reliably react to document updates - eg to run compute or populate secondary indexes. We provide a event subscription API; however if this subscription is set up over the RPC or IPC this takes a few ticks, and thus may miss doc updates especially when the node is started.
We should look into either adding a hook feature or allowing to setup a catch-all subscription that can be created directly with node startup.
n0-computer/iroh#1495 improves subscriptions a bit but they are still an async call away, so not reliable to catch all events.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing event subscription API and how subscriptions are created over RPC or IPC, then review n0-computer/iroh#1495 for the related subscription changes. Define whether a startup-created catch-all subscription or a hook is the intended direction; done means document updates cannot be missed during node startup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, distributed-systems
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100