Support users opting-out of us setting framing headers. #2508
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
Motivation: Right now we always set the framing headers in HTTP requests and responses that we send. This is a good practice for most users, but it can cause issues, most notably in responses to CONNECT requests which requires that we do not set framing headers. Unfortunately, in NIO's current HTTP/1.1 design it is not possible for us to suppress these headers. This is because the HTTP encoders come _earlier_ in the pipeline than the decoders, so the HTTP encoders do not know structurally what requests they are responding to. While we could merge the encoders/decoders, that's a fairly substantial change. A better short-term change is to offer users the ability to turn off the NIO header manipulation feature. In this circumstance, users take on full responsibility for appropriately framing their HTTP messages. Modifications - Add config to HTTPRequestEncoder and HTTPResponseEncoder. - Plumb this config through. - Add a bunch of tests. Result Users have way more control of HTTP/1.1 messages.
glbrntt
approved these changes
Aug 22, 2023
Sources/NIOHTTP1/HTTPEncoder.swift
Outdated
| /// encoding, when needed. | ||
| private func messageIsChunked(headers: HTTPHeaders, version: HTTPVersion) -> Bool { | ||
| if version.major == 1 && version.minor >= 1 { | ||
| return headers["transfer-encoding"].first == "chunked" ? true : false |
There was a problem hiding this comment.
nit: headers.first(name: "transfer-encoding")
Sources/NIOHTTP1/HTTPEncoder.swift
Outdated
| self.isChunked = correctlyFrameTransportHeaders(hasBody: response.status.mayHaveResponseBody ? .yes : .no, | ||
| headers: &response.headers, version: response.version) == .chunked | ||
|
|
||
| if configuration.automaticallySetFramingHeaders { |
There was a problem hiding this comment.
Suggested change
| if configuration.automaticallySetFramingHeaders { | |
| if self.configuration.automaticallySetFramingHeaders { |
dnadoba
approved these changes
Aug 22, 2023
1proprogrammerchant
added a commit
to 1proprogrammerchant/swift-nio
that referenced
this pull request
Aug 24, 2023
Support users opting-out of us setting framing headers. (apple#2508)
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.
Motivation:
Right now we always set the framing headers in HTTP requests and responses that we send. This is a good practice for most users, but it can cause issues, most notably in responses to CONNECT requests which requires that we do not set framing headers.
Unfortunately, in NIO's current HTTP/1.1 design it is not possible for us to suppress these headers. This is because the HTTP encoders come earlier in the pipeline than the decoders, so the HTTP encoders do not know structurally what requests they are responding to.
While we could merge the encoders/decoders, that's a fairly substantial change. A better short-term change is to offer users the ability to turn off the NIO header manipulation feature. In this circumstance, users take on full responsibility for appropriately framing their HTTP messages.
Modifications
Result
Users have way more control of HTTP/1.1 messages.