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.

Sign up for GitHub

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

Jump to bottom

Impossible to use tonic-web (0.12.3) while multiplexing with axum (0.7.7) without using the deprecated Router::into_router()? #1964

Open
repnop opened this issue Sep 30, 2024 · 1 comment
Open

Impossible to use tonic-web (0.12.3) while multiplexing with axum (0.7.7) without using the deprecated Router::into_router()? #1964

repnop opened this issue Sep 30, 2024 · 1 comment

Comments

@repnop
Copy link

repnop commented Sep 30, 2024

Bug Report

Version

axum = { version = "0.7.7", features = ["macros"] }
hyper = { version = "1.4.1", features = ["http1", "http2", "server"] }
tonic = "0.12.3"
tonic-web = "0.12.3"
tower = { version = "0.5.1", features = ["steer"] }
tower-http = { version = "0.6.1", features = ["cors", "trace"] }

Platform

N/A

Crates

tonic = "0.12.3"
tonic-web = "0.12.3"

Description

I'm working on upgrading some of my web services which use both gRPC (via tonic) and regular REST endpoints (via axum) and cannot find a way to implement the GrpcWebLayer without using the deprecated tonic::transport::server::Router::into_router() method because of mismatched body types.

Compiles:

let grpc = tonic::transport::Server::builder()
    .accept_http1(true)
    .layer(GrpcWebLayer::new())
    .add_service(NodeMapServer::new(NodeMapServerImpl::new(databases)))
    .into_router();

let service =
    tower::steer::Steer::new([rest, grpc], |req: &hyper::Request<_>, _services: &[_]| {
        if req
            .headers()
            .get(hyper::header::CONTENT_TYPE)
            .map(|content_type| content_type.as_bytes())
            .filter(|content_type| content_type.starts_with(b"application/grpc"))
            .is_some()
        {
            // route to the gRPC service (second service element) when the
            // header is set
            1
        } else {
            // otherwise route to the REST service
            0
        }
    });

let service = tower::ServiceBuilder::new()
    .layer(
        tower_http::cors::CorsLayer::new()
            .allow_origin(tower_http::cors::Any)
            .allow_headers(tower_http::cors::Any)
            .expose_headers(tower_http::cors::Any),
    )
    .service(service);

axum::serve(listener, tower::make::Shared::new(service))
    .with_graceful_shutdown(async move {
        let _ = shutdown_rx.changed().await;
    })
    .await?;

Does not compile:

let grpc = tonic::service::Routes::new(NodeMapServer::new(NodeMapServerImpl::new(databases)))
        .prepare()
        .into_axum_router();

let service =
    tower::steer::Steer::new([rest, grpc], |req: &hyper::Request<_>, _services: &[_]| {
        if req
            .headers()
            .get(hyper::header::CONTENT_TYPE)
            .map(|content_type| content_type.as_bytes())
            .filter(|content_type| content_type.starts_with(b"application/grpc"))
            .is_some()
        {
            // route to the gRPC service (second service element) when the
            // header is set
            1
        } else {
            // otherwise route to the REST service
            0
        }
    });

let service = tower::ServiceBuilder::new()
    .layer(
        tower_http::cors::CorsLayer::new()
            .allow_origin(tower_http::cors::Any)
            .allow_headers(tower_http::cors::Any)
            .expose_headers(tower_http::cors::Any),
    )
    // is this even the right place to do this?
    .layer(GrpcWebLayer::new())
    .service(service);

axum::serve(listener, tower::make::Shared::new(service))
    .with_graceful_shutdown(async move {
        let _ = shutdown_rx.changed().await;
    })
    .await?;
error[E0271]: type mismatch resolving `<Steer<Router, {closure@main.rs:197:48}, Request<UnsyncBoxBody<Bytes, Status>>> as Service<Request<UnsyncBoxBody<Bytes, Status>>>>::Response == Response<UnsyncBoxBody<Bytes, Status>>`
   --> src/main.rs:222:10
    |
222 |         .service(service);
    |          ^^^^^^^ expected `Response<Body>`, found `Response<UnsyncBoxBody<Bytes, Status>>`
    |
    = note: expected struct `hyper::Response<AxumBody>`
               found struct `hyper::Response<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>`
    = note: required for `GrpcWebLayer` to implement `tower::Layer<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>`
    = note: 1 redundant requirement hidden
    = note: required for `Stack<GrpcWebLayer, Stack<CorsLayer, tower::layer::util::Identity>>` to implement `tower::Layer<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>`

error[E0271]: type mismatch resolving `<Steer<Router, {closure@main.rs:197:48}, Request<UnsyncBoxBody<Bytes, Status>>> as Service<Request<UnsyncBoxBody<Bytes, Status>>>>::Response == Response<UnsyncBoxBody<Bytes, Status>>`
   --> src/main.rs:222:18
    |
222 |         .service(service);
    |          ------- ^^^^^^^ expected `Response<UnsyncBoxBody<Bytes, Status>>`, found `Response<Body>`
    |          |
    |          required by a bound introduced by this call
    |
    = note: expected struct `hyper::Response<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>`
               found struct `hyper::Response<AxumBody>`
    = note: required for `GrpcWebLayer` to implement `tower::Layer<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>`
    = note: 1 redundant requirement hidden
    = note: required for `Stack<GrpcWebLayer, Stack<CorsLayer, tower::layer::util::Identity>>` to implement `tower::Layer<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>`

error[E0277]: the trait bound `GrpcWebService<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>: tower::Service<hyper::Request<AxumBody>>` is not satisfied
   --> src/main.rs:241:5
    |
241 |     axum::serve(listener, tower::make::Shared::new(service))
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `tower::Service<hyper::Request<AxumBody>>` is not implemented for `GrpcWebService<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>`, which is required by `Cors<GrpcWebService<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>>: tower::Service<hyper::Request<AxumBody>>`
    |
    = help: the trait `tower::Service<hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>` is implemented for `GrpcWebService<S>`
    = note: required for `Cors<GrpcWebService<Steer<AxumRouter, {closure@src/main.rs:197:48: 197:90}, hyper::Request<http_body_util::combinators::box_body::UnsyncBoxBody<axum::body::Bytes, tonic::Status>>>>>` to implement `tower::Service<hyper::Request<AxumBody>>`

am I missing something obvious? I'd like to not use the deprecated method if possible, but it doesn't seem possible to do so otherwise. is there a workaround available at this point or do I need for tonic-web to be changed to be generic over the body type? (#1361)
@repnop
Copy link
Author

repnop commented Oct 2, 2024

okay so it looks like the following works, albeit a little awkward:

tonic::service::Routes::new(GrpcWebLayer::new().layer(NodeMapServer::new(NodeMapServerImpl::new(databases))))
    .prepare()
    .into_axum_router()
    // layering etc

in case anyone hits this issue as well. it would still be nice to use GrpcWebLayer in the same way its provided in examples with the intended usage, but this workaround seems to work for the time being. not sure if anyone would want me to rename or close this issue, since its basically a duplicate of #1361 more or less?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@repnop