fix: safe type assertions in CloseNotify() and Hijack()#4639
Open
jassus213 wants to merge 2 commits intogin-gonic:masterfrom
Open
fix: safe type assertions in CloseNotify() and Hijack()#4639jassus213 wants to merge 2 commits intogin-gonic:masterfrom
jassus213 wants to merge 2 commits intogin-gonic:masterfrom
Conversation
When gin is used with http.TimeoutHandler or any other middleware that wraps http.ResponseWriter with a type that does not implement http.Hijacker or http.CloseNotifier, the direct type assertions in Hijack() and CloseNotify() cause a runtime panic. Replace with checked assertions following the same pattern already used in Flush(). CloseNotify() returns nil when unsupported (http.CloseNotifier is deprecated since Go 1.11). Hijack() returns a descriptive error, consistent with the existing errHijackAlreadyWritten pattern. Fixes gin-gonic#4460
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4639 +/- ##
==========================================
- Coverage 99.21% 98.43% -0.79%
==========================================
Files 42 48 +6
Lines 3182 3761 +579
==========================================
+ Hits 3157 3702 +545
- Misses 17 50 +33
- 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.
Problem
Similar to #4460 (fixed for
Flush()in #4479),Hijack()andCloseNotify()perform direct type assertions that panic when the underlying writer doesn't implement the interface.When gin is used with
http.TimeoutHandleror any middleware that wrapshttp.ResponseWriterwith a type that doesn't implementhttp.Hijackerorhttp.CloseNotifier, callingHijack()orCloseNotify()causes a runtime panic:Fix
Replace direct assertions with checked assertions - the same pattern already used in
Flush():CloseNotify()returnsnilwhen unsupported (http.CloseNotifieris deprecated since Go 1.11; callers should useRequest.Context().Done())Hijack()returnserrHijackNotSupported, consistent with the existingerrHijackAlreadyWrittenpatternThe capability check in
Hijack()now runs before mutatingw.size, soWritten()staysfalseon the error path.Tests
Added
TestResponseWriterOptionalInterfaceFallbackswith amockNonHijackerWriter(implements onlyhttp.ResponseWriter) verifying thatFlush(),CloseNotify(), andHijack()all degrade gracefully without panicking.Closes #4638.