Conversation
There was a problem hiding this comment.
Pull request overview
Adds an Unwrap() method to the logging responseWriter wrapper so net/http’s http.ResponseController can traverse through the wrapper to reach capabilities (e.g., flushing/hijacking) provided by the underlying http.ResponseWriter.
Changes:
- Implement
(*responseWriter).Unwrap() http.ResponseWriterinlmw.go. - Document why the wrapper needs to be unwrap-able for downstream streaming use-cases.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Unwrap() http.ResponseWriterto the logging middleware's response wrapper sohttp.ResponseControllercan navigate past it to findFlusher,Hijacker, and other interfaces on the underlying writer. Without this, any SSE/streaming handler downstream ofDurationLoggingMiddlewarecannot flush and either errors out or silently truncates.Background
DurationLoggingMiddlewarewrapshttp.ResponseWriterin*responseWriterto capture the status code and response size for logging. The wrapper embedshttp.ResponseWriterbut the embedded interface doesn't exposeFlush/Hijack/Push, so a downstreamw.(http.Flusher)type assertion fails. The standard-library remedy is for wrappers to implementUnwrap() http.ResponseWriter, whichhttp.ResponseControllerfollows.Discovered via
A new SSE endpoint (
GET /jobs/queues/{queue}/jobs/{jobId}/watch) intransitland-lib's jobserver returned an empty body when mounted in tlv2's middleware chain — the chain includes this logging middleware, which was breakingFlush().Test plan
lmw_test.gocontinues to pass.--enable-jobs-api, confirmcurl -N $BASE/queues/$Q/jobs/$JOB_ID/watchagainst an already-terminal job emits the terminal event andevent: endsentinel before the connection closes. Before this change, the body was empty.