feat: add warning for multiple response writes#4606
Open
xingzihai wants to merge 1 commit intogin-gonic:masterfrom
Open
feat: add warning for multiple response writes#4606xingzihai wants to merge 1 commit intogin-gonic:masterfrom
xingzihai wants to merge 1 commit intogin-gonic:masterfrom
Conversation
When the response body is written multiple times in a single request, Gin now prints a warning in debug mode. This helps developers identify a common mistake where middleware or handlers accidentally write responses more than once, resulting in invalid concatenated output. The warning is printed via debugPrint() and only appears in debug mode, making this change non-breaking and backwards compatible. Fixes gin-gonic#4477 Example warning output: [GIN-debug] [WARNING] Response body already written. Attempting to write again with status code 200 Changes: - Added check in Context.Render() to detect multiple writes - Added unit tests to verify warning behavior in debug mode - Added test to verify no warning in release mode
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4606 +/- ##
==========================================
- Coverage 99.21% 98.43% -0.78%
==========================================
Files 42 48 +6
Lines 3182 3140 -42
==========================================
- Hits 3157 3091 -66
- Misses 17 40 +23
- 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 Sentry. 🚀 New features to boost your workflow:
|
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.
Summary
Adds a warning when attempting to write a response body multiple times. This helps developers debug issues where response bodies are written more than once.
Problem
When calling response write methods multiple times (e.g.,
c.Render()followed by another write), the behavior can be confusing. Developers may not realize they're overwriting a previous response.Solution
Context.Render()to detect if response body was already writtendebugPrintin debug modeChanges
context.go(+4 lines) - Added multiple write detectioncontext_test.go(+44 lines) - Added tests for debug and release modesTesting
TestRenderMultipleWritesWarning- verifies warning in debug modeTestRenderMultipleWritesNoWarningInReleaseMode- verifies no warning in release modeFixes #4477