refactor: move away from legacy `hyper::body::HttpBody` #3467

cratelyn · 2024-12-16T20:21:53Z

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.

cratelyn · 2024-12-16T20:42:14Z

linkerd/app/core/src/errors/respond.rs

-    B: Default + hyper::body::HttpBody,
+    B: Default + linkerd_proxy_http::Body,


☝️ an example of replacing hyper::body::HttpBody with a stable linkerd_proxy_http::Body.

cratelyn · 2024-12-16T20:44:16Z

linkerd/metrics/src/serve.rs

-    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>> {


☝️ see places like this as well, where we move interfaces towards BoxBody.

linkerd/app/admin/src/server.rs

linkerd/app/admin/src/server/json.rs

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]>

@sfleen

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 · 2024-12-17T19:32:27Z

NB: i just enabled auto-merge 🙂

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]>

note: this commit will not compile, code changes are intentionally elided from this commit. this commit upgrades hyper, http, tonic, prost, related dependencies, and their assorted cargo features. see <linkerd/linkerd2#8733>. see also: * #3379 * #3380 * #3382 * #3405 * hyperium/hyper#3796 * #3411 * #3421 * #3427 * #3428 * #3432 * #3433 * #3444 * #3445 * #3454 * #3455 * #3456 * #3457 * #3461 * #3459 * #3465 * #3466 * #3467 * #3468 * linkerd/linkerd2-proxy-api#421 * linkerd/linkerd2#13492 * linkerd/linkerd2#13493 * hyperium/hyper#3816 * #3472 * #3473 * #3479 * tokio-rs/tokio#7059 * #3509 * hyperium/http-body#140 * #3515 * hyperium/http-body#141 * #3530 * #3531 * #3540 * #3556 * #3558 * #3559 * #3564 * #3567 * #3573 * #3583 * hyperium/http-body#144 * #3585 * #3586 * #3597 * #3598 * #3611 * #3614 * #3615 * #3616 * #3647 * #3651 * #3653 * #3654 * #3655 * #3656 * #3657 * #3660 * #3671 * #3672 * #3673 * #3676 * hyperium/http-body#147 * #3692 * #3699 * #3700 * #3701 * #3708 * linkerd/drain-rs#36 * #3715 * #3717 * eminence/procfs#340 --- squash: chore(deps): add hyper-util workspace dependency chore(deps): add http-body-util workspace dependency chore(deps): upgrade linkerd2-proxy-api this commit represents main as of linkerd/linkerd2-proxy-api#421. Signed-off-by: katelyn martin <[email protected]>

