Merge pull request containerd#157 from Tim-Zhang/optional-support-3.x

Upgrade protobuf from 2.x to 3.x

Author: Tim-Zhang

.github/workflows/bvt.yml

@@ -40,7 +40,7 @@ jobs:
       matrix:
         checks:
           - advisories
-          - bans licenses sources
+          - bans sources
 
     # Prevent sudden announcement of a new advisory from failing ci:
     continue-on-error: ${{ matrix.checks == 'advisories' }}

Cargo.toml

@@ -11,7 +11,7 @@ homepage = "https://github.com/containerd/ttrpc-rust"
 description = "A Rust version of ttrpc."
 
 [dependencies]
-protobuf = { version = "2.0" }
+protobuf = { version = "3.1.0" }
 libc = { version = "0.2.59", features = [ "extra_traits" ] }
 nix = "0.23.0"
 log = "0.4"
@@ -26,7 +26,7 @@ futures = { version = "0.3", optional = true }
 tokio-vsock = { version = "0.3.1", optional = true }
 
 [build-dependencies]
-protobuf-codegen-pure = "2.14.0"
+protobuf-codegen = "3.1.0"
 
 [features]
 default = ["sync"]

build.rs

@@ -7,10 +7,16 @@ fn main() {
     let path: PathBuf = [out_dir.clone(), "mod.rs".to_string()].iter().collect();
     fs::write(path, "pub mod ttrpc;").unwrap();
 
-    protobuf_codegen_pure::Codegen::new()
+    let customize = protobuf_codegen::Customize::default()
+        .gen_mod_rs(false)
+        .generate_accessors(true);
+
+    protobuf_codegen::Codegen::new()
+        .pure()
         .out_dir(out_dir)
         .inputs(&["src/ttrpc.proto"])
         .include("src")
+        .customize(customize)
         .run()
         .expect("Codegen failed.");
 }

compiler/Cargo.toml

@@ -12,8 +12,8 @@ homepage = "https://github.com/containerd/ttrpc-rust/tree/master/compiler"
 readme = "README.md"
 
 [dependencies]
-protobuf = "2.0"
-protobuf-codegen = "2.14.0"
+protobuf = "2.27.1"
+protobuf-codegen = "2.27.1"
 prost = "0.8"
 prost-build = "0.8"
 prost-types = "0.8"

compiler/src/codegen.rs

@@ -39,12 +39,19 @@
 use std::collections::HashMap;
 
 use crate::Customize;
-use protobuf::compiler_plugin;
-use protobuf::descriptor::*;
-use protobuf::descriptorx::*;
+use protobuf::{
+    compiler_plugin::{GenRequest, GenResult},
+    descriptor::*,
+    descriptorx::*,
+    plugin::{
+        CodeGeneratorRequest, CodeGeneratorResponse, CodeGeneratorResponse_Feature,
+        CodeGeneratorResponse_File,
+    },
+    Message,
+};
 use protobuf_codegen::code_writer::CodeWriter;
 use std::fs::File;
