fix(server): avoid superfluous response.WriteHeader call in EncodeJSONResponse - #543
Open
Kubudak90 wants to merge 1 commit into
Open
Conversation
…NResponse EncodeJSONResponse was calling w.WriteHeader(status) before json.NewEncoder(w).Encode(i). If encoding failed after partially writing to the response, http.Error would attempt a second WriteHeader, producing the "http: superfluous response.WriteHeader call" log message seen in high-concurrency environments. The fix encodes to a bytes.Buffer first, writes the header only on success, and returns a clean 500 when encoding fails. Changes: - Encode JSON to an intermediate buffer before writing headers - Add unit tests for success, custom status, and encode-error cases Fixes coinbase#407
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
1 participant
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.
Fixes #407
EncodeJSONResponse was calling w.WriteHeader(status) before json.NewEncoder(w).Encode(i). If encoding failed after partially writing to the response, http.Error would attempt a second WriteHeader, producing the "http: superfluous response.WriteHeader call" log message seen in high-concurrency environments.
The fix encodes to a bytes.Buffer first, writes the header only on success, and returns a clean 500 when encoding fails.
Changes: