fix(build): Allow creating multiple services in the same package (#173)

BREAKING CHANGE: Build will now generate each service client and server into their own modules.

Author: LucioFranco

tests/included_service/src/lib.rs

@@ -5,4 +5,4 @@ pub mod pb {
 // Ensure that an RPC service, defined before including a file that defines
 // another service in a different protocol buffer package, is not incorrectly
 // cleared from the context of its package.
-type _Test = dyn pb::server::TopService;
+type _Test = dyn pb::topservice_server::TopService;

tonic-build/src/client.rs

@@ -5,44 +5,50 @@ use quote::{format_ident, quote};
 
 pub(crate) fn generate(service: &Service, proto: &str) -> TokenStream {
     let service_ident = quote::format_ident!("{}Client", service.name);
+    let client_mod = quote::format_ident!("{}_client", service.name.to_ascii_lowercase());
     let methods = generate_methods(service, proto);
 
     let connect = generate_connect(&service_ident);
     let service_doc = generate_doc_comments(&service.comments.leading);
 
     quote! {
-        #service_doc
-        pub struct #service_ident<T> {
-            inner: tonic::client::Grpc<T>,
-        }
-
-        #connect
-
-        impl<T> #service_ident<T>
-        where T: tonic::client::GrpcService<tonic::body::BoxBody>,
-              T::ResponseBody: Body + HttpBody + Send + 'static,
-              T::Error: Into<StdError>,
-              <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send,
-        {
-            pub fn new(inner: T) -> Self {
-                let inner = tonic::client::Grpc::new(inner);
-                Self { inner }
+        /// Generated server implementations.
+        pub mod #client_mod {
+            #![allow(unused_variables, dead_code, missing_docs)]
+            use tonic::codegen::*;
+
+            #service_doc
+            pub struct #service_ident<T> {
+                inner: tonic::client::Grpc<T>,
             }
 
-            /// Check if the service is ready.
-            pub async fn ready(&mut self) -> Result<(), tonic::Status> {
-                self.inner.ready().await.map_err(|e| {
-                    tonic::Status::new(tonic::Code::Unknown, format!("Service was not ready: {}", e.into()))
-                })
-            }
+            #connect
 
-            #methods
-        }
+            impl<T> #service_ident<T>
+            where T: tonic::client::GrpcService<tonic::body::BoxBody>,
+                  T::ResponseBody: Body + HttpBody + Send + 'static,
+                  T::Error: Into<StdError>,
+                  <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, {
+                pub fn new(inner: T) -> Self {
+                    let inner = tonic::client::Grpc::new(inner);
+                    Self { inner }
+                }
+
+                /// Check if the service is ready.
+                pub async fn ready(&mut self) -> Result<(), tonic::Status> {
+                    self.inner.ready().await.map_err(|e| {
+                        tonic::Status::new(tonic::Code::Unknown, format!("Service was not ready: {}", e.into()))
+                    })
+                }
+
+                #methods
+            }
 
-        impl<T: Clone> Clone for #service_ident<T> {
-            fn clone(&self) -> Self {
-                Self {
-                    inner: self.inner.clone(),
+            impl<T: Clone> Clone for #service_ident<T> {
+                fn clone(&self) -> Self {
+                    Self {
+                        inner: self.inner.clone(),
+                    }
                 }
             }
         }

tonic-build/src/lib.rs

@@ -251,13 +251,7 @@ impl prost_build::ServiceGenerator for ServiceGenerator {
             let clients = &self.clients;
 
             let client_service = quote::quote! {
-                /// Generated client implementations.
-                pub mod client {
-                    #![allow(unused_variables, dead_code, missing_docs)]
-                    use tonic::codegen::*;
-
-                    #clients
-                }
+                #clients
             };
 
             let code = format!("{}", client_service);
@@ -270,13 +264,7 @@ impl prost_build::ServiceGenerator for ServiceGenerator {
             let servers = &self.servers;
 
             let server_service = quote::quote! {
-                /// Generated server implementations.
-                pub mod server {
-                    #![allow(unused_variables, dead_code, missing_docs)]
-                    use tonic::codegen::*;
-
-                    #servers
-                }
+                #servers
             };
 
             let code = format!("{}", server_service);

tonic-build/src/server.rs

@@ -9,6 +9,7 @@ pub(crate) fn generate(service: &Service, proto_path: &str) -> TokenStream {
 
     let server_service = quote::format_ident!("{}Server", service.name);
     let server_trait = quote::format_ident!("{}", service.name);
+    let server_mod = quote::format_ident!("{}_server", service.name.to_ascii_lowercase());
     let generated_trait = generate_trait(service, proto_path, server_trait.clone());
     let service_doc = generate_doc_comments(&service.comments.leading);
 
@@ -17,56 +18,62 @@ pub(crate) fn generate(service: &Service, proto_path: &str) -> TokenStream {
     let transport = generate_transport(&server_service, &server_trait, &path);
 
     quote! {
-        #generated_trait
-
-        #service_doc
-        #[derive(Debug)]
-        #[doc(hidden)]
-        pub struct #server_service<T: #server_trait> {
-            inner: Arc<T>,
-        }
+        /// Generated server implementations.
+        pub mod #server_mod {
+            #![allow(unused_variables, dead_code, missing_docs)]
+            use tonic::codegen::*;
+
+            #generated_trait
+
+            #service_doc
+            #[derive(Debug)]
+            #[doc(hidden)]
+            pub struct #server_service<T: #server_trait> {
+                inner: Arc<T>,
+            }
 
-        impl<T: #server_trait> #server_service<T> {
-            pub fn new(inner: T) -> Self {
-                let inner = Arc::new(inner);
-                Self { inner }
+            impl<T: #server_trait> #server_service<T> {
+                pub fn new(inner: T) -> Self {
+                    let inner = Arc::new(inner);
+                    Self { inner }
+                }
             }
-        }
 
-        impl<T: #server_trait> Service<http::Request<HyperBody>> for #server_service<T> {
-            type Response = http::Response<tonic::body::BoxBody>;
-            type Error = Never;
-            type Future = BoxFuture<Self::Response, Self::Error>;
+            impl<T: #server_trait> Service<http::Request<HyperBody>> for #server_service<T> {
+                type Response = http::Response<tonic::body::BoxBody>;
+                type Error = Never;
+                type Future = BoxFuture<Self::Response, Self::Error>;
 
-            fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
-                Poll::Ready(Ok(()))
-            }
+                fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+                    Poll::Ready(Ok(()))
+                }
 
-            fn call(&mut self, req: http::Request<HyperBody>) -> Self::Future {
-                let inner = self.inner.clone();
+                fn call(&mut self, req: http::Request<HyperBody>) -> Self::Future {
+                    let inner = self.inner.clone();
 
-                match req.uri().path() {
-                    #methods
+                    match req.uri().path() {
+                        #methods
 
-                    _ => Box::pin(async move {
-                         Ok(http::Response::builder()
-                            .status(200)
-                            .header("grpc-status", "12")
-                            .body(tonic::body::BoxBody::empty())
-                            .unwrap())
-                    }),
+                        _ => Box::pin(async move {
+                            Ok(http::Response::builder()
+                               .status(200)
+                               .header("grpc-status", "12")
+                               .body(tonic::body::BoxBody::empty())
+                               .unwrap())
+                        }),
+                    }
                 }
             }
-        }
 
-        impl<T: #server_trait> Clone for #server_service<T> {
-            fn clone(&self) -> Self {
-                let inner = self.inner.clone();
-                Self { inner }
+            impl<T: #server_trait> Clone for #server_service<T> {
+                fn clone(&self) -> Self {
+                    let inner = self.inner.clone();
+                    Self { inner }
+                }
             }
-        }
 
-        #transport
+            #transport
+        }
     }
 }
 