## ✨ chore(deps): upgrade to hyperium 1.x crates this branch performs an exciting upgrade for our proxy. this branch upgrades a number of our dependencies so that we use the 1.0 release family of the `hyper` http framework, and its ecosystem. see the [v1.0 announcement][hyper-v1] for more information. this branch upgrades the following dependencies: * `h2`: 0.3 -> 0.4 * `http`: 0.2 -> 1 * `http-body`: 0.4 -> 1 * `hyper`: 0.14.32 -> 1 * `prost`: 0.12 -> 0.13 * `prost-build`: 0.12 -> 0.13 * `prost-types`: 0.12 -> 0.13 * `tonic`: 0.10 -> 0.12 * `tonic-build`: 0.10 -> 0.12 a `hyper-util` dependency is added, which provides among other things, legacy-compatible interfaces such as `hyper_util::client::legacy::Client`, or glue to use `hyper` with the tokio runtime. see <https://docs.rs/hyper-util/latest/hyper_util/> for more information. a `http-body-util` dependency is added, which provides a `BodyExt` trait and a channel-backed body for use in unit tests. the `deprecated` feature flag that was active on our `0.14` hyper dependency has been removed, along with the `stream` and `runtime` feature flags. the `linkerd2-proxy-api` dependency is updated. see: <linkerd/linkerd2-proxy-api#421> ### 📝 notes for review bear particular attention to changes involving `http_body::Body` middleware. the change from two separate `poll_data()` and `poll_trailers()` functions, to a single `poll_frame()` method, induces some subtle changes to various pieces of middleware. also bear in mind that failing to set a timer, in our case `hyper_util::rt::TokioTimer`, can cause http/2 clients, or http/1 and http/2 servers, to panic. make sure that any uses of `hyper::server::conn::http1::Builder`, `hyper::client::conn::http1::Builder`, or `hyper::client::conn::http2::Builder` install a timer. ### ❗ breaking change: `l5d-proxy-error` values the `l5d-proxy-error` header can be examined to observe the cause of proxy errors encountered when sending meshed traffic. by virtue of this using a newer `hyper` client in the proxy, some error messages may in turn look different. for example, an error like `"connect timed out after 1s"` may now appear as `"client error (Connect)"`. ### 📚 other notes this work, by virtue of touching so many parts of the system, is carried out in distinct commits. an initial commit upgrades the dependencies at th workspace level. subsequent commits will not compile if the `--workspace` flag is provided, but the intent of this branch is to update each crate individually. use commands like, e.g. `cargo check --tests -p linkerd-proxy-http` to build particular crates at intermediate commits within this branch. this commit is also only the final leaf in an _extended_ line of work. this has been done to mitigate the effort of reviewing this change, and the risk of churn in the event of any unanticipated errors. see the top-level comment in linkerd/linkerd2#8733 for an overview of all of the work that brought us to this juncture. [hyper-v1]: https://seanmonstar.com/blog/hyper-v1/ --- * chore(deps): upgrade to hyper 1.x note: this commit will not compile, code changes are intentionally elided from this commit. this commit upgrades hyper, http, tonic, prost, related dependencies, and their assorted cargo features. see <linkerd/linkerd2#8733>. see also: * #3379 * #3380 * #3382 * #3405 * hyperium/hyper#3796 * #3411 * #3421 * #3427 * #3428 * #3432 * #3433 * #3444 * #3445 * #3454 * #3455 * #3456 * #3457 * #3461 * #3459 * #3465 * #3466 * #3467 * #3468 * linkerd/linkerd2-proxy-api#421 * linkerd/linkerd2#13492 * linkerd/linkerd2#13493 * hyperium/hyper#3816 * #3472 * #3473 * #3479 * tokio-rs/tokio#7059 * #3509 * hyperium/http-body#140 * #3515 * hyperium/http-body#141 * #3530 * #3531 * #3540 * #3556 * #3558 * #3559 * #3564 * #3567 * #3573 * #3583 * hyperium/http-body#144 * #3585 * #3586 * #3597 * #3598 * #3611 * #3614 * #3615 * #3616 * #3647 * #3651 * #3653 * #3654 * #3655 * #3656 * #3657 * #3660 * #3671 * #3672 * #3673 * #3676 * hyperium/http-body#147 * #3692 * #3699 * #3700 * #3701 * #3708 * linkerd/drain-rs#36 * #3715 * #3717 * eminence/procfs#340 --- squash: chore(deps): add hyper-util workspace dependency chore(deps): add http-body-util workspace dependency chore(deps): upgrade linkerd2-proxy-api this commit represents main as of linkerd/linkerd2-proxy-api#421. Signed-off-by: katelyn martin <[email protected]> * chore(http/box): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(hyper-balance): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/retain): ugrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/stream-timeouts): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/classify): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/upgrade): upgrade to hyper 1.x NOTE: there is a comment noting that the upgrade middleware does not expect to be cloneable. it is unfortunately, however, at odds with the new bounds expected of extensions. so, `Http11Upgrade` is now Clone'able, but a comment is left in place noting this weakened invariant. it's worth investigating how upgrades have changed since, in more detail, but for the current moment we are interested in being especially conservative about changing behavior, and focusing on api changes like `Body::poll_frame(..)`. Signed-off-by: katelyn martin <[email protected]> * chore(metrics): upgrade to hyper 1.x a brief note; this commit happened to tickle an unfortunate sharp edge in `BoxBody` and `Full`'s respective constructors. type inference could not figure out how to construct the body, so we refrain from boxing the response body now. Signed-off-by: katelyn martin <[email protected]> * chore(http/metrics): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/prom): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/insert): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/retry): deprecate linkerd-http-body-compat Signed-off-by: katelyn martin <[email protected]> * chore(mock/http-body): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(http/retry): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(proxy/tap): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(proxy/http): update to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app/core): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app/test): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app/admin): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app/outbound): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app/inbound): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app/integration): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(app): upgrade to hyper 1.x Signed-off-by: katelyn martin <[email protected]> * chore(transport-header): update generated code Signed-off-by: katelyn martin <[email protected]> * chore(spiffe-proto): update generated code Signed-off-by: katelyn martin <[email protected]> * chore(opencensus-proto): update generated code Signed-off-by: katelyn martin <[email protected]> * chore(opentelemetry-proto): update generated code Signed-off-by: katelyn martin <[email protected]> * chore(deny.toml): update cargo-deny directives this commit updates the contents of `deny.toml`. Signed-off-by: katelyn martin <[email protected]> * chore: `compile` has been renamed to `compile_protos` this addresses deprecation warnings, updating calls to a function that has since been renamed. Signed-off-by: katelyn martin <[email protected]> * chore(deps): remove `linkerd-http-body-compat` dependencies this commit removes this crate, which we added to future proof code for this upgrade, from its dependents. Signed-off-by: katelyn martin <[email protected]> * chore(http/body-compat): remove `linkerd-http-body-compat` crate Signed-off-by: katelyn martin <[email protected]> * chore(deps): update to drain 0.2.1 see linkerd/drain-rs#41. Signed-off-by: katelyn martin <[email protected]> --------- Signed-off-by: katelyn martin <[email protected]>

