Change: Remove RemoteError variant from StreamingError
#1325
Conversation
This file contains 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
The return error type of `openraft::network::snapshot_transport::Chunked::send_snapshot()` is simplified from `StreamingError<_, Fatal>` to `StreamingError<_>`. This change is made because the remote `Fatal` error cannot be handled by the sending end and should not be produced at all. Upgrade Tip: If `Chunked` is used in a `RaftNetworkV2` implementation to adapt the v1 `RaftNetwork`, simply remove the error handling for `Fatal`. Otherwise, no changes are required.
`StreamingError` is intended to represent non-logic errors that occur while streaming data to a remote peer. A `RemoteError` does not belong in a stream RPC error and should instead be included as part of a non-error response. Upgrade tip: No modifications are required for this change, as no related API utilized the `RemoteError` variant.
drmingdrmer
force-pushed
the
182-stream-error
branch
from
fec9004 to
9fed9a4
Compare
schreter
approved these changes
Feb 5, 2025
There was a problem hiding this comment.
Reviewed 4 of 4 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @drmingdrmer)
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.
Changelog
Change: Remove
RemoteErrorvariant fromStreamingErrorStreamingErroris intended to represent non-logic errors that occurwhile streaming data to a remote peer. A
RemoteErrordoes not belongin a stream RPC error and should instead be included as part of a
non-error response.
Upgrade tip:
No modifications are required for this change, as no related API
utilized the
RemoteErrorvariant.Change: Simplify
send_snapshot()error type inChunkedThe return error type of
openraft::network::snapshot_transport::Chunked::send_snapshot()issimplified from
StreamingError<_, Fatal>toStreamingError<_>. Thischange is made because the remote
Fatalerror cannot be handled by thesending end and should not be produced at all.
Upgrade Tip:
If
Chunkedis used in aRaftNetworkV2implementation to adapt the v1RaftNetwork, simply remove the error handling forFatal. Otherwise,no changes are required.
This change is