tonic-examples/src/authentication/client.rs

@@ -3,7 +3,7 @@ pub mod pb {
 }
 
 use http::header::HeaderValue;
-use pb::{client::EchoClient, EchoRequest};
+use pb::{echo_client::EchoClient, EchoRequest};
 use tonic::transport::Channel;
 
 #[tokio::main]

tonic-examples/src/authentication/server.rs

@@ -15,7 +15,7 @@ type ResponseStream = Pin<Box<dyn Stream<Item = Result<EchoResponse, Status>> +
 pub struct EchoServer;
 
 #[tonic::async_trait]
-impl pb::server::Echo for EchoServer {
+impl pb::echo_server::Echo for EchoServer {
     async fn unary_echo(&self, request: Request<EchoRequest>) -> EchoResult<EchoResponse> {
         let message = request.into_inner().message;
         Ok(Response::new(EchoResponse { message }))
@@ -79,7 +79,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
                 }
             }
         })
-        .add_service(pb::server::EchoServer::new(server))
+        .add_service(pb::echo_server::EchoServer::new(server))
         .serve(addr)
         .await?;
 

tonic-examples/src/gcp/client.rs

@@ -2,7 +2,7 @@ pub mod api {
     tonic::include_proto!("google.pubsub.v1");
 }
 
-use api::{client::PublisherClient, ListTopicsRequest};
+use api::{publisher_client::PublisherClient, ListTopicsRequest};
 use http::header::HeaderValue;
 use tonic::{
     transport::{Certificate, Channel, ClientTlsConfig},

tonic-examples/src/helloworld/client.rs

@@ -2,7 +2,7 @@ pub mod hello_world {
     tonic::include_proto!("helloworld");
 }
 
-use hello_world::{client::GreeterClient, HelloRequest};
+use hello_world::{greeter_client::GreeterClient, HelloRequest};
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {

tonic-examples/src/helloworld/server.rs

@@ -5,7 +5,7 @@ pub mod hello_world {
 }
 
 use hello_world::{
-    server::{Greeter, GreeterServer},
+    greeter_server::{Greeter, GreeterServer},
     HelloReply, HelloRequest,
 };
 

tonic-examples/src/load_balance/client.rs

@@ -2,7 +2,7 @@ pub mod pb {
     tonic::include_proto!("grpc.examples.echo");
 }
 
-use pb::{client::EchoClient, EchoRequest};
+use pb::{echo_client::EchoClient, EchoRequest};
 use tonic::transport::Channel;
 
 #[tokio::main]