fix: flush status immediately for no-body response codes#4714
Closed
xbrxr03 wants to merge 1 commit into
Closed
Conversation
ctx.Status() sets the status on gin's responseWriter but never flushes it to the underlying http.ResponseWriter when no body is written. This causes httptest.ResponseRecorder and similar wrappers to see the default 200 instead of the actual status code. This particularly affects status codes that never have a body (1xx, 204, 304) where handlers typically call ctx.Status() without writing content. The fix mirrors the existing behavior in ctx.Render(), which already calls WriteHeaderNow() for no-body status codes. By flushing immediately for these codes in Status(), the correct status propagates to the underlying writer without requiring a separate Write() call. Fixes gin-gonic#4071
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4714 +/- ##
==========================================
- Coverage 99.21% 98.39% -0.83%
==========================================
Files 42 48 +6
Lines 3182 3172 -10
==========================================
- Hits 3157 3121 -36
- Misses 17 42 +25
- Partials 8 9 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Author
|
Closing this PR due to lack of maintainer engagement. I'm happy to reopen if there's interest. Thanks for the great project. |
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.
Problem
ctx.Status(code)doesn't flush the status code to the underlyinghttp.ResponseWriterwhen no body is written. This causeshttptest.ResponseRecorderand similar wrappers to see the default 200 instead of the actual status code.Reported in #4071.
Root Cause
ctx.Status()callsc.Writer.WriteHeader(code), which only stores the status in gin'sresponseWriterbuffer. The status gets flushed to the underlying writer whenWrite()is called (which triggersWriteHeaderNow()). But for status codes that never have a body (1xx, 204, 304), noWrite()ever happens, so the status never reaches the underlyingResponseRecorder.This is inconsistent with
ctx.Render(), which already callsWriteHeaderNow()for no-body status codes.Fix
When
Status()is called with a no-body status code (wherebodyAllowedForStatus()returns false), immediately flush the status to the underlying writer viaWriteHeaderNow(). This mirrors the existing behavior inRender()and matches user expectations.For status codes that allow a body (e.g. 200),
Status()continues to buffer the status untilWrite()is called, preserving the existing behavior for handlers that set a status before writing content.Tests
TestContextStatusFlushesNoBodyCodes: verifies 100, 101, 102, 204, and 304 flush immediatelyTestContextStatusWithBodyDoesNotFlushEarly: verifies 200 still buffers until Write() is calledAll existing tests continue to pass.
Fixes #4071