refactor(app/test): address hyper deprecations in test helpers #3433

cratelyn · 2024-12-07T00:54:44Z

this commit changes the connect_and_accept(..) helper function used in
the proxy's unit tests, altering its logic such that it now runs
background tasks inside of a JoinSet.

then, subsequent commits hoist code out of run_proxy() and connect_client(), and consolidate our async move {} blocks. this both simplifies the control flow of this test infrastructure, but also addresses some more hyper deprecations.

for more information about our progressing upgrade to hyper 1.0, see linkerd/linkerd2#8733.

NB: this branch is based upon #3432.

this was not being flagged as an unused variable, due to the `#[instrument]` attribute. (😉 _it's used as a field in the generated span!_) `connect_timeout(..)` doesn't use its parameter. to address some deprecations, and avoid the need for polymorphism / refactoring related to http/1 and http/2 connections being represented as distinct types in the hyper 1.0 api, we remove it. Signed-off-by: katelyn martin <kate@buoyant.io>

this addresses hyper 1.0 deprecations in the server side of the inbound proxy's http unit test suite logic. see <linkerd/linkerd2#8733> for more information. the client end of this change ends up being slightly involved, due to changes that will need to be made in `linkerd_app_test::http_util`. accordingly, those deprecations will be addressed in a subsequent commit. Signed-off-by: katelyn martin <kate@buoyant.io>

this moves the public `connect_client(..)` function up to the top of the group of functions, and adds a documentation comment explaining its purpose. a todo comment is left noting that this can be refactored to use tokio's new `JoinSet` type. Signed-off-by: katelyn martin <kate@buoyant.io>

this is a small tweak, defering the call to `tokio::spawn(..)` to make using `JoinSet` easier. Signed-off-by: katelyn martin <kate@buoyant.io>

this commit changes the `connect_and_accept(..)` helper function used in the proxy's unit tests, altering its logic such that it now runs background tasks inside of a `JoinSet`. Signed-off-by: katelyn martin <kate@buoyant.io>

this commit makes two minor changes to the `run_proxy()` helper function: * remove a frivolous `.map(|_| ())` on a result that already had a tuple `Ok` type. * use `ServiceExt::oneshot` for brevity. this should have no effect on the tests, we're just golfing things down a bit. Signed-off-by: katelyn martin <kate@buoyant.io>

Signed-off-by: katelyn martin <kate@buoyant.io>

we've nudged this along well enough that this function can now reasonably be removed. Signed-off-by: katelyn martin <kate@buoyant.io>

and once more, we remove a helper function that isn't doing quite so much work, and whose signature contains deprecated hyper 1.0 types. Signed-off-by: katelyn martin <kate@buoyant.io>

we create `async move {}` blocks in multiple places, without any clear benefit. this commit consolidates them into one place: when we spawn a task onto the `JoinSet`. Signed-off-by: katelyn martin <kate@buoyant.io>

cratelyn · 2024-12-07T01:49:12Z

linkerd/app/test/src/http_util.rs

the diff in this file is much more easily reviewed on a commit by commit basis.

olix0r · 2024-12-09T16:53:54Z

linkerd/app/inbound/src/http/tests.rs

+    bg.join_all()
+        .await
+        .into_iter()
+        .collect::<Result<Vec<()>, Error>>()


If you want, you can use core::Result so this is just .collect::<Result<Vec<()>>>()

i took a swing at this, but i think i'll opt to elide this.

i have a personal aversion to importing Result aliases that overwrite the Result<T, E> included in the standard prelude, and found that the alternate .collect::<linkerd_app_core::Result<Vec<()>>>() form didn't really golf this down much.

olix0r · 2024-12-09T16:54:27Z

linkerd/app/test/src/http_util.rs

 #[allow(deprecated)] // linkerd/linkerd2#8733
-async fn connect_client(
+pub async fn connect_and_accept(


can the above deprecation be removed yet?

not quite yet, https://github.com/linkerd/linkerd2-proxy/pull/3433/files/ae3cca22f0219533bd3b8f59b81fb0f1e852ddcf#diff-8cdd5a92a26923db556253828b546a6741d66ed6e5be3ba2043b535d8e34695dR11 the ClientBuilder parameter to this function is still a deprecated connection builder type.

this is definitely next on the chopping block though 🗡️ 😈

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 <kate@buoyant.io>

## ✨ 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 <kate@buoyant.io> * chore(http/box): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(hyper-balance): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/retain): ugrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/stream-timeouts): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/classify): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * 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 <kate@buoyant.io> * 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 <kate@buoyant.io> * chore(http/metrics): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/prom): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/insert): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/retry): deprecate linkerd-http-body-compat Signed-off-by: katelyn martin <kate@buoyant.io> * chore(mock/http-body): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(http/retry): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(proxy/tap): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(proxy/http): update to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app/core): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app/test): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app/admin): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app/outbound): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app/inbound): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app/integration): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(app): upgrade to hyper 1.x Signed-off-by: katelyn martin <kate@buoyant.io> * chore(transport-header): update generated code Signed-off-by: katelyn martin <kate@buoyant.io> * chore(spiffe-proto): update generated code Signed-off-by: katelyn martin <kate@buoyant.io> * chore(opencensus-proto): update generated code Signed-off-by: katelyn martin <kate@buoyant.io> * chore(opentelemetry-proto): update generated code Signed-off-by: katelyn martin <kate@buoyant.io> * chore(deny.toml): update cargo-deny directives this commit updates the contents of `deny.toml`. Signed-off-by: katelyn martin <kate@buoyant.io> * 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 <kate@buoyant.io> * 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 <kate@buoyant.io> * chore(http/body-compat): remove `linkerd-http-body-compat` crate Signed-off-by: katelyn martin <kate@buoyant.io> * chore(deps): update to drain 0.2.1 see linkerd/drain-rs#41. Signed-off-by: katelyn martin <kate@buoyant.io> --------- Signed-off-by: katelyn martin <kate@buoyant.io>

cratelyn added 7 commits December 6, 2024 18:01

refactor(app/test): briefly defer spawn()ing tasks

d74f9be

this is a small tweak, defering the call to `tokio::spawn(..)` to make using `JoinSet` easier. Signed-off-by: katelyn martin <kate@buoyant.io>

refactor(app/test): use JoinSet for background tasks

a578a7d

this commit changes the `connect_and_accept(..)` helper function used in the proxy's unit tests, altering its logic such that it now runs background tasks inside of a `JoinSet`. Signed-off-by: katelyn martin <kate@buoyant.io>

refactor(app/test): hoist instrument(..) calls

d5052e9

Signed-off-by: katelyn martin <kate@buoyant.io>

cratelyn marked this pull request as ready for review December 7, 2024 01:14

cratelyn requested a review from a team as a code owner December 7, 2024 01:14

cratelyn added 2 commits December 6, 2024 20:16

refactor(app/test): remove run_proxy(..)

a7951e1

we've nudged this along well enough that this function can now reasonably be removed. Signed-off-by: katelyn martin <kate@buoyant.io>

refactor(app/test): remove connect_client(..)

15d1b09

and once more, we remove a helper function that isn't doing quite so much work, and whose signature contains deprecated hyper 1.0 types. Signed-off-by: katelyn martin <kate@buoyant.io>

cratelyn marked this pull request as draft December 7, 2024 01:32

refactor(app/test): consolidate anonymous futures

ae3cca2

we create `async move {}` blocks in multiple places, without any clear benefit. this commit consolidates them into one place: when we spawn a task onto the `JoinSet`. Signed-off-by: katelyn martin <kate@buoyant.io>

cratelyn force-pushed the kate/hyper-1.x-app-inbound-test-updates.part-2 branch from 4a06bf8 to ae3cca2 Compare December 7, 2024 01:41

cratelyn changed the title ~~refactor(app/test): use JoinSet for background tasks~~ refactor(app/test): address hyper deprecations in test helpers Dec 7, 2024

cratelyn commented Dec 7, 2024

View reviewed changes

linkerd/app/test/src/http_util.rs

Copy link

Collaborator Author

cratelyn Dec 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the diff in this file is much more easily reviewed on a commit by commit basis.

cratelyn marked this pull request as ready for review December 7, 2024 01:49

olix0r approved these changes Dec 9, 2024

View reviewed changes

Base automatically changed from kate/hyper-1.x-app-inbound-test-updates.part-1 to main December 9, 2024 16:55

cratelyn merged commit d65fe07 into main Dec 9, 2024
15 checks passed

cratelyn deleted the kate/hyper-1.x-app-inbound-test-updates.part-2 branch December 9, 2024 19:44

cratelyn mentioned this pull request Dec 11, 2024

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(app/test): address hyper deprecations in test helpers #3433

refactor(app/test): address hyper deprecations in test helpers #3433

Uh oh!

cratelyn commented Dec 7, 2024 •

edited

Loading

Uh oh!

cratelyn Dec 7, 2024

Uh oh!

olix0r Dec 9, 2024

Uh oh!

cratelyn Dec 9, 2024

Uh oh!

olix0r Dec 9, 2024

Uh oh!

cratelyn Dec 9, 2024

Uh oh!

Uh oh!

Uh oh!

refactor(app/test): address hyper deprecations in test helpers #3433

refactor(app/test): address hyper deprecations in test helpers #3433

Uh oh!

Conversation

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

Uh oh!

Uh oh!

cratelyn Dec 7, 2024

Choose a reason for hiding this comment

Uh oh!

olix0r Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

cratelyn Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

olix0r Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

cratelyn Dec 9, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cratelyn commented Dec 7, 2024 •

edited

Loading