feat(channel): Make channel feature additive

Author: tottoto

examples/Cargo.toml

@@ -298,13 +298,13 @@ hyper-warp-multiplex = ["hyper-warp"]
 uds = ["tokio-stream/net", "dep:tower", "dep:hyper"]
 streaming = ["tokio-stream", "dep:h2"]
 mock = ["tokio-stream", "dep:tower"]
-tower = ["dep:hyper", "dep:tower", "dep:http"]
+tower = ["dep:hyper", "tower/timeout", "dep:http"]
 json-codec = ["dep:serde", "dep:serde_json", "dep:bytes"]
 compression = ["tonic/gzip"]
 tls = ["tonic/tls"]
 tls-rustls = ["dep:hyper", "dep:hyper-rustls", "dep:tower", "tower-http/util", "tower-http/add-extension", "dep:rustls-pemfile", "dep:tokio-rustls"]
 dynamic-load-balance = ["dep:tower"]
-timeout = ["tokio/time", "dep:tower"]
+timeout = ["tokio/time", "tower/timeout"]
 tls-client-auth = ["tonic/tls"]
 types = ["dep:tonic-types"]
 h2c = ["dep:hyper", "dep:tower", "dep:http"]

tonic/Cargo.toml

@@ -26,23 +26,26 @@ version = "0.11.0"
 codegen = ["dep:async-trait"]
 gzip = ["dep:flate2"]
 zstd = ["dep:zstd"]
-default = ["transport", "codegen", "prost"]
+default = ["channel", "codegen", "prost"]
 prost = ["dep:prost"]
 tls = ["dep:rustls-pemfile", "transport", "dep:tokio-rustls", "dep:tokio", "tokio?/rt", "tokio?/macros"]
 tls-roots = ["tls-roots-common", "dep:rustls-native-certs"]
-tls-roots-common = ["tls"]
+tls-roots-common = ["tls", "channel"]
 tls-webpki-roots = ["tls-roots-common", "dep:webpki-roots"]
 transport = [
   "dep:async-stream",
   "dep:axum",
-  "channel",
   "dep:h2",
-  "dep:hyper",
+  "dep:hyper", "hyper?/server",
   "dep:tokio", "tokio?/net", "tokio?/time",
-  "dep:tower",
+  "dep:tower", "tower?/util", "tower?/limit",
+]
+channel = [
+  "transport",
+  "dep:hyper", "hyper?/client",
+  "dep:tower", "tower?/balance", "tower?/buffer", "tower?/discover", "tower?/load", "tower?/make",
   "dep:hyper-timeout",
 ]
-channel = []
 
 # [[bench]]
 # name = "bench_main"
@@ -69,13 +72,15 @@ async-trait = {version = "0.1.13", optional = true}
 # transport
 async-stream = {version = "0.3", optional = true}
 h2 = {version = "0.3.24", optional = true}
-hyper = {version = "0.14.26", features = ["full"], optional = true}
-hyper-timeout = {version = "0.4", optional = true}
+hyper = {version = "0.14.26", features = ["http1", "http2", "runtime", "stream"], optional = true}
 tokio = {version = "1.0.1", optional = true}
 tokio-stream = "0.1"
-tower = {version = "0.4.7", default-features = false, features = ["balance", "buffer", "discover", "limit", "load", "make", "timeout", "util"], optional = true}
+tower = {version = "0.4.7", default-features = false, optional = true}
 axum = {version = "0.6.9", default-features = false, optional = true}
 
+# channel
+hyper-timeout = {version = "0.4", optional = true}
+
 # rustls
 rustls-pemfile = { version = "2.0", optional = true }
 rustls-native-certs = { version = "0.7", optional = true }

tonic/src/transport/channel/endpoint.rs

@@ -1,15 +1,15 @@
-use super::super::service;
-use super::Channel;
-#[cfg(feature = "tls")]
-use super::ClientTlsConfig;
-#[cfg(feature = "tls")]
-use crate::transport::service::TlsConnector;
-use crate::transport::{service::SharedExec, Error, Executor};
+use std::{fmt, future::Future, pin::Pin, str::FromStr, time::Duration};
+
 use bytes::Bytes;
 use http::{uri::Uri, HeaderValue};
-use std::{fmt, future::Future, pin::Pin, str::FromStr, time::Duration};
 use tower::make::MakeConnection;
-// use crate::transport::E
+
+use crate::transport::Error;
+
+use super::service::{Connector, Executor, SharedExec};
+use super::Channel;
+#[cfg(feature = "tls")]
+use super::{service::TlsConnector, ClientTlsConfig};
 
 /// Channel builder.
 ///
@@ -318,15 +318,15 @@ impl Endpoint {
         self
     }
 
