Merge branch 'containerd:master' into serve_connected

KarstenB · web-flow · commit 48b05c1e1d09 · 2025-07-13T09:52:11.000+02:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,18 +1,47 @@
-[package]
-name = "ttrpc"
-version = "0.8.4"
-authors = ["The AntFin Kata Team <kata@list.alibaba-inc.com>"]
+[workspace]
+members = [
+    "./compiler",
+    "./ttrpc-codegen",
+    "./example",
+    "./"
+]
+resolver = "2"
+
+[workspace.package]
 edition = "2018"
 license = "Apache-2.0"
-keywords = ["ttrpc", "protobuf", "rpc"]
 readme = "README.md"
 repository = "https://github.com/containerd/ttrpc-rust"
 homepage = "https://github.com/containerd/ttrpc-rust"
+authors = ["The AntFin Kata Team <kata@list.alibaba-inc.com>"]
+
+[workspace.dependencies]
+# The dependencies in this section can be used by the crates in this
+# workspace by specifying `workspace = true` instead of the crate
+# version. For example, for protobuf:
+#   protobuf = { workspace = true }
+ttrpc = { version = "0.8.4", path = "./" }
+ttrpc-codegen = { version = "0.5.0", path = "./ttrpc-codegen" }
+ttrpc-compiler = { version = "0.7.0", path = "./compiler" }
+protobuf = "3.7.2"
+protobuf-codegen = "3.7.2"
+protobuf-support = "3.7.2"
+
+[package]
+name = "ttrpc"
+version = "0.8.4"
+authors = { workspace = true }
+edition = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+homepage = { workspace = true }
+keywords = ["ttrpc", "protobuf", "rpc"]
+readme = "README.md"
 description = "A Rust version of ttrpc."
 rust-version = "1.70"
 
 [dependencies]
-protobuf = { version = "3.7.2" }
+protobuf = { workspace = true }
 libc = { version = "0.2.59", features = [ "extra_traits" ] }
 nix = "0.26.2"
 log = "0.4"