cratelyn force-pushed the kate/hyper-1.x-use-http-body branch from 0caacfa to cac5c3a Compare December 16, 2024 20:36

cratelyn changed the title ~~refactor: move towards new Body interfaces~~ refactor: move away from legacy hyper::body::HttpBody Dec 16, 2024

cratelyn commented Dec 16, 2024

View reviewed changes

cratelyn force-pushed the kate/hyper-1.x-use-http-body branch from cac5c3a to 9b6f0f2 Compare December 16, 2024 20:46

cratelyn mentioned this pull request Dec 16, 2024

proxy: Figure out the plan for Hyper 1.0 migration linkerd/linkerd2#8733

Open

cratelyn marked this pull request as ready for review December 16, 2024 20:58

cratelyn requested a review from a team as a code owner December 16, 2024 20:58

Base automatically changed from kate/http-workspace-dependency to main December 17, 2024 12:46

cratelyn force-pushed the kate/hyper-1.x-use-http-body branch from 9b6f0f2 to cc80a41 Compare December 17, 2024 15:41

DavidMcLaughlin assigned sfleen Dec 17, 2024

sfleen reviewed Dec 17, 2024

View reviewed changes

linkerd/app/admin/src/server.rs Outdated Show resolved Hide resolved

linkerd/app/admin/src/server/json.rs Outdated Show resolved Hide resolved

cratelyn mentioned this pull request Dec 17, 2024

feat(http/box): BoxBody::empty() creates an empty body #3468

Merged

cratelyn and others added 3 commits December 17, 2024 13:30

cratelyn force-pushed the kate/hyper-1.x-use-http-body branch from cc80a41 to 4557952 Compare December 17, 2024 19:16

cratelyn enabled auto-merge (squash) December 17, 2024 19:32

sfleen approved these changes Dec 17, 2024

View reviewed changes

cratelyn merged commit deb92db into main Dec 17, 2024
18 checks passed

cratelyn deleted the kate/hyper-1.x-use-http-body branch December 17, 2024 19:53

cratelyn mentioned this pull request Jan 8, 2025

chore(http/retry): use boxed bodies instead of hyper::Body #3515

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: move away from legacy `hyper::body::HttpBody` #3467

refactor: move away from legacy `hyper::body::HttpBody` #3467

Uh oh!

cratelyn commented Dec 16, 2024 •

edited

Loading

Uh oh!

cratelyn Dec 16, 2024

Uh oh!

cratelyn Dec 16, 2024

Uh oh!

Uh oh!

Uh oh!

cratelyn commented Dec 17, 2024

Uh oh!

Uh oh!

Uh oh!

		B: Default + hyper::body::HttpBody,
		B: Default + 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>> {

refactor: move away from legacy hyper::body::HttpBody #3467

refactor: move away from legacy hyper::body::HttpBody #3467

Uh oh!

Conversation

cratelyn commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cratelyn Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

cratelyn Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cratelyn commented Dec 17, 2024

Uh oh!

Uh oh!

Uh oh!

refactor: move away from legacy `hyper::body::HttpBody` #3467

refactor: move away from legacy `hyper::body::HttpBody` #3467

cratelyn commented Dec 16, 2024 •

edited

Loading