refactor: move away from legacy hyper::body::HttpBody
#3467
Conversation
This file contains 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
cratelyn
force-pushed
the
kate/hyper-1.x-use-http-body
branch
from
0caacfa to
cac5c3a
Compare
cratelyn
changed the title
Body interfaceshyper::body::HttpBody
cratelyn
commented
Dec 16, 2024
| B: Default + hyper::body::HttpBody, | ||
| B: Default + linkerd_proxy_http::Body, |
There was a problem hiding this comment.
☝️ an example of replacing hyper::body::HttpBody with a stable linkerd_proxy_http::Body.
| pub fn serve<B>(&self, req: http::Request<B>) -> std::io::Result<http::Response<Body>> { | ||
| pub fn serve<B>(&self, req: http::Request<B>) -> std::io::Result<http::Response<BoxBody>> { |
There was a problem hiding this comment.
☝️ see places like this as well, where we move interfaces towards BoxBody.
cratelyn
force-pushed
the
kate/hyper-1.x-use-http-body
branch
from
cac5c3a to
9b6f0f2
Compare
cratelyn
force-pushed
the
kate/hyper-1.x-use-http-body
branch
from
9b6f0f2 to
cc80a41
Compare
sfleen
reviewed
Dec 17, 2024
this is an incremental step away from hyper 0.14's request and response body interfaces, and towards the 1.0 body types. see <linkerd/linkerd2#8733> for more information about upgrading to hyper 1.0. hyper 0.14 provides a `hyper::body::Body` that is removed in the 1.0 interface. `hyper-util` now provides a workable default body type. hyper 0.14 reëxports `http_body::Body` as `HttpBody`. hyper 1.0 reëxports this trait as `hyper::body::Body` without any renaming. this commit moves application code away from hyper's legacy `Body` type and the `HttpBody` trait alias. this commit moves assorted interfaces towards the boxed `BoxBody` type instead. when possible, code is tweaked such that it refers to the reëxport in `linkerd-proxy-http`, rather than directly through `hyper`. NB: this commit is based upon #3466. Signed-off-by: katelyn martin <[email protected]>
this commit relates to review feedback offered here: #3467 (comment) it is slightly ungainly to place a static string into a BoxBody, something that is a fairly common pattern throughout e.g. our admin server. to help nudge the compiler to infer a `B: Body` of `String`, various code follows a common convention of calling e.g. `BoxBody::new::<String>("ready\n".into())` or, `BoxBody::new("ready\n".to_string())`. this commit helps reduce that boilerplate by adding a `from_static(..)` constructor that accepts a static string. ```rust /// Returns a [`BoxBody`] with the contents of a static string. pub fn from_static(body: &'static str) -> Self { Self::new(body.to_string()) } ``` Co-authored-by: Scott Fleener <[email protected]> Signed-off-by: katelyn martin <[email protected]>
see <#3467 (comment)>. @sfleen points out this unfortunate part of our diff: ```diff - .body(json.into()) + .body(BoxBody::new(http_body::Full::new(bytes::Bytes::from(json)))) ``` this *is* a bit of an unfortunate edge, where boxing up a body feels especially cumbersome. this commit takes an attempt at tweaking the function in question so that this large nested expression reads a bit nicer. first, to justify why this gets a little more involved: hyper will no longer provide the `Body` type after 1.0, so we are tasked with providing our own body. for our purposes, `Full` works because we have a single chunk of bytes in hand. in order to create a `Full`, we must provide a `D: Buf`, which can be satisfied by the following types: <https://docs.rs/bytes/1.6.0/bytes/buf/trait.Buf.html#foreign-impls> most simply, we can cast our vector of bytes into a `Bytes`. with all of this in hand, we can hoist this creation of the body up out of the `match` arm, and use `Result::map` to apply these constructors in sequential order: ```rust // Serialize the value into JSON, and then place the bytes in a boxed response body. let json = serde_json::to_vec(val) .map(Bytes::from) .map(http_body::Full::new) .map(BoxBody::new); ``` Signed-off-by: katelyn martin <[email protected]>
cratelyn
force-pushed
the
kate/hyper-1.x-use-http-body
branch
from
cc80a41 to
4557952
Compare
|
NB: i just enabled auto-merge 🙂 |
sfleen
approved these changes
Dec 17, 2024
cratelyn
added a commit
that referenced
this pull request
Jan 8, 2025
see #8733. the tests for the replay body use the `hyper::Body` type removed in the 1.0 release. this commit replaces this with `BoxBody` where possible, and adds comments with context about how to update code once upgrading to hyper 1.0. see #3467 and #3468 which added `from_static()` and `empty()`, respectively. Signed-off-by: katelyn martin <[email protected]>
cratelyn
added a commit
that referenced
this pull request
Jan 10, 2025
see #8733. the tests for the replay body use the `hyper::Body` type removed in the 1.0 release. this commit replaces this with `BoxBody` where possible, and adds comments with context about how to update code once upgrading to hyper 1.0. see #3467 and #3468 which added `from_static()` and `empty()`, respectively. Signed-off-by: katelyn martin <[email protected]>
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.
this is an incremental step away from hyper 0.14's request and response
body interfaces, and towards the 1.0 body types. see
linkerd/linkerd2#8733 for more information
about upgrading to hyper 1.0.
hyper 0.14 provides a
hyper::body::Bodythat is removed in the 1.0interface.
hyper-utilnow provides a workable default body type. hyper0.14 reëxports
http_body::BodyasHttpBody. hyper 1.0 reëxports thistrait as
hyper::body::Bodywithout any renaming.this commit moves application code away from hyper's legacy
Bodytypeand the
HttpBodytrait alias. this commit moves assorted interfacestowards the boxed
BoxBodytype instead. when possible, code is tweakedsuch that it refers to the reëxport in
linkerd-proxy-http, rather thandirectly through
hyper.NB: this commit is based upon #3466.