Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to Hyper 1.0 & Axum 0.7 #1670

Open
wants to merge 57 commits into
base: master
Choose a base branch
from
Open

Conversation

alexrudy
Copy link
Contributor

@alexrudy alexrudy commented Mar 31, 2024

Current Status: This is ready for CI & review!

This is a continuation of PR #1595 by @ikrivosheev.

TODO:

  • update imports to use -util crates (done in Update to hyper 1.0 and axum 0.7 #1595)
  • update AddrStream and AddrIncoming (done in Update to hyper 1.0 and axum 0.7 #1595)
  • fix hyper-timeout connector (done in Update to hyper 1.0 and axum 0.7 #1595)
  • use axum Request and Response in transport (via TowerToHyperService in Client)
  • change poll_trailers to use poll_frame. Still some work to do here about preserving data and trailers if poll_frame returns a frame type we aren't expecting.
  • Correctly handle data & trailer frames for server.
  • fix connect, Connect (no more hyper::client::service::Connect) (using hyper-util)
  • Get around "Implementation of From not general enough" compiler issue.
  • Correctly implement graceful shutdown (maybe based on hyper-util, but also not too hard to do independently, following axum's example.)
  • Pass through max_pending_accept_reset_streams (needs a release with PR #102 in hyper-util)
  • Correctly implement http2_only (needs PR #111 in hyper-util.
  • Figure out what to do about hyper_util ConnectError
  • Add socket2 dependency to support TCP SO_NODELAY and SO_KEEPALIVE
  • Compatibility of other tonic-* crates (e.g. tonic-web)
  • Examples
  • Check over Docs
  • Version Update

@alexrudy
Copy link
Contributor Author

alexrudy commented Apr 3, 2024

I'd like to propose that this be reviewed as-is, and that we add follow-up issues for the remaining todos, which will all require PRs to land and then releases to happen for hyper and/or hyper-utils.

@karuna
Copy link

karuna commented Apr 6, 2024

works perfectly after cargo update

Phoenix500526 added a commit to Phoenix500526/Xline that referenced this pull request Apr 7, 2024
remove `--ignore` option when pr(when hyperium/tonic#1670) is merged.

Signed-off-by: Phoeniix Zhao <Phoenix500526@163.com>
Phoenix500526 added a commit to xline-kv/Xline that referenced this pull request Apr 8, 2024
remove `--ignore` option when pr(when hyperium/tonic#1670) is merged.

Signed-off-by: Phoeniix Zhao <Phoenix500526@163.com>
rustls-pemfile = { version = "1", optional = true }
tower-http = { version = "0.4", optional = true }
tokio-rustls = { version = "0.26.0", optional = true }
hyper-rustls = { version = "0.27.0", features = ["http2"], optional = true }
Copy link

Choose a reason for hiding this comment

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

It would be nice if there were feature flags to switch between the crypto backends.
Defaulting to aws-lc-rs pulls in a cmake, nasm requirement, impacts platform support, etc.
Trading that off for FIPS compliance isn't really needed in most cases.

Copy link

@aumetra aumetra Apr 8, 2024

Choose a reason for hiding this comment

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

Which crypto provider tonic should default to is up to the maintainers, I guess.
But reqwest seems to be going the route of sticking to ring as the default crypto backend.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think that is a good idea, but I don't think it should be included in this PR - this PR is already complicated as is. We can create an issue and work on multi-backend support separately once this lands.

Copy link

Choose a reason for hiding this comment

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

Yeah, definitely. I just felt like the comment fit best here for the time being since the PR isn't merged yet and I probably would have forgotten about it if I hadn't written it down

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Following up here - I reverted the default to use ring and not aws-lc-rs for exactly the same reason as reqwest

@tisonkun
Copy link
Contributor

cc @tottoto @LucioFranco can we get this patch a review? This should be one of the last blockers for many downstreams upgrade to hyper 1.0.

@tisonkun
Copy link
Contributor

@alexrudy FYI hyperium/hyper-util#102 is merged now.

@hubertshelley
Copy link

hubertshelley commented May 15, 2024

@alexrudy Example h2c failed.
Terminal output:

called `Result::unwrap()` on an `Err` value: hyper::Error(User(ManualUpgrade))

@alexrudy
Copy link
Contributor Author

@alexrudy Example h2c failed.

Thanks! 5a579e6 contains the fix.

@djc
Copy link
Collaborator

djc commented May 22, 2024

@alexrudy and @ikrivosheev thanks for all your work on this!

I'm going to be helping @LucioFranco out with tonic reviews, and obviously this is a desirable change. As such, I've made an initial pass of the changes here. Here are some thoughts:

  • Since this is already such a large change, I'd like to avoid intertwining the changes that are necessary to upgrade hyper/axum with any other changes that can be done independently. For example, reformatting of Cargo.toml files, upgrading to a different nightly, reordering imports and other small changes like adding type annotations. To facilitate review I think all of those changes should either be reverted in this PR or submitted as part of separate PRs (with one commit or PR per logical change) where we can judge them properly -- the goal is to make this PR as small and focused as possible.
  • I think it might make sense for now to just delete any of the examples that rely on warp, probably in a separate PR? While warp was one of the newer options when tonic got started, today it's much less popular than Axum -- and by virtue of doing this in a separate commit/PR it should be relatively straightforward to bring back those examples once warp upgrades to hyper/http 1.
  • I would like to avoid further entangling of Axum and Tonic proper. Ideally this change should be neutral in how much of Axum is used in -- if that's hard for some reason let's discuss that separately? Especially for client-only users, we should be working in a direction where it's possible to avoid depending on Axum.

Copy link
Member

@LucioFranco LucioFranco left a comment

Choose a reason for hiding this comment

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

I am still working through the PR, I think what @djc makes a lot of sense, I am going to continue reviewing the core web and tonic parts since it seems like those changes are somewhat non trivial. So it will take some time just as an FYI.

@@ -52,7 +52,10 @@ async fn connect_returns_err_via_call_after_connected() {
let res = client.unary_call(Request::new(Input {})).await;

let err = res.unwrap_err();
assert_eq!(err.code(), Code::Unavailable);
assert_eq!(err.code(), Code::Unknown);
Copy link
Member

Choose a reason for hiding this comment

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

I kinda want to keep the old assert and have the tests failing and get that fixed upstream before we merge. I think keeping these error codes is super super important.

@alexrudy
Copy link
Contributor Author

@djc Thanks so much for your initial comments.

Overall, I tried to minimally scope the changes here based on what was required to make the tests pass with hyper >= 1.

For instance:

  • The change in the nightly compiler version from 2024-02-06 to 2024-04-16 is required to make Axum >= 0.7 compile on nightly (it otherwise requires #![feature(diagnostic_namespace)] to compile, and we can't change the nightly features requested by a dependency IIUC.
  • There are type annotations added where type inference was no longer sufficient to allow code to compile - e.g. in the h2c/server.rs example, due to the move from calling hyper's server directly to calling TcpListener:bind(), type inference is no longer able to resolve the FromStr::Err type (which will get transformed to Box<dyn Error>, and in tls_rustls examples, types have to be added because rustls and rustls_pemfile have changed their public API types, which in turn are required upgrades (I think) for compatibility with hyper-rustls for hyper 1.0.

I will fix the cargo.toml formatting (this came from my IDE's auto formatter, and I should have caught that before).

For warp – I'm happy to delete those examples entirely, either in this PR or another one - deleting them is a pre-requisite to the CI tests passing.

This also brings up @LucioFranco's point about the changed error type, which we might want to leave failing: that sounds fine by me, I don't know of a good way though to leave a test in an expected failure state in Rust. Also, just letting the test fail will be problematic, as CI is currently configured to fail-fast, meaning that one failure will cause a lot of other tests to be skipped entirely. We could change that setting as well, if that is what is desired.

On Axum: I don't think that this PR increases the degree to which the two libraries are intertwined - there is some private adaptor code added, but the tonic::transport::service::router part has always been built on the axum::Router class - are you suggesting that we should be implementing our own routing? That feels like a separate endeavor to me. Or was there somewhere else that this PR ends up intertwining the two further? From my perspective, I thought it was pretty neutral about how much of Axum is required by tonic.

Finally, it seems like you both have a preference for a re-written history here to break commits into more logical chunks - I'll take a stab at that as well, I had defaulted to preserving history to start, but am fine with either strategy.

Overall, @djc, I would love specific comments on parts of this PR that are really separable - or the decision that we'd rather merge a series of PRs, some of which contain the pre-requistites to the upgrade to hyper-1.0, and the final one that contains the final upgrade. Given the scope of the API changes, I'm personally opposed to that latter solution, since sometimes solving for code which is compatible with pre-1.0 hyper and post-1.0 hyper adds additional complexity to the implementation, which we'd then have to clean up as well.

@tisonkun
Copy link
Contributor

tisonkun commented May 25, 2024

@alexrudy FYI hyper-util v0.1.4 should contain the API you need above.

@ikrivosheev
Copy link

@alexrudy as I can see, hyper-util v0.1.4 is released. Can you upgrade the PR?

https://crates.io/crates/hyper-util

Trailers are now polled as a frame in the body - so we have to handle them at the same time that poll data.

If trailers are encountered during client decode, they are stored and returned once poll_frame stops returning data frames.

Since GRPC web frames are not aligned with underlying HTTP frames, we can’t simply return trailers once we find them - we have to use the presence of trailers to indicate the end of message frames.
The `poll_frame` method must produce the trailer frame along side the body data frames, so when we
reach the end of the encoded data as the server, we encode the GRPC status as a trailing header and return that.
First pass at graceful shutdown
In-progress connections now prevent the server from returning until they are complete, ensuing that graceful termination can still happen.
See rust-lang/cargo#10788 for the full issue.

When enabling a feature of a dependency, the syntax `tokio/rt` implicitly required a feature `tokio` to exist in 1.70 of cargo. By 1.77 this has been fixed. To work around this, we can use "weak feature dependencies" like `tokio?/rt` which enables the `rt` feature of tokio only if tokio is itself an enabled dependency. Also adding `dep:tokio` to the list of dependencies ensures that this is always true.

When the MSRV is upgraded again, we can probably remove the weak `?` and the `dep:tokio` in these cases.
transport uses tokio::select!
aws-lc-crypto doesn't seem to compile by defualt on windows.

Ideally, this should be a feature we toggle between.
It is only used by the TLS feature.
This requires CMake.

Once again, a fast-follow should enable aws-lc-rs as a feature and the ability to switch between ring and aws-lc-rs
Found some places where links were not resolving correctly, this corrects them.
According to [hyperium#689](hyperium#689) streams should end after the first error. Therefore, when we find an error in the response step, discard the trailers so that the stream ends.
Server has to explicitly opt-in to upgrade support.
This provides proper support for `http2_only()` and `max_pending_accept_reset_streams()` settings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants