feat: implement Debug for PingError so messages display #1659
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
KolbyML
requested review from
carver,
mrferris,
njgheorghita,
ogenev and
morph-dev
morph-dev
approved these changes
Feb 1, 2025
| .map_err(|_| { | ||
| ssz::DecodeError::BytesInvalid(format!("Invalid utf8 string: {:?}", self.message)) | ||
| }) | ||
| .map_err(|_| std::fmt::Error)?; |
There was a problem hiding this comment.
Wouldn't this map_err completely invalidate previous one and basically always return std::fmt::Error?
How about we do something like this:
let message = String::from_utf8(&self.message)
.unwrap_or_else(|_| format!("Invalid utf8 string: {}", hex_encode(&self.message)));
f.debug_struct("PingError")
.field("error_code", &self.error_code)
.field("message", &message)
.finish()| @@ -6,7 +8,7 @@ use ssz_types::{typenum::U300, VariableList}; | |||
| use crate::types::portal_wire::CustomPayload; | |||
|
|
|||
| /// Used to respond to pings which the node can't handle | |||
| #[derive(PartialEq, Debug, Clone, Encode, Decode)] | |||
| #[derive(PartialEq, Clone, Encode, Decode)] | |||
There was a problem hiding this comment.
nit: In my opinion, if structure implements PartialEq, it should also implement Eq if it applies for it.
KolbyML
force-pushed
the
add-debug-for-discovery
branch
from
6655266 to
3ce5401
Compare
morph-dev
approved these changes
Feb 1, 2025
| @@ -30,6 +32,18 @@ impl PingError { | |||
| } | |||
| } | |||
|
|
|||
| impl Debug for PingError { | |||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | |||
| let message = String::from_utf8(self.message.to_vec()) | |||
There was a problem hiding this comment.
nit: you should be able to use &*self.message here as well (instead of calling to_vec())
There was a problem hiding this comment.
That doesn't compile String::from_utf8 only takes a Vec
There was a problem hiding this comment.
Looks like milos was looking at str::from_utf8 well I was looking at String::from_utf8
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.
What was wrong?
The default derived Debug implementation printed the message as bytes
How was it fixed?
Implement Debug manually to decode the Ping Message, there is no point in decoding it unless we print it so I think this strikes a pretty good balance.