Show "<nil>" for nil Stringer. #854
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
In encodeStringer, instead of returning an error when a panic occurs when calling String() on a nil pointer, use the string value "<nil>" like the fmt package does. It is not always possible to handle this case by fixing the implementation of String to not panic. This requires implementing String with a pointer receiver, which doesn't work if you need to be able to call String on non-addressable values.
|
|
Codecov Report
@@ Coverage Diff @@
## master #854 +/- ##
=======================================
Coverage 98.35% 98.35%
=======================================
Files 43 43
Lines 2368 2372 +4
=======================================
+ Hits 2329 2333 +4
Misses 32 32
Partials 7 7
Continue to review full report at Codecov.
|
prashantv
reviewed
Aug 4, 2020
| @@ -208,7 +208,12 @@ func addFields(enc ObjectEncoder, fields []Field) { | |||
| func encodeStringer(key string, stringer interface{}, enc ObjectEncoder) (err error) { | |||
| defer func() { | |||
| if v := recover(); v != nil { | |||
| err = fmt.Errorf("PANIC=%v", v) | |||
| val := reflect.ValueOf(stringer) | |||
There was a problem hiding this comment.
This block looks very similar to the logic in the fmt package uses to determine if nil should be used,
https://golang.org/src/fmt/print.go#L540
Should we reference this?
abhinav
reviewed
Aug 28, 2020
| @@ -208,7 +208,12 @@ func addFields(enc ObjectEncoder, fields []Field) { | |||
| func encodeStringer(key string, stringer interface{}, enc ObjectEncoder) (err error) { | |||
| defer func() { | |||
| if v := recover(); v != nil { | |||
| err = fmt.Errorf("PANIC=%v", v) | |||
| val := reflect.ValueOf(stringer) | |||
There was a problem hiding this comment.
Suggested change
| val := reflect.ValueOf(stringer) | |
| // See also https://golang.org/src/fmt/print.go#L540. | |
| val := reflect.ValueOf(stringer) |
prashantv
approved these changes
Aug 28, 2020
cgxxv
pushed a commit
to cgxxv/zap
that referenced
this pull request
Mar 25, 2022
In encodeStringer, instead of returning an error when a panic occurs when calling String() on a nil pointer, use the string value "<nil>" like the fmt package does. It is not always possible to handle this case by fixing the implementation of String to not panic. This requires implementing String with a pointer receiver, which doesn't work if you need to be able to call String on non-addressable values.
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.
In encodeStringer, instead of returning an error when a panic
occurs when calling String() on a nil pointer, use the string value
"" like the fmt package does.
It is not always possible to handle this case by fixing the
implementation of String to not panic. This requires implementing
String with a pointer receiver, which doesn't work if you need to
be able to call String on non-addressable values.