-    pub(crate) fn connector<C>(&self, c: C) -> service::Connector<C> {
+    pub(crate) fn connector<C>(&self, c: C) -> Connector<C> {
         #[cfg(all(feature = "tls", not(feature = "tls-roots-common")))]
-        let connector = service::Connector::new(c, self.tls.clone());
+        let connector = Connector::new(c, self.tls.clone());
 
         #[cfg(all(feature = "tls", feature = "tls-roots-common"))]
-        let connector = service::Connector::new(c, self.tls.clone(), self.tls_assume_http2);
+        let connector = Connector::new(c, self.tls.clone(), self.tls_assume_http2);
 
         #[cfg(not(feature = "tls"))]
-        let connector = service::Connector::new(c);
+        let connector = Connector::new(c);
 
         connector
     }

tonic/src/transport/channel/mod.rs

@@ -1,6 +1,7 @@
 //! Client implementation and builder.
 
 mod endpoint;
+pub(crate) mod service;
 #[cfg(feature = "tls")]
 #[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
 mod tls;
@@ -9,7 +10,7 @@ pub use endpoint::Endpoint;
 #[cfg(feature = "tls")]
 pub use tls::ClientTlsConfig;
 
-use super::service::{Connection, DynamicServiceStream, SharedExec};
+use self::service::{Connection, DynamicServiceStream, SharedExec};
 use crate::body::BoxBody;
 use crate::transport::Executor;
 use bytes::Bytes;

tonic/src/transport/service/add_origin.rs renamed to tonic/src/transport/channel/service/add_origin.rs

@@ -1,4 +1,5 @@
-use super::{grpc_timeout::GrpcTimeout, reconnect::Reconnect, AddOrigin, UserAgent};
+use super::{reconnect::Reconnect, AddOrigin, UserAgent};
+use crate::transport::service::GrpcTimeout;
 use crate::{
     body::BoxBody,
     transport::{BoxFuture, Endpoint},

tonic/src/transport/service/connection.rs renamed to tonic/src/transport/channel/service/connection.rs

@@ -1,14 +1,15 @@
-use super::super::BoxFuture;
-use super::io::BoxedIo;
-#[cfg(feature = "tls")]
-use super::tls::TlsConnector;
 use http::Uri;
 #[cfg(feature = "tls")]
 use std::fmt;
 use std::task::{Context, Poll};
 use tower::make::MakeConnection;
 use tower_service::Service;
 
+use super::io::BoxedIo;
+#[cfg(feature = "tls")]
+use super::tls::TlsConnector;
+use crate::transport::BoxFuture;
+
 pub(crate) struct Connector<C> {
     inner: C,
     #[cfg(feature = "tls")]

tonic/src/transport/service/connector.rs renamed to tonic/src/transport/channel/service/connector.rs

@@ -0,0 +1,64 @@
+use std::io::{self, IoSlice};
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+use hyper::client::connect::{Connected as HyperConnected, Connection};
+use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
+
+pub(super) trait Io: AsyncRead + AsyncWrite + Send + 'static {}
+
+impl<T> Io for T where T: AsyncRead + AsyncWrite + Send + 'static {}
+
+pub(crate) struct BoxedIo(Pin<Box<dyn Io>>);
+
+impl BoxedIo {
+    pub(super) fn new<I: Io>(io: I) -> Self {
+        BoxedIo(Box::pin(io))
+    }
+}
+
+impl Connection for BoxedIo {
+    fn connected(&self) -> HyperConnected {
+        HyperConnected::new()
+    }
+}
+
+impl AsyncRead for BoxedIo {
+    fn poll_read(
+        mut self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+        buf: &mut ReadBuf<'_>,
+    ) -> Poll<io::Result<()>> {
+        Pin::new(&mut self.0).poll_read(cx, buf)
+    }
+}
+
+impl AsyncWrite for BoxedIo {
+    fn poll_write(
+        mut self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+        buf: &[u8],
+    ) -> Poll<io::Result<usize>> {
+        Pin::new(&mut self.0).poll_write(cx, buf)
+    }
+
+    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
+        Pin::new(&mut self.0).poll_flush(cx)
+    }
+
+    fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
+        Pin::new(&mut self.0).poll_shutdown(cx)
+    }
+
+    fn poll_write_vectored(
+        mut self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+        bufs: &[IoSlice<'_>],
+    ) -> Poll<Result<usize, io::Error>> {
+        Pin::new(&mut self.0).poll_write_vectored(cx, bufs)
+    }
+
+    fn is_write_vectored(&self) -> bool {
+        self.0.is_write_vectored()
+    }
+}

tonic/src/transport/service/discover.rs renamed to tonic/src/transport/channel/service/discover.rs

@@ -0,0 +1,26 @@
+mod add_origin;
+pub(crate) use self::add_origin::AddOrigin;
+
+mod connector;
+pub(crate) use self::connector::Connector;
+
+mod connection;
+pub(crate) use self::connection::Connection;
+
+mod discover;
+pub(crate) use self::discover::DynamicServiceStream;
+
+pub(crate) mod executor;
+pub(crate) use self::executor::{Executor, SharedExec};
+
+pub(crate) mod io;
+
+mod reconnect;
+
+mod user_agent;
+pub(crate) use self::user_agent::UserAgent;
+
+#[cfg(feature = "tls")]
+mod tls;
+#[cfg(feature = "tls")]
+pub(crate) use self::tls::TlsConnector;

tonic/src/transport/service/executor.rs renamed to tonic/src/transport/channel/service/executor.rs

@@ -0,0 +1,100 @@
+use std::fmt;
+use std::io::Cursor;
+use std::sync::Arc;
+
+use tokio::io::{AsyncRead, AsyncWrite};
+use tokio_rustls::{
+    rustls::{pki_types::ServerName, ClientConfig, RootCertStore},
+    TlsConnector as RustlsConnector,
+};
+
+use super::io::BoxedIo;
+use crate::transport::service::tls::{add_certs_from_pem, load_identity, ALPN_H2};
+use crate::transport::tls::{Certificate, Identity};
+
+#[derive(Debug)]
+enum TlsError {
+    H2NotNegotiated,
+}
+
+impl fmt::Display for TlsError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            TlsError::H2NotNegotiated => write!(f, "HTTP/2 was not negotiated."),
+        }
+    }
+}
+
+impl std::error::Error for TlsError {}
+
+#[derive(Clone)]
+pub(crate) struct TlsConnector {
+    config: Arc<ClientConfig>,
+    domain: Arc<ServerName<'static>>,
+    assume_http2: bool,
+}
+
+impl TlsConnector {
+    pub(crate) fn new(
+        ca_cert: Option<Certificate>,
+        identity: Option<Identity>,
+        domain: &str,
+        assume_http2: bool,
+    ) -> Result<Self, crate::Error> {
+        let builder = ClientConfig::builder();
+        let mut roots = RootCertStore::empty();
+
+        #[cfg(feature = "tls-roots")]
+        roots.add_parsable_certificates(rustls_native_certs::load_native_certs()?);
+
+        #[cfg(feature = "tls-webpki-roots")]
+        roots.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());
+
+        if let Some(cert) = ca_cert {
+            add_certs_from_pem(&mut Cursor::new(cert), &mut roots)?;
+        }
+
+        let builder = builder.with_root_certificates(roots);
+        let mut config = match identity {
+            Some(identity) => {
+                let (client_cert, client_key) = load_identity(identity)?;
+                builder.with_client_auth_cert(client_cert, client_key)?
+            }
+            None => builder.with_no_client_auth(),
+        };
+
+        config.alpn_protocols.push(ALPN_H2.into());
+        Ok(Self {
+            config: Arc::new(config),
+            domain: Arc::new(ServerName::try_from(domain)?.to_owned()),
+            assume_http2,
+        })
+    }
+
+    pub(crate) async fn connect<I>(&self, io: I) -> Result<BoxedIo, crate::Error>
+    where
+        I: AsyncRead + AsyncWrite + Send + Unpin + 'static,
+    {
+        let io = RustlsConnector::from(self.config.clone())
+            .connect(self.domain.as_ref().to_owned(), io)
+            .await?;
+
+        // Generally we require ALPN to be negotiated, but if the user has
+        // explicitly set `assume_http2` to true, we'll allow it to be missing.
+        let (_, session) = io.get_ref();
+        let alpn_protocol = session.alpn_protocol();
+        if alpn_protocol != Some(ALPN_H2) {
+            if alpn_protocol.is_some() || !self.assume_http2 {
+                return Err(TlsError::H2NotNegotiated.into());
+            }
+        }
+
+        Ok(BoxedIo::new(io))
+    }
+}
+
+impl fmt::Debug for TlsConnector {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.debug_struct("TlsConnector").finish()
+    }
+}

