Merge branch 'master' into release

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
       # Switch to stable Rust
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.75.0
+          toolchain: 1.76.0
           components: rustfmt, clippy
           override: true
       - name: Cache Rust
@@ -91,7 +91,7 @@ jobs:
       # Switch to stable Rust
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.75.0
+          toolchain: 1.76.0
           components: rustfmt, clippy
       - name: Cache Rust
         uses: Swatinem/rust-cache@v2

.github/workflows/code-coverage.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install Stable Toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: 1.75.0
+          toolchain: 1.76.0
           components: rustfmt
       - name: Cache Rust
         uses: Swatinem/rust-cache@v2

.rustfmt.toml

@@ -2,7 +2,7 @@ edition = "2021"
 newline_style = "unix"
 # comments
 normalize_comments = true
-#wrap_comments=true
+wrap_comments = true
 format_code_in_doc_comments = true
 # imports
 imports_granularity = "Crate"

Cargo.toml

@@ -20,17 +20,18 @@ repository = "https://github.com/poem-web/poem"
 rust-version = "1.75"
 
 [workspace.dependencies]
-poem = { path = "poem", version = "3.0.4", default-features = false }
-poem-derive = { path = "poem-derive", version = "3.0.4" }
-poem-openapi-derive = { path = "poem-openapi-derive", version = "5.0.3" }
-poem-grpc-build = { path = "poem-grpc-build", version = "0.4.2" }
+poem = { path = "poem", version = "3.1.0", default-features = false }
+poem-derive = { path = "poem-derive", version = "3.1.0" }
+poem-openapi-derive = { path = "poem-openapi-derive", version = "5.1.0" }
+poem-grpc-build = { path = "poem-grpc-build", version = "0.5.0" }
 
 proc-macro-crate = "3.0.0"
 proc-macro2 = "1.0.29"
 quote = "1.0.9"
 syn = { version = "2.0" }
 tokio = "1.39.1"
 serde_json = "1.0.68"
+sonic-rs = "0.3.5"
 serde = { version = "1.0.130", features = ["derive"] }
 thiserror = "1.0.30"
 regex = "1.5.5"

README.md

@@ -9,9 +9,9 @@
     <img src="https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square"
       alt="Unsafe Rust forbidden" />
   </a>
-  <a href="https://blog.rust-lang.org/2023/11/16/Rust-1.75.0.html">
-    <img src="https://img.shields.io/badge/rustc-1.75.0+-ab6000.svg"
-      alt="rustc 1.75.0+" />
+  <a href="https://blog.rust-lang.org/2023/11/16/Rust-1.76.0.html">
+    <img src="https://img.shields.io/badge/rustc-1.76.0+-ab6000.svg"
+      alt="rustc 1.76.0+" />
   </a>
   <a href="https://discord.gg/qWWNxwasb7">
     <img src="https://img.shields.io/discord/932986985604333638.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2" />

examples/grpc/helloworld_compressed/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "example-grpc-helloworld-compressed"
+version.workspace = true
+edition.workspace = true
+publish.workspace = true
+
+[dependencies]
+poem.workspace = true
+poem-grpc = { workspace = true, features = [
+    "gzip",
+    "deflate",
+    "brotli",
+    "zstd",
+] }
+prost.workspace = true
+tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }
+
+[build-dependencies]
+poem-grpc-build.workspace = true
+
+[[bin]]
+name = "grpc-helloworld-client"
+path = "src/client.rs"

examples/grpc/helloworld_compressed/build.rs

@@ -0,0 +1,7 @@
+use std::io::Result;
+
+use poem_grpc_build::compile_protos;
+
+fn main() -> Result<()> {
+    compile_protos(&["./proto/helloworld.proto"], &["./proto"])
+}

examples/grpc/helloworld_compressed/proto/helloworld.proto

@@ -0,0 +1,37 @@
+// Copyright 2015 gRPC authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "io.grpc.examples.helloworld";
+option java_outer_classname = "HelloWorldProto";
+
+package helloworld;
+
+// The greeting service definition.
+service Greeter {
+  // Sends a greeting
+  rpc SayHello (HelloRequest) returns (HelloReply) {}
+}
+
+// The request message containing the user's name.
+message HelloRequest {
+  string name = 1;
+}
+
+// The response message containing the greetings
+message HelloReply {
+  string message = 1;
+}

examples/grpc/helloworld_compressed/src/client.rs

