zapcore: Improve errors unit tests #1414
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
Previously, implementing `ObjectMarshaler` on an error type was ignored unless the error was logged with `zap.Any` or `zap.Object`. We should respect the `ObjectMarshaler` instead as this is more flexible than the basic `error` or `fmt.Formatter` interfaces. Resolves uber-go#1365
justinhwang
commented
Feb 7, 2024
zapcore/error.go
Outdated
| // In the case of a ObjectMarshaler, | ||
| // | ||
| // { | ||
| // "error": { |
There was a problem hiding this comment.
Technically this is a breaking change as we would have an object here instead of a string but I would argue that this would be the intended behavior when someone implements ObjectMarshaler on their error type.
|
See #641 for a previous discussion on this. tl;dr is that this change is a bigger breaking change than we want. Ideally we want to make this happen without breaking existing users of Zap. |
justinhwang
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1414 +/- ##
==========================================
+ Coverage 98.44% 98.69% +0.25%
==========================================
Files 53 53
Lines 3527 2997 -530
==========================================
- Hits 3472 2958 -514
+ Misses 46 31 -15
+ Partials 9 8 -1 ☔ View full report in Codecov by Sentry. |
tchung1118
approved these changes
Mar 7, 2024
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.
Updates and adds some unit tests for the zapcore/errors.go file.