-use std::io::{self, Write};
+use std::io::{self, stdin, stdout, Write};
 use std::path::Path;
 
 use super::util::{
@@ -659,7 +666,7 @@ fn gen_file(
     file: &FileDescriptorProto,
     root_scope: &RootScope,
     customize: &Customize,
-) -> Option<compiler_plugin::GenResult> {
+) -> Option<GenResult> {
     if file.get_service().is_empty() {
         return None;
     }
@@ -685,7 +692,7 @@ fn gen_file(
         }
     }
 
-    Some(compiler_plugin::GenResult {
+    Some(GenResult {
         name: base + "_ttrpc.rs",
         content: v,
     })
@@ -695,7 +702,7 @@ pub fn gen(
     file_descriptors: &[FileDescriptorProto],
     files_to_generate: &[String],
     customize: &Customize,
-) -> Vec<compiler_plugin::GenResult> {
+) -> Vec<GenResult> {
     let files_map: HashMap<&str, &FileDescriptorProto> =
         file_descriptors.iter().map(|f| (f.get_name(), f)).collect();
 
@@ -736,7 +743,7 @@ pub fn gen_and_write(
 }
 
 pub fn protoc_gen_grpc_rust_main() {
-    compiler_plugin::plugin_main(|file_descriptors, files_to_generate| {
+    plugin_main(|file_descriptors, files_to_generate| {
         gen(
             file_descriptors,
             files_to_generate,
@@ -746,3 +753,40 @@ pub fn protoc_gen_grpc_rust_main() {
         )
     });
 }
+
+fn plugin_main<F>(gen: F)
+where
+    F: Fn(&[FileDescriptorProto], &[String]) -> Vec<GenResult>,
+{
+    plugin_main_2(|r| gen(r.file_descriptors, r.files_to_generate))
+}
+
+fn plugin_main_2<F>(gen: F)
+where
+    F: Fn(&GenRequest) -> Vec<GenResult>,
+{
+    let req = CodeGeneratorRequest::parse_from_reader(&mut stdin()).unwrap();
+    let result = gen(&GenRequest {
+        file_descriptors: &req.get_proto_file(),
+        files_to_generate: &req.get_file_to_generate(),
+        parameter: req.get_parameter(),
+    });
+    let mut resp = CodeGeneratorResponse::new();
+    resp.set_supported_features(CodeGeneratorResponse_Feature::FEATURE_PROTO3_OPTIONAL as u64);
+    resp.set_file(
+        result
+            .iter()
+            .map(|file| {
+                let mut r = CodeGeneratorResponse_File::new();
+                r.set_name(file.name.to_string());
+                r.set_content(
+                    std::str::from_utf8(file.content.as_ref())
+                        .unwrap()
+                        .to_string(),
+                );
+                r
+            })
+            .collect(),
+    );
+    resp.write_to_writer(&mut stdout()).unwrap();
+}

example/Cargo.toml

@@ -11,7 +11,7 @@ homepage = "https://github.com/alipay/ttrpc-rust"
 description = "An example of ttrpc."
 
 [dev-dependencies]
-protobuf = "2.8.0"
+protobuf = "3.1.0"
 bytes = "0.4.11"
 libc = "0.2.79"
 byteorder = "1.3.2"

example/async-server.rs

@@ -66,17 +66,17 @@ impl agent_ttrpc::AgentService for AgentService {
         _ctx: &::ttrpc::r#async::TtrpcContext,
         _req: agent::ListInterfacesRequest,
     ) -> ::ttrpc::Result<agent::Interfaces> {
-        let mut rp = protobuf::RepeatedField::new();
+        let mut rp = Vec::new();
 
         let mut i = types::Interface::new();
-        i.set_name("first".to_string());
+        i.name = "first".to_string();
         rp.push(i);
         let mut i = types::Interface::new();
-        i.set_name("second".to_string());
+        i.name = "second".to_string();
         rp.push(i);
 
         let mut i = agent::Interfaces::new();
-        i.set_Interfaces(rp);
+        i.Interfaces = rp;
 
         Ok(i)
     }

example/build.rs

@@ -3,20 +3,24 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
-use std::fs::File;
-use std::io::{Read, Write};
-use ttrpc_codegen::Codegen;
-use ttrpc_codegen::Customize;
+use std::{
+    fs::File,
+    io::{Read, Write},
+};
+use ttrpc_codegen::{Codegen, Customize, ProtobufCustomize};
 
 fn main() {
     let mut protos = vec![
+        "protocols/protos/github.com/gogo/protobuf/gogoproto/gogo.proto",
         "protocols/protos/github.com/kata-containers/agent/pkg/types/types.proto",
         "protocols/protos/agent.proto",
         "protocols/protos/health.proto",
         "protocols/protos/google/protobuf/empty.proto",
         "protocols/protos/oci.proto",
     ];
 
+    let protobuf_customized = ProtobufCustomize::default().gen_mod_rs(false);
+
     Codegen::new()
         .out_dir("protocols/sync")
         .inputs(&protos)
@@ -25,6 +29,7 @@ fn main() {
         .customize(Customize {
             ..Default::default()
         })
+        .rust_protobuf_customize(protobuf_customized.clone())
         .run()
         .expect("Gen sync code failed.");
 
@@ -40,6 +45,7 @@ fn main() {
             async_all: true,
             ..Default::default()
         })
+        .rust_protobuf_customize(protobuf_customized.clone())
         .run()
         .expect("Gen async code failed.");
 

example/protocols/asynchronous/mod.rs

@@ -6,9 +6,10 @@
 pub mod agent;
 pub mod agent_ttrpc;
 pub mod empty;
+mod gogo;
 pub mod health;
 pub mod health_ttrpc;
 mod oci;
-pub mod types;
 pub mod streaming;
 pub mod streaming_ttrpc;
+pub mod types;

example/protocols/protos/health.proto

@@ -17,6 +17,7 @@ option (gogoproto.benchgen_all) = true;
 
 message CheckRequest {
 	string service = 1;
+	optional string option_val = 2;
 }
 
 message HealthCheckResponse {