Repository navigation
docs: say when to use it, and when something else fits better - #64
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
The README and the docs home page promised "exactly once" and "at-most-once message processing", while the architecture page and agents.md say the guarantee is one execution per key while Redis is up and at-least-once when it is down (unless
on_storage_error="raise"). This brings the front pages in line with that:It also adds a "When to use it, and when not" section: HTTP-only middleware for a few endpoints, a unique constraint when the write has a natural key, failing closed or a database-backed record when a repeat is unacceptable during a Redis outage, and no sync API or non-Redis store out of the box.
Type of change
Checklist
zensical build --cleanpasses locally, no warnings