feat(web): Implement tower::Layer for tonic_web::Config (#1119)

slinkydeveloper · web-flow · commit 40536dc13428 · 2022-10-28T13:59:01.000-04:00
Signed-off-by: slinkydeveloper &lt;francescoguard@gmail.com&gt;
diff --git a/tonic-web/Cargo.toml b/tonic-web/Cargo.toml
@@ -24,6 +24,7 @@ hyper = "0.14"
 pin-project = "1"
 tonic = {version = "0.8", path = "../tonic", default-features = false, features = ["transport"]}
 tower-service = "0.3"
+tower-layer = "0.3"
 tracing = "0.1"
 
 [dev-dependencies]
diff --git a/tonic-web/src/config.rs b/tonic-web/src/config.rs
@@ -4,7 +4,6 @@ use std::time::Duration;
 
 use http::{header::HeaderName, HeaderValue};
 use tonic::body::BoxBody;
-use tonic::transport::NamedService;
 use tower_service::Service;
 
 use crate::service::GrpcWeb;
@@ -152,11 +151,10 @@ impl Config {
     pub fn enable<S>(&self, service: S) -> GrpcWeb<S>
     where
         S: Service<http::Request<hyper::Body>, Response = http::Response<BoxBody>>,
-        S: NamedService + Clone + Send + 'static,
+        S: Clone + Send + 'static,
         S::Future: Send + 'static,
         S::Error: Into<BoxError> + Send,
     {
-        tracing::trace!("enabled for {}", S::NAME);
         GrpcWeb::new(service, self.clone())
     }
 }
diff --git a/tonic-web/src/layer.rs b/tonic-web/src/layer.rs
@@ -0,0 +1,31 @@
+use super::{BoxBody, BoxError, Config, GrpcWeb};
+
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Layer implementing the grpc-web protocol.
+#[derive(Debug, Clone)]
+pub struct GrpcWebLayer {
+    _priv: (),
+}
+
+impl GrpcWebLayer {
+    /// Create a new grpc-web layer.
+    pub fn new() -> GrpcWebLayer {
+        Self { _priv: () }
+    }
+}
+
+impl<S> Layer<S> for GrpcWebLayer
+where
+    S: Service<http::Request<hyper::Body>, Response = http::Response<BoxBody>>,
+    S: Clone + Send + 'static,
+    S::Future: Send + 'static,
+    S::Error: Into<BoxError> + Send,
+{
+    type Service = GrpcWeb<S>;
+
+    fn layer(&self, inner: S) -> Self::Service {
+        Config::default().enable(inner)
+    }
+}
diff --git a/tonic-web/src/lib.rs b/tonic-web/src/lib.rs
@@ -88,17 +88,18 @@
 #![doc(issue_tracker_base_url = "https://github.com/hyperium/tonic/issues/")]
 
 pub use config::Config;
+pub use layer::GrpcWebLayer;
+pub use service::GrpcWeb;
 
 mod call;
 mod config;
 mod cors;
+mod layer;
 mod service;
 
-use crate::service::GrpcWeb;
 use std::future::Future;
 use std::pin::Pin;
 use tonic::body::BoxBody;
-use tonic::transport::NamedService;
 use tower_service::Service;
 
 /// enable a tonic service to handle grpc-web requests with the default configuration.
@@ -107,7 +108,7 @@ use tower_service::Service;
 pub fn enable<S>(service: S) -> GrpcWeb<S>
 where
     S: Service<http::Request<hyper::Body>, Response = http::Response<BoxBody>>,
-    S: NamedService + Clone + Send + 'static,
+    S: Clone + Send + 'static,
     S::Future: Send + 'static,
     S::Error: Into<BoxError> + Send,
 {
diff --git a/tonic-web/src/service.rs b/tonic-web/src/service.rs
@@ -15,6 +15,7 @@ use crate::{BoxError, BoxFuture, Config};
 
 const GRPC: &str = "application/grpc";
 
+/// Service implementing the grpc-web protocol.
 #[derive(Debug, Clone)]
 pub struct GrpcWeb<S> {
     inner: S,
@@ -266,6 +267,7 @@ mod tests {
     mod grpc_web {
         use super::*;
         use http::HeaderValue;
+        use tower_layer::Layer;
 
         fn request() -> Request<Body> {
             Request::builder()
@@ -284,6 +286,14 @@ mod tests {
             assert_eq!(res.status(), StatusCode::OK);
         }
 
+        #[tokio::test]
+        async fn web_layer() {
+            let mut svc = crate::GrpcWebLayer::new().layer(Svc);
+            let res = svc.call(request()).await.unwrap();
+
+            assert_eq!(res.status(), StatusCode::OK);
+        }
+
         #[tokio::test]
         async fn without_origin() {
             let mut svc = crate::enable(Svc);

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ use std::time::Duration;`
`4`	`4`
`5`	`5`	`use http::{header::HeaderName, HeaderValue};`
`6`	`6`	`use tonic::body::BoxBody;`
`7`		`-use tonic::transport::NamedService;`
`8`	`7`	`use tower_service::Service;`
`9`	`8`
`10`	`9`	`use crate::service::GrpcWeb;`
`@@ -152,11 +151,10 @@ impl Config {`
`152`	`151`	`pub fn enable<S>(&self, service: S) -> GrpcWeb<S>`
`153`	`152`	`where`
`154`	`153`	`S: Service<http::Request<hyper::Body>, Response = http::Response<BoxBody>>,`
`155`		`- S: NamedService + Clone + Send + 'static,`
	`154`	`+ S: Clone + Send + 'static,`
`156`	`155`	`S::Future: Send + 'static,`
`157`	`156`	`S::Error: Into<BoxError> + Send,`
`158`	`157`	`{`
`159`		`- tracing::trace!("enabled for {}", S::NAME);`
`160`	`158`	`GrpcWeb::new(service, self.clone())`
`161`	`159`	`}`
`162`	`160`	`}`