@@ -31,9 +60,7 @@ windows-sys = {version = "0.48", features = [ "Win32_Foundation", "Win32_Storage
 tokio-vsock = { version = "0.7.0", optional = true }
 
 [build-dependencies]
-# lock home to avoid conflict with latest version
-home = "=0.5.9"
-protobuf-codegen = "3.7.2"
+protobuf-codegen = { workspace = true }
 
 [features]
 default = ["sync"]
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,27 @@
+# Release Process
+
+This document describes the steps to release a new version of the crate or wasi-demo-app images.
+
+## Crate Release Process
+
+### Release Steps
+
+1. Bump package and dependency versions in:
+   * `./compiler/Cargo.toml`: Bump the package version as needed.
+   * `./ttrpc-codegen/Cargo.toml`: Bump the package version as needed.
+   * `./Cargo.toml`: Bump package version as needed. Then bump the workspace dependencies version to match the respective crates versions.
+2. Commit the changes and get them merged in the repo.
+2. Dry run the `cargo publish` command as follow
+   ```bash
+   cargo +nightly publish \
+     -Z package-workspace \
+     --dry-run \
+     --locked \
+     -p ttrpc \
+     -p ttrpc-codegen \
+     -p ttrpc-compiler
+   ```
+2. If the dry run succeeds, publish the crates that need publishing using `cargo publihs -p <crate>` in the following order
+   1. `ttrpc-compiler`
+   2. `ttrpc-codegen`
+   3. `ttrpc`
diff --git a/compiler/Cargo.toml b/compiler/Cargo.toml
@@ -1,21 +1,19 @@
 [package]
 name = "ttrpc-compiler"
 version = "0.7.0"
-edition = "2018"
-authors = ["The AntFin Kata Team <kata@list.alibaba-inc.com>"]
-license = "Apache-2.0"
+edition = { workspace = true }
+license = { workspace = true }
+authors = { workspace = true }
+readme = "README.md"
 keywords = ["compiler", "ttrpc", "protobuf"]
 description = "ttRPC compiler for ttrpc"
 categories = ["network-programming"]
 repository = "https://github.com/containerd/ttrpc-rust/tree/master/compiler"
 homepage = "https://github.com/containerd/ttrpc-rust/tree/master/compiler"
-readme = "README.md"
 
 [dependencies]
-# lock home to avoid conflict with latest version
-home = "=0.5.9"
-protobuf = "3.7.2"
-protobuf-codegen = "3.7.2"
+protobuf = { workspace = true }
+protobuf-codegen = { workspace = true }
 prost = "0.8"
 prost-build = "0.8"
 prost-types = "0.8"
diff --git a/example/Cargo.toml b/example/Cargo.toml
@@ -9,6 +9,7 @@ readme = "README.md"
 repository = "https://github.com/alipay/ttrpc-rust"
 homepage = "https://github.com/alipay/ttrpc-rust"
 description = "An example of ttrpc."
+publish = false
 
 [dev-dependencies]
 protobuf = "3.7.2"
@@ -23,7 +24,7 @@ ctrlc = { version = "3.0", features = ["termination"] }
 tokio = { version = "1.0.1", features = ["signal", "time"] }
 async-trait = "0.1.42"
 rand = "0.8.5"
-
+clap = { version = "4.5.40", features = ["derive"] }
 
 [[example]]
 name = "client"
diff --git a/example/async-client.rs b/example/async-client.rs
@@ -11,7 +11,9 @@ use ttrpc::r#async::Client;
 
 #[tokio::main(flavor = "current_thread")]
 async fn main() {
-    let c = Client::connect(utils::SOCK_ADDR).await.unwrap();
+    let sock_addr = utils::get_sock_addr();
+    let c = Client::connect(sock_addr).await.unwrap();
+
     let hc = health_ttrpc::HealthClient::new(c.clone());
     let ac = agent_ttrpc::AgentServiceClient::new(c);
 
diff --git a/example/async-server.rs b/example/async-server.rs
@@ -58,10 +58,11 @@ async fn main() {
     let hservice = health_ttrpc::create_health(Arc::new(HealthService {}));
     let aservice = agent_ttrpc::create_agent_service(Arc::new(AgentService {}));
 
-    utils::remove_if_sock_exist(utils::SOCK_ADDR).unwrap();
+    let sock_addr = utils::get_sock_addr();
+    utils::remove_if_sock_exist(sock_addr).unwrap();
 
     let mut server = Server::new()
-        .bind(utils::SOCK_ADDR)
+        .bind(sock_addr)
         .unwrap()
         .register_service(hservice)
         .register_service(aservice);
diff --git a/example/async-stream-client.rs b/example/async-stream-client.rs
@@ -13,7 +13,9 @@ use ttrpc::r#async::Client;
 async fn main() {
     simple_logging::log_to_stderr(log::LevelFilter::Info);
 
-    let c = Client::connect(utils::SOCK_ADDR).await.unwrap();
+    let sock_addr = utils::get_sock_addr();
+    let c = Client::connect(sock_addr).await.unwrap();
+
     let sc = streaming_ttrpc::StreamingClient::new(c);
 
     let _now = std::time::Instant::now();
diff --git a/example/async-stream-server.rs b/example/async-stream-server.rs
@@ -171,10 +171,12 @@ impl streaming_ttrpc::Streaming for StreamingService {
 async fn main() {
     simple_logging::log_to_stderr(LevelFilter::Info);
     let service = streaming_ttrpc::create_streaming(Arc::new(StreamingService {}));
-    utils::remove_if_sock_exist(utils::SOCK_ADDR).unwrap();
+
+    let sock_addr = utils::get_sock_addr();
+    utils::remove_if_sock_exist(sock_addr).unwrap();
 
     let mut server = Server::new()
-        .bind(utils::SOCK_ADDR)
+        .bind(sock_addr)
         .unwrap()
         .register_service(service);
 
diff --git a/example/client.rs b/example/client.rs
@@ -50,7 +50,9 @@ fn main() {
 fn connect_once() {
     simple_logging::log_to_stderr(LevelFilter::Trace);
 
-    let c = Client::connect(utils::SOCK_ADDR).unwrap();
+    let sock_addr = utils::get_sock_addr();
+    let c = Client::connect(sock_addr).unwrap();
+
     let hc = health_ttrpc::HealthClient::new(c.clone());
     let ac = agent_ttrpc::AgentServiceClient::new(c);
 
diff --git a/example/protocols/mod.rs b/example/protocols/mod.rs
@@ -2,5 +2,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 //
+
+#[rustfmt::skip]
 pub mod asynchronous;
+
+#[rustfmt::skip]
 pub mod sync;
diff --git a/example/server.rs b/example/server.rs
@@ -58,9 +58,11 @@ fn main() {
     let hservice = health_ttrpc::create_health(Arc::new(HealthService {}));
     let aservice = agent_ttrpc::create_agent_service(Arc::new(AgentService {}));
 
-    utils::remove_if_sock_exist(utils::SOCK_ADDR).unwrap();
+    let sock_addr = utils::get_sock_addr();
+    utils::remove_if_sock_exist(sock_addr).unwrap();
+
     let mut server = ttrpc::Server::new()
-        .bind(utils::SOCK_ADDR)
+        .bind(sock_addr)
         .unwrap()
         .register_service(hservice)
         .register_service(aservice);
diff --git a/example/utils.rs b/example/utils.rs
@@ -1,14 +1,42 @@
 #![allow(dead_code)]
+use clap::Parser;
+use log::warn;
 use std::io::Result;
 
 #[cfg(unix)]
-pub const SOCK_ADDR: &str = r"unix:///tmp/ttrpc-test";
+pub const SOCK_ADDR_LOCAL: &str = r"unix:///tmp/ttrpc-test";
 
 #[cfg(windows)]
-pub const SOCK_ADDR: &str = r"\\.\pipe\ttrpc-test";
+pub const SOCK_ADDR_LOCAL: &str = r"\\.\pipe\ttrpc-test";
+
+pub const SOCK_ADDR_TCP: &str = r"tcp://127.0.0.1:65500";
+
+#[derive(Debug, Default, Parser)]
+pub struct Cli {
+    #[arg(long = "tcp")]
+    #[arg(help = "Use a TCP socket instead of a local one")]
+    pub tcp: bool,
+}
+
+pub fn get_sock_addr() -> &'static str {
+    let cli = Cli::parse();
+    if cli.tcp {
+        if cfg!(windows) {
+            warn!("'--tcp' flag ignored; TCP sockets not supported on Windows");
+            return SOCK_ADDR_LOCAL;
+        }
+        SOCK_ADDR_TCP
+    } else {
+        SOCK_ADDR_LOCAL
+    }
+}
 
 #[cfg(unix)]
 pub fn remove_if_sock_exist(sock_addr: &str) -> Result<()> {
+    if sock_addr.starts_with("tcp://") {
+        return Ok(());
+    }
+
     let path = sock_addr
         .strip_prefix("unix://")
         .expect("socket address is not expected");
diff --git a/src/asynchronous/server.rs b/src/asynchronous/server.rs
@@ -101,6 +101,15 @@ impl Server {
         Ok(self.add_listener(listener))
     }
 
+    #[cfg(unix)]
+    /// # Safety
+    /// The file descriptor must represent a unix listener.
+    pub unsafe fn add_tcp_listener(self, fd: RawFd) -> Result<Server> {
+        let listener = Listener::from_raw_tcp_listener_fd(fd)
+            .map_err(err_to_others_err!(e, "from_raw_tcp_listener_fd error"))?;
+        Ok(self.add_listener(listener))
+    }
+
     #[cfg(any(target_os = "linux", target_os = "android"))]
     /// # Safety
     /// The file descriptor must represent a vsock listener.
diff --git a/src/asynchronous/transport/mod.rs b/src/asynchronous/transport/mod.rs
@@ -22,6 +22,9 @@ macro_rules! io_other {
 #[cfg(unix)]
 mod unix;
 
+#[cfg(unix)]
+mod tcp;
+
 #[cfg(any(target_os = "linux", target_os = "android"))]
 mod vsock;
 
@@ -43,6 +46,11 @@ impl Listener {
             return Self::bind_unix(addr);
         }
 
+        #[cfg(unix)]
+        if let Some(addr) = addr.strip_prefix("tcp://") {
+            return Self::bind_tcp(addr);
+        }
+
         #[cfg(any(target_os = "linux", target_os = "android"))]
         if let Some(addr) = addr.strip_prefix("vsock://") {
             return Self::bind_vsock(addr);
@@ -70,6 +78,11 @@ impl Socket {
             return Self::connect_unix(addr).await;
         }
 
+        #[cfg(unix)]
+        if let Some(addr) = addr.strip_prefix("tcp://") {
+            return Self::connect_tcp(addr).await;
+        }
+
         #[cfg(any(target_os = "linux", target_os = "android"))]
         if let Some(addr) = addr.strip_prefix("vsock://") {
             return Self::connect_vsock(addr).await;
diff --git a/src/asynchronous/transport/tcp.rs b/src/asynchronous/transport/tcp.rs
diff --git a/src/common.rs b/src/common.rs
diff --git a/src/sync/server.rs b/src/sync/server.rs
diff --git a/tests/run-examples.rs b/tests/run-examples.rs
diff --git a/ttrpc-codegen/Cargo.toml b/ttrpc-codegen/Cargo.toml
