feat(client/plugin): stream HTTP client plugin responses#795
Open
Nicofuma wants to merge 1 commit into
Open
Conversation
Nicofuma
force-pushed
the
prototype/streaming-client-plugin-executor
branch
2 times, most recently
from
efa18f7 to
e2311f2
Compare
The client plugin executor buffered the entire plugin response with httptest.NewRecorder and only returned once ServeHTTP completed, which makes streaming responses (Server-Sent Events, chunked passthrough, large downloads) impossible: the proxy, and therefore the client, received nothing until the plugin handler returned, i.e. until the upstream stream closed. Run the handler in a goroutine writing into an io.Pipe and return the response as soon as the status line and headers are known, with the pipe's read end as the body. Bytes now flow to the caller as the handler produces them. The pipe is unbuffered, so the executor watches the request context and closes the read end on cancellation, ensuring the handler goroutine unwinds even when a consumer drops the response. Flush commits the headers like net/http, a panicking handler surfaces as a 502, and the error-status handler bounds how much of a streaming error body it reads. Signed-off-by: Tristan Darricau <tristan.darricau@jobteaser.com>
Nicofuma
force-pushed
the
prototype/streaming-client-plugin-executor
branch
from
e2311f2 to
fb8b998
Compare
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.
The client plugin executor buffered the entire plugin response with httptest.NewRecorder and only returned once ServeHTTP completed, which makes streaming responses (Server-Sent Events, chunked passthrough, large downloads) impossible: the proxy, and therefore the client, received nothing until the plugin handler returned, i.e. until the upstream stream closed.
Run the handler in a goroutine writing into an io.Pipe and return the response as soon as the status line and headers are known, with the pipe's read end as the body. Bytes now flow to the caller as the handler produces them.
The pipe is unbuffered, so the executor watches the request context and closes the read end on cancellation, ensuring the handler goroutine unwinds even when a consumer drops the response. Flush commits the headers like net/http, a panicking handler surfaces as a 502, and the error-status handler bounds how much of a streaming error body it reads.