fix safeError & safeString for json format #20
Merged
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
ChrisHines
requested changes
Mar 12, 2022
There was a problem hiding this comment.
Thanks for the PR, and thanks for including tests!
The implementation and tests look good here, I think we can improve the specific messages we log for the panics so I've provided alternatives that I think make it more clear what has gone wrong in these situations. With those changes this will be ready to merge.
json_logger.go
Outdated
| @@ -68,7 +68,7 @@ func safeString(str fmt.Stringer) (s string) { | |||
| if v := reflect.ValueOf(str); v.Kind() == reflect.Ptr && v.IsNil() { | |||
| s = "NULL" | |||
| } else { | |||
| panic(panicVal) | |||
| s = fmt.Sprintf("panic stringer value: %v", panicVal) | |||
There was a problem hiding this comment.
I think we should make it more obvious something went wrong with getting the string (or error). I think this message may not be prominent enough.
Let's change this to:
fmt.Sprintf("PANIC in String method: %v", panicVal)
json_logger.go
Outdated
| @@ -82,7 +82,7 @@ func safeError(err error) (s interface{}) { | |||
| if v := reflect.ValueOf(err); v.Kind() == reflect.Ptr && v.IsNil() { | |||
| s = nil | |||
| } else { | |||
| panic(panicVal) | |||
| s = fmt.Sprintf("panic error value: %v", panicVal) | |||
There was a problem hiding this comment.
Similar to above let's make this:
fmt.Sprintf("PANIC in Error method: %v", panicVal)
ChrisHines
approved these changes
Mar 20, 2022
|
Thanks for the contribution! |
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.
relates to #19