docs(streaming): clarify rewind scope - #10927
Open
ReubenBond wants to merge 1 commit into
Open
Conversation
ReubenBond
added
documentation
area-streaming
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Review tier: Lite
Findings: None
What changed in this PR
Clarifies Orleans streaming “rewind” terminology across the documentation by separating (1) per-subscription cursor positioning within the live Orleans queue cache, (2) receiver recovery via durable checkpoints, and (3) replay from an external transport’s retained history—aligning the provider matrix and guidance with current runtime/provider behavior (notably Kinesis reporting IsRewindable = false).
Changes:
- Updates the provider capability matrix and per-provider guidance to describe rewindability as live-cache bounded for Event Hubs and Redis Streams and non-rewindable for Kinesis (checkpoint-based recovery only).
- Documents cache-miss behavior (
QueueCacheMissException) when a subscription token predates the live cache, and clarifies that built-in pulling agents do not open historical readers on cache misses. - Expands custom adapter guidance to describe where retained-history readers and cold-to-hot cursor handoff belong (adapter-specific cache/receiver composition).
| File | Description |
|---|---|
| docs/site/src/content/docs/streaming/stream-providers.md | Updates the provider matrix and provider-specific sections to reflect live-cache-bounded rewind and distinguish checkpoint recovery from subscription rewind. |
| docs/site/src/content/docs/streaming/delivery-semantics.md | Refines the definition of rewindability and documents cache-miss behavior and the absence of built-in historical readers on miss. |
| docs/site/src/content/docs/streaming/data-adapters.md | Adjusts Event Hubs adapter wording to emphasize checkpoint recovery and live-cache rewind semantics. |
| docs/site/src/content/docs/streaming/custom-queue-adapter.md | Clarifies the role of IQueueCache.GetCacheCursor vs receiver progression and outlines how retained-history replay belongs in custom adapter composition. |
| docs/site/src/content/docs/implementation/streams-implementation/index.md | Updates implementation guidance to frame rewindability as cache-range support and to position retained-history replay as adapter-specific. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Problem
The streaming documentation conflates three different behaviors: subscription cursor rewind within the live Orleans queue cache, receiver recovery from a durable partition checkpoint, and replay from the external transport's retained history. That overstates the current Event Hubs and Redis subscription rewind range and lists Kinesis as rewindable even though its merged adapter reports
IsRewindableasfalse.Solution
Clarify the provider matrix and streaming guidance so that:
Rationale
Issue #756 specifically requests per-subscription replay from the physical queue after an event leaves the live cache. The current runtime supports adjacent cache rewind and checkpoint recovery behavior, while the requested historical-reader handoff remains a provider design task.
Refs #756
Microsoft Reviewers: Open in CodeFlow