[DEC-2159] - add generic json printer to help format customtypes in protos #702
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
WalkthroughThe changes primarily involve the introduction of a new function Changes
TipsChat with CodeRabbit Bot (
|
jakob-dydx
force-pushed
the
jakob-dydx/json-printer
branch
from
d2afcf1 to
7746c8d
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- protocol/lib/json.go (1 hunks)
- protocol/x/clob/keeper/deleveraging.go (3 hunks)
Files skipped from review due to trivial changes (1)
- protocol/x/clob/keeper/deleveraging.go
jayy04
approved these changes
Oct 25, 2023
Comment on lines
+1
to
+17
| package lib | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| ) | ||
|
|
||
| // MaybeGetStructJsonString returns the json representation of a struct, or a formatted string using | ||
| // %+v if the json conversion encounters an error. | ||
| func MaybeGetJsonString(i interface{}) string { | ||
| jsonData, err := json.Marshal(i) | ||
| if err != nil { | ||
| return fmt.Sprintf("%+v", i) | ||
| } | ||
|
|
||
| return string(jsonData) | ||
| } |
There was a problem hiding this comment.
The function MaybeGetJsonString is well implemented. It tries to convert an interface to a JSON string and if it fails, it returns a formatted string. It also handles nil inputs correctly. However, it's important to note that the error from json.Marshal is silently ignored. While this might be acceptable in some cases, it could lead to unexpected behavior if the input is not serializable and the caller is not aware of this. Consider logging the error or returning it to the caller to handle.
- func MaybeGetJsonString(i interface{}) string {
+ func MaybeGetJsonString(i interface{}) (string, error) {
jsonData, err := json.Marshal(i)
if err != nil {
return fmt.Sprintf("%+v", i), err
}
return string(jsonData), nil
}Committable suggestion (Beta)
Suggested change
| package lib | |
| import ( | |
| "encoding/json" | |
| "fmt" | |
| ) | |
| // MaybeGetStructJsonString returns the json representation of a struct, or a formatted string using | |
| // %+v if the json conversion encounters an error. | |
| func MaybeGetJsonString(i interface{}) string { | |
| jsonData, err := json.Marshal(i) | |
| if err != nil { | |
| return fmt.Sprintf("%+v", i) | |
| } | |
| return string(jsonData) | |
| } | |
| func MaybeGetJsonString(i interface{}) (string, error) { | |
| jsonData, err := json.Marshal(i) | |
| if err != nil { | |
| return fmt.Sprintf("%+v", i), err | |
| } | |
| return string(jsonData), nil | |
| } |
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.
No description provided.