Skip to content

Commit 4e1fcec

Browse files
authored
fix(codegen): Use wellknown types from prost-types (#49)
This change introduces the ability to let prost-build provide the fully qualifed type path for types that start with `google.protobuf`.
1 parent ed3e7e9 commit 4e1fcec

6 files changed

Lines changed: 42 additions & 36 deletions

File tree

tonic-build/src/client.rs

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,7 @@ fn generate_methods(service: &Service, proto: &str) -> TokenStream {
9696

9797
fn generate_unary(method: &Method, proto: &str, path: String) -> TokenStream {
9898
let ident = format_ident!("{}", method.name);
99-
let request = crate::replace_wellknown(proto, &method.input_type);
100-
let response = crate::replace_wellknown(proto, &method.output_type);
99+
let (request, response) = crate::replace_wellknown(proto, &method);
101100

102101
quote! {
103102
pub async fn #ident(&mut self, request: tonic::Request<#request>)
@@ -113,8 +112,7 @@ fn generate_unary(method: &Method, proto: &str, path: String) -> TokenStream {
113112
fn generate_server_streaming(method: &Method, proto: &str, path: String) -> TokenStream {
114113
let ident = format_ident!("{}", method.name);
115114

116-
let request = crate::replace_wellknown(proto, &method.input_type);
117-
let response = crate::replace_wellknown(proto, &method.output_type);
115+
let (request, response) = crate::replace_wellknown(proto, &method);
118116

119117
quote! {
120118
pub async fn #ident(&mut self, request: tonic::Request<#request>)
@@ -130,8 +128,7 @@ fn generate_server_streaming(method: &Method, proto: &str, path: String) -> Toke
130128
fn generate_client_streaming(method: &Method, proto: &str, path: String) -> TokenStream {
131129
let ident = format_ident!("{}", method.name);
132130

133-
let request = crate::replace_wellknown(proto, &method.input_type);
134-
let response = crate::replace_wellknown(proto, &method.output_type);
131+
let (request, response) = crate::replace_wellknown(proto, &method);
135132

136133
quote! {
137134
pub async fn #ident<S>(&mut self, request: tonic::Request<S>)
@@ -149,8 +146,7 @@ fn generate_client_streaming(method: &Method, proto: &str, path: String) -> Toke
149146
fn generate_streaming(method: &Method, proto: &str, path: String) -> TokenStream {
150147
let ident = format_ident!("{}", method.name);
151148

152-
let request = crate::replace_wellknown(proto, &method.input_type);
153-
let response = crate::replace_wellknown(proto, &method.output_type);
149+
let (request, response) = crate::replace_wellknown(proto, &method);
154150

155151
quote! {
156152
pub async fn #ident<S>(&mut self, request: tonic::Request<S>)

tonic-build/src/lib.rs

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
5959

6060
use proc_macro2::{Delimiter, Group, Ident, Literal, Punct, Spacing, Span, TokenStream};
61-
use prost_build::Config;
61+
use prost_build::{Config, Method};
6262
use quote::{ToTokens, TokenStreamExt};
6363

6464
#[cfg(feature = "rustfmt")]
@@ -281,13 +281,22 @@ fn generate_doc_comments<T: AsRef<str>>(comments: &[T]) -> TokenStream {
281281
stream
282282
}
283283

284-
fn replace_wellknown(proto_path: &str, output: &str) -> TokenStream {
285-
// TODO: detect more wellknown protobuf types
286-
// https://github.com/danburkert/prost/blob/master/prost-types/src/protobuf.rs
287-
match output {
288-
"()" => quote::quote! { () },
289-
_ => syn::parse_str::<syn::Path>(&format!("{}::{}", proto_path, output))
284+
fn replace_wellknown(proto_path: &str, method: &Method) -> (TokenStream, TokenStream) {
285+
let request = if method.input_proto_type.starts_with(".google.protobuf") {
286+
method.input_type.parse::<TokenStream>().unwrap()
287+
} else {
288+
syn::parse_str::<syn::Path>(&format!("{}::{}", proto_path, method.input_type))
290289
.unwrap()
291-
.to_token_stream(),
292-
}
290+
.to_token_stream()
291+
};
292+
293+
let response = if method.output_proto_type.starts_with(".google.protobuf") {
294+
method.input_type.parse::<TokenStream>().unwrap()
295+
} else {
296+
syn::parse_str::<syn::Path>(&format!("{}::{}", proto_path, method.output_type))
297+
.unwrap()
298+
.to_token_stream()
299+
};
300+
301+
(request, response)
293302
}

tonic-build/src/server.rs

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,7 @@ fn generate_trait_methods(service: &Service, proto_path: &str) -> TokenStream {
114114
for method in &service.methods {
115115
let name = quote::format_ident!("{}", method.name);
116116

117-
let req_message = crate::replace_wellknown(proto_path, &method.input_type);
118-
let res_message = crate::replace_wellknown(proto_path, &method.output_type);
117+
let (req_message, res_message) = crate::replace_wellknown(proto_path, &method);
119118

120119
let method_doc = generate_doc_comments(&method.comments.leading);
121120

@@ -226,8 +225,7 @@ fn generate_unary(
226225
) -> TokenStream {
227226
let service_ident = Ident::new(&method.proto_name, Span::call_site());
228227

229-
let request = crate::replace_wellknown(proto_path, &method.input_type);
230-
let response = crate::replace_wellknown(proto_path, &method.output_type);
228+
let (request, response) = crate::replace_wellknown(proto_path, &method);
231229

232230
quote! {
233231
struct #service_ident<T: #server_trait >(pub Arc<T>);
@@ -266,8 +264,7 @@ fn generate_server_streaming(
266264
) -> TokenStream {
267265
let service_ident = Ident::new(&method.proto_name, Span::call_site());
268266

269-
let request = crate::replace_wellknown(proto_path, &method.input_type);
270-
let response = crate::replace_wellknown(proto_path, &method.output_type);
267+
let (request, response) = crate::replace_wellknown(proto_path, &method);
271268

272269
let response_stream = quote::format_ident!("{}Stream", method.proto_name);
273270

@@ -310,8 +307,7 @@ fn generate_client_streaming(
310307
) -> TokenStream {
311308
let service_ident = Ident::new(&method.proto_name, Span::call_site());
312309

313-
let request = crate::replace_wellknown(proto_path, &method.input_type);
314-
let response = crate::replace_wellknown(proto_path, &method.output_type);
310+
let (request, response) = crate::replace_wellknown(proto_path, &method);
315311

316312
quote! {
317313
struct #service_ident<T: #server_trait >(pub Arc<T>);
@@ -352,8 +348,7 @@ fn generate_streaming(
352348
) -> TokenStream {
353349
let service_ident = Ident::new(&method.proto_name, Span::call_site());
354350

355-
let request = crate::replace_wellknown(proto_path, &method.input_type);
356-
let response = crate::replace_wellknown(proto_path, &method.output_type);
351+
let (request, response) = crate::replace_wellknown(proto_path, &method);
357352

358353
let response_stream = quote::format_ident!("{}Stream", method.proto_name);
359354

tonic-build/tests/protos/empty.proto

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
syntax = "proto3";
2+
3+
package wellknown;
4+
5+
import "google/protobuf/empty.proto";
6+
import "google/protobuf/wrappers.proto";
7+
import "google/protobuf/any.proto";
8+
9+
service Admin {
10+
rpc EmptyCall(google.protobuf.Empty) returns (google.protobuf.Empty);
11+
rpc StringCall(google.protobuf.StringValue) returns (google.protobuf.Empty);
12+
rpc AnyCall(google.protobuf.Any) returns (google.protobuf.Empty);
13+
}
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#[test]
2-
fn empty() {
2+
fn wellknown() {
33
let tmp = std::env::temp_dir();
44
tonic_build::configure()
55
.out_dir(tmp)
66
.format(false)
7-
.compile(&["tests/protos/empty.proto"], &["tests/protos"])
7+
.compile(&["tests/protos/wellknown.proto"], &["tests/protos"])
88
.unwrap();
99
}

0 commit comments

Comments
 (0)