@@ -0,0 +1,22 @@
+use poem_grpc::{ClientConfig, CompressionEncoding, Request};
+
+poem_grpc::include_proto!("helloworld");
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+    let mut client = GreeterClient::new(
+        ClientConfig::builder()
+            .uri("http://localhost:3000")
+            .build()
+            .unwrap(),
+    );
+    client.set_send_compressed(CompressionEncoding::GZIP);
+    client.set_accept_compressed([CompressionEncoding::GZIP]);
+
+    let request = Request::new(HelloRequest {
+        name: "Poem".into(),
+    });
+    let response = client.say_hello(request).await?;
+    println!("RESPONSE={response:?}");
+    Ok(())
+}

examples/grpc/helloworld_compressed/src/main.rs

@@ -0,0 +1,35 @@
+use poem::{listener::TcpListener, Server};
+use poem_grpc::{CompressionEncoding, Request, Response, RouteGrpc, Status};
+
+poem_grpc::include_proto!("helloworld");
+
+struct GreeterService;
+
+impl Greeter for GreeterService {
+    async fn say_hello(
+        &self,
+        request: Request<HelloRequest>,
+    ) -> Result<Response<HelloReply>, Status> {
+        let reply = HelloReply {
+            message: format!("Hello {}!", request.into_inner().name),
+        };
+        Ok(Response::new(reply))
+    }
+}
+
+#[tokio::main]
+async fn main() -> Result<(), std::io::Error> {
+    let route = RouteGrpc::new().add_service(
+        GreeterServer::new(GreeterService)
+            .send_compressed(CompressionEncoding::GZIP)
+            .accept_compressed([
+                CompressionEncoding::GZIP,
+                CompressionEncoding::DEFLATE,
+                CompressionEncoding::BROTLI,
+                CompressionEncoding::ZSTD,
+            ]),
+    );
+    Server::new(TcpListener::bind("0.0.0.0:3000"))
+        .run(route)
+        .await
+}

poem-derive/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "poem-derive"
-version = "3.0.4"
+version = "3.1.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

poem-grpc-build/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "poem-grpc-build"
-version = "0.4.2"
+version = "0.5.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

poem-grpc-build/src/client.rs

@@ -117,6 +117,16 @@ pub(crate) fn generate(config: &GrpcConfig, service: &Service, buf: &mut String)
                 self
             }
 
+            /// Set the compression encoding for sending
+            pub fn set_send_compressed(&mut self, encoding: #crate_name::CompressionEncoding) {
+                self.cli.set_send_compressed(encoding);
+            }
+
+            /// Set the compression encodings for accepting
+            pub fn set_accept_compressed(&mut self, encodings: impl ::std::convert::Into<::std::sync::Arc<[#crate_name::CompressionEncoding]>>) {
+                self.cli.set_accept_compressed(encodings);
+            }
+
             #(
             #[allow(dead_code)]
             #methods

poem-grpc-build/src/server.rs

@@ -99,8 +99,22 @@ pub(crate) fn generate(config: &GrpcConfig, service: &Service, buf: &mut String)
         }
 
         #[allow(unused_imports)]
-        #[derive(Clone)]
-        pub struct #server_ident<T>(::std::sync::Arc<T>);
+        pub struct #server_ident<T> {
+            inner: ::std::sync::Arc<T>,
+            send_compressd: ::std::option::Option<#crate_name::CompressionEncoding>,
+            accept_compressed: ::std::sync::Arc<[#crate_name::CompressionEncoding]>,
+        }
+
+        impl<T> ::std::clone::Clone for #server_ident<T> {
+            #[inline]
+            fn clone(&self) -> Self {
+                Self {
+                    inner: self.inner.clone(),
+                    send_compressd: self.send_compressd,
+                    accept_compressed: self.accept_compressed.clone(),
+                }
+            }
+        }
 
         impl<T: #service_ident> #crate_name::Service for #server_ident<T> {
             const NAME: &'static str = #service_name;
@@ -109,8 +123,29 @@ pub(crate) fn generate(config: &GrpcConfig, service: &Service, buf: &mut String)
 
         #[allow(dead_code)]
         impl<T> #server_ident<T> {