tonic/src/transport/channel/service/io.rs

@@ -1,5 +1,5 @@
+use super::service::TlsConnector;
 use crate::transport::{
-    service::TlsConnector,
     tls::{Certificate, Identity},
     Error,
 };

tonic/src/transport/channel/service/mod.rs

@@ -15,7 +15,9 @@ struct ErrorImpl {
 #[derive(Debug)]
 pub(crate) enum Kind {
     Transport,
+    #[cfg(feature = "channel")]
     InvalidUri,
+    #[cfg(feature = "channel")]
     InvalidUserAgent,
 }
 
@@ -35,18 +37,22 @@ impl Error {
         Error::new(Kind::Transport).with(source)
     }
 
+    #[cfg(feature = "channel")]
     pub(crate) fn new_invalid_uri() -> Self {
         Error::new(Kind::InvalidUri)
     }
 
+    #[cfg(feature = "channel")]
     pub(crate) fn new_invalid_user_agent() -> Self {
         Error::new(Kind::InvalidUserAgent)
     }
 
     fn description(&self) -> &str {
         match &self.inner.kind {
             Kind::Transport => "transport error",
+            #[cfg(feature = "channel")]
             Kind::InvalidUri => "invalid URI",
+            #[cfg(feature = "channel")]
             Kind::InvalidUserAgent => "user agent is not a valid header value",
         }
     }