Repository navigation
docs(readme): document per-scope service composition pattern - #17
Merged
Merged
Conversation
Explain how to construct one ConsensusService per scope while sharing the storage backend, using cloned storage handles + private BroadcastEventBus per service. Note the negligible cost of scope-indexed storage (kB-scale in-memory; partition key on databases).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new "Service shape: one service vs. per-scope services" subsection under Core Concepts. Documents the pattern of constructing one
ConsensusServiceper scope while sharing the storage backend across services (useful for per-conversation, per-channel, per-room consumers that want isolated event subscribers without duplicating data).The pattern is already supported by the existing API —
ConsensusStorageimpls areClone+Arc-backed, so a single storage handle can be cloned into many services, each with its own privateBroadcastEventBus. This PR is documentation-only; no code changes.Also notes that scope indexing in storage is essentially free:
Test plan