+            /// Create a new GRPC server
             pub fn new(service: T) -> Self {
-                Self(::std::sync::Arc::new(service))
+                Self {
+                    inner: ::std::sync::Arc::new(service),
+                    send_compressd: ::std::option::Option::None,
+                    accept_compressed: ::std::sync::Arc::new([]),
+                }
+            }
+
+            /// Set the compression encoding for sending
+            pub fn send_compressed(self, encoding: #crate_name::CompressionEncoding) -> Self {
+                Self {
+                    send_compressd: Some(encoding),
+                    ..self
+                }
+            }
+
+            /// Set the compression encodings for accepting
+            pub fn accept_compressed(self, encodings: impl ::std::convert::Into<::std::sync::Arc<[#crate_name::CompressionEncoding]>>) -> Self {
+                Self {
+                    accept_compressed: encodings.into(),
+                    ..self
+                }
             }
         }
 
@@ -191,7 +226,7 @@ fn generate_unary(codec_list: &[Path], method_info: MethodInfo) -> TokenStream {
         crate_name,
         codec_list,
         quote! {
-            #crate_name::server::GrpcServer::new(codec).unary(#proxy_service_ident(svc.clone()), req).await
+            #crate_name::server::GrpcServer::new(codec, server.send_compressd, &server.accept_compressed).unary(#proxy_service_ident(server.inner.clone()), req).await
         },
     );
 
@@ -211,9 +246,9 @@ fn generate_unary(codec_list: &[Path], method_info: MethodInfo) -> TokenStream {
         }
 
         route = route.at(#path, ::poem::endpoint::make({
-            let svc = self.0.clone();
+            let server = self.clone();
             move |req| {
-                let svc = svc.clone();
+                let server = server.clone();
                 async move { #call }
             }
         }));
@@ -235,7 +270,7 @@ fn generate_client_streaming(codec_list: &[Path], method_info: MethodInfo) -> To
         crate_name,
         codec_list,
         quote! {
-            #crate_name::server::GrpcServer::new(codec).client_streaming(#proxy_service_ident(svc.clone()), req).await
+            #crate_name::server::GrpcServer::new(codec, server.send_compressd, &server.accept_compressed).client_streaming(#proxy_service_ident(server.inner.clone()), req).await
         },
     );
 
@@ -255,9 +290,9 @@ fn generate_client_streaming(codec_list: &[Path], method_info: MethodInfo) -> To
         }
 
         route = route.at(#path, ::poem::endpoint::make({
-            let svc = self.0.clone();
+            let server = self.clone();
             move |req| {
-                let svc = svc.clone();
+                let server = server.clone();
                 async move { #call }
             }
         }));
@@ -279,7 +314,7 @@ fn generate_server_streaming(codec_list: &[Path], method_info: MethodInfo) -> To
         crate_name,
         codec_list,
         quote! {
-            #crate_name::server::GrpcServer::new(codec).server_streaming(#proxy_service_ident(svc.clone()), req).await
+            #crate_name::server::GrpcServer::new(codec, server.send_compressd, &server.accept_compressed).server_streaming(#proxy_service_ident(server.inner.clone()), req).await
         },
     );
 
@@ -299,9 +334,9 @@ fn generate_server_streaming(codec_list: &[Path], method_info: MethodInfo) -> To
         }
 
         route = route.at(#path, ::poem::endpoint::make({
-            let svc = self.0.clone();
+            let server = self.clone();
             move |req| {
-                let svc = svc.clone();
+                let server = server.clone();
                 async move { #call }
             }
         }));
@@ -323,7 +358,7 @@ fn generate_bidirectional_streaming(codec_list: &[Path], method_info: MethodInfo
         crate_name,
         codec_list,
         quote! {
-            #crate_name::server::GrpcServer::new(codec).bidirectional_streaming(#proxy_service_ident(svc.clone()), req).await
+            #crate_name::server::GrpcServer::new(codec, server.send_compressd, &server.accept_compressed).bidirectional_streaming(#proxy_service_ident(server.inner.clone()), req).await
         },
     );
 
@@ -343,9 +378,9 @@ fn generate_bidirectional_streaming(codec_list: &[Path], method_info: MethodInfo
         }
 
         route = route.at(#path, ::poem::endpoint::make({
-            let svc = self.0.clone();
+            let server = self.clone();
             move |req| {
-                let svc = svc.clone();
+                let server = server.clone();
                 async move { #call }
             }
         }));

poem-grpc/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [0.5.0] 2024-09-08
+
+- add support for GRPC compression
+
 # [0.4.2] 2024-07-19
 
 - Fix #840: Grpc build emit package when package is empty [#841](https://github.com/poem-web/poem/pull/841)