fix: Don't report an error on benign end of stream #321
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 implementation of reading multiple messages from a stream involved looping until an error was encountered, and this error would then be logged. We typically send just a single message per stream, so this implementation meant we would log a serializatione error after reading every message. This commit updates `WireMsg::read_from_stream` to return an `Option`, and `None` is now used to break the loop. No public APIs have changed – APIs that must return a message will still return a serialization error if the stream ends (though the error message has changed, but this is judged to be outside the stable API).
oetyng
approved these changes
Sep 7, 2021
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.
47dc629 fix: Don't report an error on benign end of stream
The implementation of reading multiple messages from a stream involved
looping until an error was encountered, and this error would then be
logged. We typically send just a single message per stream, so this
implementation meant we would log a serializatione error after reading
every message.
This commit updates
WireMsg::read_from_streamto return anOption,and
Noneis now used to break the loop. No public APIs have changed –APIs that must return a message will still return a serialization error
if the stream ends (though the error message has changed, but this is
judged to be outside the stable API).