fix: prevent superfluous response.WriteHeader call in EncodeJSONResponse#537
Open
Kubudak90 wants to merge 1 commit into
Open
fix: prevent superfluous response.WriteHeader call in EncodeJSONResponse#537Kubudak90 wants to merge 1 commit into
Kubudak90 wants to merge 1 commit into
Conversation
The EncodeJSONResponse function was calling w.WriteHeader(status) before encoding the JSON response. If json.NewEncoder(w).Encode(i) failed, it would call http.Error() which internally calls WriteHeader again, causing the "http: superfluous response.WriteHeader call" error. This fix: 1. Encodes the JSON to a buffer first 2. Only writes the header if encoding succeeds 3. Uses http.Error() only on encoding failure (before any header is written) Fixes coinbase#407
🟡 Heimdall Review Status
|
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
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.
Description
Fixes #407
The EncodeJSONResponse function was calling w.WriteHeader(status) before encoding the JSON response. If json.NewEncoder(w).Encode(i) failed, it would call http.Error() which internally calls WriteHeader again, causing the "http: superfluous response.WriteHeader call" error when running rosetta-cli check:data with high concurrency.
Changes
This follows the Go HTTP best practice of validating content before writing headers to avoid the superfluous WriteHeader error described in Go Forum.
Testing
The fix ensures that:
No duplicate WriteHeader calls can occur with this fix.