.github/workflows/CI.yml

@@ -29,7 +29,7 @@ jobs:
     - name: Install Protoc
       uses: arduino/setup-protoc@v1
       with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }} 
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
     - uses: Swatinem/rust-cache@v1
     - name: Check fmt
       run: cargo fmt -- --check
@@ -66,7 +66,7 @@ jobs:
     - name: Install Protoc
       uses: arduino/setup-protoc@v1
       with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }} 
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
     - uses: Swatinem/rust-cache@v1
     - uses: actions/checkout@master
     - name: Run tests
@@ -93,7 +93,7 @@ jobs:
     - name: Install Protoc
       uses: arduino/setup-protoc@v1
       with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }} 
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
     - uses: Swatinem/rust-cache@v1
     - name: Run interop tests
       run: ./interop/test.sh

CHANGELOG.md

@@ -1,3 +1,29 @@
+# [v0.8.3](https://github.com/hyperium/tonic/compare/v0.8.2...v0.8.3) (2022-11-28)
+
+Included in this release is also the sub-crate major version bumps:
+
+* `tonic-health` has been bumped to `0.8.0` 
+* `tonic-reflection` has been bumped to `0.6.0`
+* `tonic-web` has been bumped to `0.5.0`
+
+
+### Bug Fixes
+
+* do not panic while encoding oversized bodies ([#1142](https://github.com/hyperium/tonic/issues/1142)) ([33e22bb](https://github.com/hyperium/tonic/commit/33e22bbc5ef1b74de82394c3ebfea27382419620)), closes [#1141](https://github.com/hyperium/tonic/issues/1141)
+* **reflection, health:** Remove transport feature ([#1112](https://github.com/hyperium/tonic/issues/1112)) ([7153289](https://github.com/hyperium/tonic/commit/7153289b51f7770cdd00cefeceddacc4cf36df97))
+
+
+### Features
+
+* **build:** Add `build_transport` builder option ([#1130](https://github.com/hyperium/tonic/issues/1130)) ([1f5bc9b](https://github.com/hyperium/tonic/commit/1f5bc9b9d55f814d1cb83de6f43239e275122265))
+* **build:** Add `CodeGenBuilder` ([#1154](https://github.com/hyperium/tonic/issues/1154)) ([c4525ba](https://github.com/hyperium/tonic/commit/c4525ba6ad21cf9db8d1857931f430cbe924aeb5))
+* **build:** Add disable_comments option ([#1127](https://github.com/hyperium/tonic/issues/1127)) ([e188521](https://github.com/hyperium/tonic/commit/e1885211495e63d962bc1d00f9be6eeaab2bb901))
+* Expose `Request#into_parts` and `Request#from_parts` ([#1118](https://github.com/hyperium/tonic/issues/1118)) ([b409ddd](https://github.com/hyperium/tonic/commit/b409ddd478959e239aeef3cb8715cd3ace470a8f))
+* **transport:** add `from_listener` for `TcpIncoming` ([#1093](https://github.com/hyperium/tonic/issues/1093)) ([0b03b30](https://github.com/hyperium/tonic/commit/0b03b30cccc67d517b05587614405d63d942b1bb))
+* **web:** Implement tower::Layer for tonic_web::Config ([#1119](https://github.com/hyperium/tonic/issues/1119)) ([40536dc](https://github.com/hyperium/tonic/commit/40536dc13428f6338610d74f7b45a5f9c87d9335))
+* **web:** Removed Cors impl and replaced with tower-http's CorsLayer ([#1123](https://github.com/hyperium/tonic/issues/1123)) ([a98d719](https://github.com/hyperium/tonic/commit/a98d719fb4b0a88127504a1ab3eb472e842c6b71)), closes [#1122](https://github.com/hyperium/tonic/issues/1122)
+
+
 # [0.8.2](https://github.com/hyperium/tonic/compare/v0.8.1...v0.8.2) (2022-09-28)
 
 

Cargo.toml

@@ -8,6 +8,7 @@ members = [
   "tonic-web", # Non-published crates
   "examples",
   "interop", # Tests
+  "tests/disable_comments",
   "tests/included_service",
   "tests/same_name",
   "tests/service_named_service",

README.md

@@ -36,7 +36,7 @@ contains the tools to build clients and servers from [`protobuf`] definitions.
 Examples can be found in [`examples`] and for more complex scenarios [`interop`]
 may be a good resource as it shows examples of many of the gRPC features.
 
-If you're using [rust-analyzer] we recommend you set `"rust-analyzer.cargo.runBuildScripts": true` to correctly load
+If you're using [rust-analyzer] we recommend you set `"rust-analyzer.cargo.buildScripts.enable": true` to correctly load
 the generated code.
 
 For IntelliJ IDEA users, please refer to [this](https://github.com/intellij-rust/intellij-rust/pull/8056) and enable
@@ -77,6 +77,12 @@ Assuming [Homebrew](https://brew.sh/) is already installed. (If not, see instruc
 brew install protobuf
 ```
 
+#### Windows
+
+- Download the latest version of `protoc-xx.y-win64.zip` from [HERE](https://github.com/protocolbuffers/protobuf/releases/latest)
+- Extract the file `bin\protoc.exe` and put it somewhere in the `PATH`
+- Verify installation by opening a command prompt and enter `protoc --version`
+
 ### Tutorials
 
 - The [`helloworld`][helloworld-tutorial] tutorial provides a basic example of using `tonic`, perfect for first time users!

SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+tonic (and related projects in hyperium) uses the same security policy as the [Tokio project][tokio-security].
+
+## Report a security issue
+
+The process for reporting an issue is the same as the [Tokio project][tokio-security]. This includes private reporting via security@tokio.rs.
+
+[tokio-security]: https://github.com/tokio-rs/tokio/security/policy

examples/routeguide-tutorial.md

@@ -825,7 +825,7 @@ fn main() {
 }
 ```
 
-On `cargo run`, this will generate code for the client only, and place the resulting file in
+On `cargo run`, this will generate code for the server only, and place the resulting file in
 `another_crate/src/pb`.
 
 2) Similarly, we could also keep the `.proto` definitions in a separate crate and then use that

examples/src/grpc-web/server.rs

@@ -2,6 +2,7 @@ use tonic::{transport::Server, Request, Response, Status};
 
 use hello_world::greeter_server::{Greeter, GreeterServer};
 use hello_world::{HelloReply, HelloRequest};
+use tonic_web::GrpcWebLayer;
 
 pub mod hello_world {
     tonic::include_proto!("helloworld");
@@ -33,14 +34,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 
     let greeter = MyGreeter::default();
     let greeter = GreeterServer::new(greeter);
-    let greeter = tonic_web::config()
-        .allow_origins(vec!["127.0.0.1"])
-        .enable(greeter);
 
     println!("GreeterServer listening on {}", addr);
 
     Server::builder()
         .accept_http1(true)
+        .layer(GrpcWebLayer::new())
         .add_service(greeter)
         .serve(addr)
         .await?;

interop/Cargo.toml

@@ -17,7 +17,7 @@ path = "src/bin/server.rs"
 [dependencies]
 async-stream = "0.3"
 bytes = "1.0"
-clap = {version = "3.2.1", features = ["derive"]}
+clap = {version = "4.0.26", features = ["derive"]}
 console = "0.14"
 futures-core = "0.3"
 futures-util = "0.3"

interop/src/bin/client.rs

@@ -9,11 +9,11 @@ struct Opts {
     #[clap(name = "use_tls", long, action = ArgAction::SetTrue)]
     use_tls: bool,
 
-    #[clap(
+    #[arg(
         long = "test_case",
         use_value_delimiter = true,
-        min_values = 1,
-        arg_enum,
+        num_args(1..),
+        value_enum,
         action = ArgAction::Append
     )]
     test_case: Vec<Testcase>,
@@ -99,7 +99,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
-#[derive(Debug, Copy, Clone, clap::ArgEnum)]
+#[derive(Debug, Copy, Clone, clap::ValueEnum)]
 #[clap(rename_all = "snake_case")]
 enum Testcase {
     EmptyUnary,

tests/disable_comments/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+authors = ["bouzuya <m@bouzuya.net>"]
+edition = "2018"
+license = "MIT"
+name = "disable-comments"
+publish = false
+version = "0.1.0"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+prost = "0.11"
+tonic = { path = "../../tonic" }
+
+[build-dependencies]
+prost-build = "0.11"
+tonic-build = { path = "../../tonic-build" }

tests/disable_comments/build.rs

@@ -0,0 +1,11 @@
+fn main() {
+    let mut config = prost_build::Config::default();
+    config.disable_comments(&["test.Input1", "test.Output1"]);
+    tonic_build::configure()
+        .disable_comments("test.Service1")
+        .disable_comments("test.Service1.Rpc1")
+        .build_client(true)
+        .build_server(true)
+        .compile_with_config(config, &["proto/test.proto"], &["proto"])
+        .unwrap();
+}

tests/disable_comments/proto/test.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+
+package test;
+
+// This comment will be removed.
+service Service1 {
+  // This comment will be removed.
+  rpc Rpc1(Input1) returns (Output1);
+  // This comment will not be removed.
+  rpc Rpc2(Input2) returns (Output2);
+}
+
+// This comment will not be removed.
+service Service2 {
+  // This comment will not be removed.
+  rpc Rpc(Input1) returns (Output1);
+}
+
+// This comment will be removed.
+message Input1 {}
+
+// This comment will not be removed.
+message Input2 {}
+
+// This comment will be removed.
+message Output1 {}
+
+// This comment will not be removed.
+message Output2 {}

tests/disable_comments/src/lib.rs

@@ -0,0 +1,3 @@
+pub mod pb {
+    tonic::include_proto!("test");
+}

tests/disable_comments/tests/disable_comments.rs

@@ -0,0 +1,15 @@
+use std::{fs, path::PathBuf};
+
+#[test]
+fn test() {
+    let path = PathBuf::from(std::env::var("OUT_DIR").unwrap()).join("test.rs");
+    let s = fs::read_to_string(path).unwrap();
+    assert!(!s.contains("This comment will be removed."));
+    let mut count = 0_usize;
+    let mut index = 0_usize;
+    while let Some(found) = s[index..].find("This comment will not be removed.") {
+        index += found + 1;
+        count += 1;
+    }
+    assert_eq!(count, 2 + 3 + 3); // message: 2, client: 3, server: 3
+}

tonic-build/Cargo.toml

@@ -12,12 +12,12 @@ license = "MIT"
 name = "tonic-build"
 readme = "README.md"
 repository = "https://github.com/hyperium/tonic"
-version = "0.8.2"
+version = "0.8.3"
 
 [dependencies]
 prettyplease = { version = "0.1" }
 proc-macro2 = "1.0"
-prost-build = { version = "0.11", optional = true }
+prost-build = { version = "0.11.2", optional = true }
 quote = "1.0"
 syn = "1.0"
 

tonic-build/src/client.rs

@@ -1,3 +1,5 @@
+use std::collections::HashSet;
+
 use super::{Attributes, Method, Service};
 use crate::{generate_doc_comments, naive_snake_case};
 use proc_macro2::TokenStream;
@@ -7,19 +9,46 @@ use quote::{format_ident, quote};
 ///
 /// This takes some `Service` and will generate a `TokenStream` that contains
 /// a public module with the generated client.
+#[deprecated(since = "0.8.3", note = "Use the CodeGenBuilder::generate_client")]
 pub fn generate<T: Service>(
     service: &T,
     emit_package: bool,
     proto_path: &str,
     compile_well_known_types: bool,
+    build_transport: bool,
+    attributes: &Attributes,
+) -> TokenStream {
+    generate_internal(
+        service,
+        emit_package,
+        proto_path,
+        compile_well_known_types,
+        build_transport,
+        attributes,
+        &HashSet::default(),
+    )
+}
+
+pub(crate) fn generate_internal<T: Service>(
+    service: &T,
+    emit_package: bool,
+    proto_path: &str,
+    compile_well_known_types: bool,
+    build_transport: bool,
     attributes: &Attributes,
+    disable_comments: &HashSet<String>,
 ) -> TokenStream {
     let service_ident = quote::format_ident!("{}Client", service.name());
     let client_mod = quote::format_ident!("{}_client", naive_snake_case(service.name()));
-    let methods = generate_methods(service, emit_package, proto_path, compile_well_known_types);
+    let methods = generate_methods(
+        service,
+        emit_package,
+        proto_path,
+        compile_well_known_types,
+        disable_comments,
+    );
 
-    let connect = generate_connect(&service_ident);
-    let service_doc = generate_doc_comments(service.comment());
+    let connect = generate_connect(&service_ident, build_transport);
 
     let package = if emit_package { service.package() } else { "" };
     let path = format!(
@@ -29,6 +58,12 @@ pub fn generate<T: Service>(
         service.identifier()
     );
 
+    let service_doc = if disable_comments.contains(&path) {
+        TokenStream::new()
+    } else {
+        generate_doc_comments(service.comment())
+    };
+
     let mod_attributes = attributes.for_mod(package);
     let struct_attributes = attributes.for_struct(&path);
 
@@ -109,8 +144,8 @@ pub fn generate<T: Service>(
 }
 
 #[cfg(feature = "transport")]
-fn generate_connect(service_ident: &syn::Ident) -> TokenStream {
-    quote! {
+fn generate_connect(service_ident: &syn::Ident, enabled: bool) -> TokenStream {
+    let connect_impl = quote! {
         impl #service_ident<tonic::transport::Channel> {
             /// Attempt to create a new client by connecting to a given endpoint.
             pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
@@ -122,11 +157,17 @@ fn generate_connect(service_ident: &syn::Ident) -> TokenStream {
                 Ok(Self::new(conn))
             }
         }
+    };
+
+    if enabled {
+        connect_impl
+    } else {
+        TokenStream::new()
     }
 }
 
 #[cfg(not(feature = "transport"))]
-fn generate_connect(_service_ident: &syn::Ident) -> TokenStream {
+fn generate_connect(_service_ident: &syn::Ident, _enabled: bool) -> TokenStream {
     TokenStream::new()
 }
 
@@ -135,6 +176,7 @@ fn generate_methods<T: Service>(
     emit_package: bool,
     proto_path: &str,
     compile_well_known_types: bool,
+    disable_comments: &HashSet<String>,
 ) -> TokenStream {
     let mut stream = TokenStream::new();
     let package = if emit_package { service.package() } else { "" };
@@ -148,7 +190,15 @@ fn generate_methods<T: Service>(
             method.identifier()
         );
 
-        stream.extend(generate_doc_comments(method.comment()));
+        if !disable_comments.contains(&format!(
+            "{}{}{}.{}",
+            package,
+            if package.is_empty() { "" } else { "." },
+            service.identifier(),
+            method.identifier()
+        )) {
+            stream.extend(generate_doc_comments(method.comment()));
+        }
 
         let method = match (method.client_streaming(), method.server_streaming()) {
             (false, false) => generate_unary(method, proto_path, compile_well_known_types, path),