feat: add warning for multiple response writes#4603
Open
xingzihai wants to merge 1 commit intogin-gonic:masterfrom
Open
feat: add warning for multiple response writes#4603xingzihai wants to merge 1 commit intogin-gonic:masterfrom
xingzihai wants to merge 1 commit intogin-gonic:masterfrom
Conversation
Add debug warning when multiple response writes are detected in Context.Render(). This helps developers identify potential issues where multiple calls to response writing methods (JSON, XML, String, etc.) would concatenate outputs. Changes: - Add wroteResponse bool field to Context struct - Reset wroteResponse in Context.reset() method - Check and warn in Context.Render() before writing - Set wroteResponse=true after successful write The warning is only printed in debug mode using debugPrint(), which is controlled by gin.SetMode(). In release mode, no warning is printed.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4603 +/- ##
==========================================
- Coverage 99.21% 98.44% -0.78%
==========================================
Files 42 48 +6
Lines 3182 3143 -39
==========================================
- Hits 3157 3094 -63
- 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
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.
Summary
This PR adds a warning when multiple response writes are attempted on the same context, addressing issue #4477.
Problem
When a handler writes a response multiple times (e.g., calling
c.JSON()twice, or mixingc.String()withc.JSON()), the second write silently fails or causes unexpected behavior. Users often encounter this issue without understanding what went wrong.Solution
Added a warning mechanism that logs a clear warning message when multiple response writes are detected.
Changes
context.goTesting
Fixes #4477