Support response header modifications with streaming#572
Open
mdmower-csnw wants to merge 1 commit into
Open
Conversation
- Add option `stream` so that users can opt into response body streaming
while also modifying response headers.
- Gating this with an option ensures the application behavior does not
change for existing users of the application. It also means there is
a better chance users will see and consider the warning "be careful
about modifying response headers that describe the body".
- This capability is safe because response headers are fully read by
the time `userResHeaderDecorator` runs.
- Add tests that ensure response header modifications still work when
streaming is enabled.
- Update readme.
Author
|
@monkpow - Is this a feature you'd be willing to consider for the proxy? |
mdmower-csnw
commented
Jun 2, 2026
Comment on lines
+36
to
+41
| if (stream && resolved.skipToNextHandlerFilter) { | ||
| throw new Error( | ||
| 'skipToNextHandlerFilter inspects a buffered response and cannot be ' + | ||
| 'combined with stream:true.' | ||
| ); | ||
| } |
Author
There was a problem hiding this comment.
An argument could be made for allowing simultaneous use of stream and skipToNextHandlerFilter, but the user would have to recognize that reading the body in skipToNextHandlerFilter is a no-no.
Collaborator
|
@mdmower-csnw Thanks so much for the PR. I'm on summer break at the moment, so it will take me at least a week to review in detail, but I like what I see so far. |
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
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.
streamso that users can opt into response body streaming while also modifying response headers.userResHeaderDecoratorruns.