Fix SSE timeout will affected by http.Server 's WriteTimeout #5024
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue where Server-Sent Events (SSE) connections are affected by the http.Server's WriteTimeout configuration. The solution prevents SSE connections from being terminated by write timeouts by disabling the write deadline for these specific connections.
- Adds an Unwrap method to WithCodeResponseWriter to expose the underlying ResponseWriter
- Implements write deadline clearing for SSE routes using http.NewResponseController
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| rest/internal/response/withcoderesponsewriter.go | Adds Unwrap method to expose underlying ResponseWriter for timeout control |
| rest/engine.go | Implements SSE timeout fix by clearing write deadlines using ResponseController |
Comments suppressed due to low confidence (1)
rest/engine.go:75
- [nitpick] The error message on line 77 could be more descriptive. Consider changing 'set conn write deadline failed' to 'failed to clear write deadline for SSE connection' to better explain the context and purpose.
err := rc.SetWriteDeadline(time.Time{})
Co-authored-by: Copilot <[email protected]>
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
kevwan
approved these changes
Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
realted issue :#4451
according to https://stackoverflow.com/questions/27097084/http-server-read-write-timeouts-and-server-side-events