fix(*) implement TextMarshaler for JSON keys #2475
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
Add TextMarshaler implementations for types that are uses as map keys. These types are marshaled to JSON for logging, and the map key conversion in this case requires encoding.TextMarshaler to be implemented. It is quite confusing for users to see a marshaling error in the Kuma logs, since it is difficult to distinguish from a real Kuma error. This fixes #2374. Signed-off-by: James Peach <james.peach@konghq.com>
Codecov Report
@@ Coverage Diff @@
## master #2475 +/- ##
==========================================
+ Coverage 52.46% 52.53% +0.07%
==========================================
Files 886 886
Lines 48276 48280 +4
==========================================
+ Hits 25329 25365 +36
+ Misses 20921 20882 -39
- Partials 2026 2033 +7
Continue to review full report at Codecov.
|
lahabana
approved these changes
Aug 2, 2021
jakubdyszkiewicz
approved these changes
Aug 2, 2021
mergify bot
pushed a commit
that referenced
this pull request
Aug 2, 2021
Add TextMarshaler implementations for types that are uses as map keys. These types are marshaled to JSON for logging, and the map key conversion in this case requires encoding.TextMarshaler to be implemented. It is quite confusing for users to see a marshaling error in the Kuma logs, since it is difficult to distinguish from a real Kuma error. This fixes #2374. Signed-off-by: James Peach <james.peach@konghq.com> (cherry picked from commit 60d7f97)
jpeach
added a commit
that referenced
this pull request
Aug 2, 2021
Add TextMarshaler implementations for types that are uses as map keys. These types are marshaled to JSON for logging, and the map key conversion in this case requires encoding.TextMarshaler to be implemented. It is quite confusing for users to see a marshaling error in the Kuma logs, since it is difficult to distinguish from a real Kuma error. This fixes #2374. Signed-off-by: James Peach <james.peach@konghq.com> (cherry picked from commit 60d7f97) Co-authored-by: James Peach <james.peach@konghq.com>
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.
Summary
Add TextMarshaler implementations for types that are uses as map keys.
These types are marshaled to JSON for logging, and the map key conversion
in this case requires encoding.TextMarshaler to be implemented. It is
quite confusing for users to see a marshaling error in the Kuma logs,
since it is difficult to distinguish from a real Kuma error.
Full changelog
Issues resolved
Fix #2374.
Documentation
N/A
Testing
Backwards compatibility
backport-to-stablelabel if the code is backwards compatible. Otherwise, list breaking changes.