fix(tonic): don't include error's cause in Display impl #633
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
At Embark we have a little helper function that converts a `&dyn std::error::Error` into a `String` by walking the full chain of sources (with `std::error::Error::source`) and joining them into a `String`. We use that where we log errors to get as much information as possible about whats causing an error. Works particularly well with anyhow's `.context()` method. However since `tonic::transport::Error` include its cause in their `Display` impl we get the sources more than once. As the cause can already be obtained through `std::error::Error::source` no information should be lost by doing this. Fixes #632
26 tasks
LucioFranco
approved these changes
May 27, 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.
At Embark we have a little helper function that converts a
&dyn std::error::Errorinto aStringby walking the full chain of sources(with
std::error::Error::source) and joining them into aString.We use that where we log errors to get as much information as possible
about whats causing an error. Works particularly well with anyhow's
.context()method.However since
tonic::transport::Errorinclude its cause in theirDisplayimpl we get the sources more than once.As the cause can already be obtained through
std::error::Error::sourceno information should be lost by doing this.
Fixes #632