fix(httpx): Resolve HTML escaping issue during JSON serialization #5032
Conversation
This file contains hidden or 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
Contributor
Disdjj
commented
Jul 24, 2025
- Implemented json.Encoder as a replacement for json.Marshal to prevent automatic HTML character escaping
- Introduced the doMarshalJson function to handle JSON serialization logic
- Added comprehensive test cases to validate serialization behavior across various data types
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
kevwan
reviewed
Jul 25, 2025
- Implemented json.Encoder as a replacement for json.Marshal to prevent automatic HTML character escaping - Introduced the doMarshalJson function to handle JSON serialization logic - Added comprehensive test cases to validate serialization behavior across various data types
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an HTML escaping issue in JSON serialization by replacing json.Marshal with a custom json.Encoder that disables HTML escaping. This ensures that characters like &, <, and > are not unnecessarily escaped as Unicode sequences in JSON responses.
- Implemented
doMarshalJsonfunction usingjson.NewEncoderwithSetEscapeHTML(false) - Updated
doWriteJsonto use the new marshaling function instead ofjson.Marshal - Added comprehensive test coverage for various data types and URL scenarios
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| rest/httpx/responses.go | Implements new JSON marshaling function to prevent HTML escaping |
| rest/httpx/responses_test.go | Adds comprehensive test cases for the new marshaling function |
Comments suppressed due to low confidence (1)
rest/httpx/responses_test.go:500
- The map test case has non-deterministic key ordering in JSON output. Consider using a struct with ordered fields or a map with a single key to ensure consistent test results across different Go versions.
args: args{map[string]int{"a": 1, "b": 2}},
kevwan
approved these changes
Jul 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.