Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support protoc-gen-prost-serde in prost_toolchain #2646

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support protoc-gen-prost-serde in prost_toolchain #2646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e859ff2
Support protoc-gen-prost-serde in prost_toolchain
mrmeku May 9, 2024
5aa520d
Regenerate documentation
mrmeku May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/flatten.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,8 @@ Builds a Rust proc-macro crate.
## rust_prost_toolchain

<pre>
rust_prost_toolchain(<a href="#rust_prost_toolchain-name">name</a>, <a href="#rust_prost_toolchain-prost_opts">prost_opts</a>, <a href="#rust_prost_toolchain-prost_plugin">prost_plugin</a>, <a href="#rust_prost_toolchain-prost_plugin_flag">prost_plugin_flag</a>, <a href="#rust_prost_toolchain-prost_runtime">prost_runtime</a>, <a href="#rust_prost_toolchain-prost_types">prost_types</a>,
rust_prost_toolchain(<a href="#rust_prost_toolchain-name">name</a>, <a href="#rust_prost_toolchain-prost_opts">prost_opts</a>, <a href="#rust_prost_toolchain-prost_plugin">prost_plugin</a>, <a href="#rust_prost_toolchain-prost_plugin_flag">prost_plugin_flag</a>, <a href="#rust_prost_toolchain-prost_runtime">prost_runtime</a>,
<a href="#rust_prost_toolchain-prost_serde_opts">prost_serde_opts</a>, <a href="#rust_prost_toolchain-prost_serde_plugin">prost_serde_plugin</a>, <a href="#rust_prost_toolchain-prost_serde_plugin_flag">prost_serde_plugin_flag</a>, <a href="#rust_prost_toolchain-prost_types">prost_types</a>,
<a href="#rust_prost_toolchain-proto_compiler">proto_compiler</a>, <a href="#rust_prost_toolchain-tonic_opts">tonic_opts</a>, <a href="#rust_prost_toolchain-tonic_plugin">tonic_plugin</a>, <a href="#rust_prost_toolchain-tonic_plugin_flag">tonic_plugin_flag</a>, <a href="#rust_prost_toolchain-tonic_runtime">tonic_runtime</a>)
</pre>

Expand All @@ -846,6 +847,9 @@ Rust Prost toolchain rule.
| <a id="rust_prost_toolchain-prost_plugin"></a>prost_plugin | Additional plugins to add to Prost. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-prost_plugin_flag"></a>prost_plugin_flag | Prost plugin flag format. (e.g. <code>--plugin=protoc-gen-prost=%s</code>) | String | optional | <code>"--plugin=protoc-gen-prost=%s"</code> |
| <a id="rust_prost_toolchain-prost_runtime"></a>prost_runtime | The Prost runtime crates to use. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-prost_serde_opts"></a>prost_serde_opts | Additional options to add to prost-serde. | List of strings | optional | <code>[]</code> |
| <a id="rust_prost_toolchain-prost_serde_plugin"></a>prost_serde_plugin | Additional plugins to add to prost-serde. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="rust_prost_toolchain-prost_serde_plugin_flag"></a>prost_serde_plugin_flag | prost-serde plugin flag format. (e.g. <code>--plugin=protoc-gen-prost-serde=%s</code>)) | String | optional | <code>"--plugin=protoc-gen-prost-serde=%s"</code> |
| <a id="rust_prost_toolchain-prost_types"></a>prost_types | The Prost types crates to use. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-proto_compiler"></a>proto_compiler | The protoc compiler to use. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-tonic_opts"></a>tonic_opts | Additional options to add to Tonic. | List of strings | optional | <code>[]</code> |
Expand Down
6 changes: 5 additions & 1 deletion docs/rust_proto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,8 @@ rust_binary(
## rust_prost_toolchain

<pre>
rust_prost_toolchain(<a href="#rust_prost_toolchain-name">name</a>, <a href="#rust_prost_toolchain-prost_opts">prost_opts</a>, <a href="#rust_prost_toolchain-prost_plugin">prost_plugin</a>, <a href="#rust_prost_toolchain-prost_plugin_flag">prost_plugin_flag</a>, <a href="#rust_prost_toolchain-prost_runtime">prost_runtime</a>, <a href="#rust_prost_toolchain-prost_types">prost_types</a>,
rust_prost_toolchain(<a href="#rust_prost_toolchain-name">name</a>, <a href="#rust_prost_toolchain-prost_opts">prost_opts</a>, <a href="#rust_prost_toolchain-prost_plugin">prost_plugin</a>, <a href="#rust_prost_toolchain-prost_plugin_flag">prost_plugin_flag</a>, <a href="#rust_prost_toolchain-prost_runtime">prost_runtime</a>,
<a href="#rust_prost_toolchain-prost_serde_opts">prost_serde_opts</a>, <a href="#rust_prost_toolchain-prost_serde_plugin">prost_serde_plugin</a>, <a href="#rust_prost_toolchain-prost_serde_plugin_flag">prost_serde_plugin_flag</a>, <a href="#rust_prost_toolchain-prost_types">prost_types</a>,
<a href="#rust_prost_toolchain-proto_compiler">proto_compiler</a>, <a href="#rust_prost_toolchain-tonic_opts">tonic_opts</a>, <a href="#rust_prost_toolchain-tonic_plugin">tonic_plugin</a>, <a href="#rust_prost_toolchain-tonic_plugin_flag">tonic_plugin_flag</a>, <a href="#rust_prost_toolchain-tonic_runtime">tonic_runtime</a>)
</pre>

Expand All @@ -319,6 +320,9 @@ Rust Prost toolchain rule.
| <a id="rust_prost_toolchain-prost_plugin"></a>prost_plugin | Additional plugins to add to Prost. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-prost_plugin_flag"></a>prost_plugin_flag | Prost plugin flag format. (e.g. <code>--plugin=protoc-gen-prost=%s</code>) | String | optional | <code>"--plugin=protoc-gen-prost=%s"</code> |
| <a id="rust_prost_toolchain-prost_runtime"></a>prost_runtime | The Prost runtime crates to use. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-prost_serde_opts"></a>prost_serde_opts | Additional options to add to prost-serde. | List of strings | optional | <code>[]</code> |
| <a id="rust_prost_toolchain-prost_serde_plugin"></a>prost_serde_plugin | Additional plugins to add to prost-serde. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
| <a id="rust_prost_toolchain-prost_serde_plugin_flag"></a>prost_serde_plugin_flag | prost-serde plugin flag format. (e.g. <code>--plugin=protoc-gen-prost-serde=%s</code>)) | String | optional | <code>"--plugin=protoc-gen-prost-serde=%s"</code> |
| <a id="rust_prost_toolchain-prost_types"></a>prost_types | The Prost types crates to use. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-proto_compiler"></a>proto_compiler | The protoc compiler to use. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
| <a id="rust_prost_toolchain-tonic_opts"></a>tonic_opts | Additional options to add to Tonic. | List of strings | optional | <code>[]</code> |
Expand Down
25 changes: 22 additions & 3 deletions proto/prost/private/prost.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,13 @@ def _compile_proto(ctx, crate_name, proto_info, deps, prost_toolchain, rustfmt_t
additional_args.add_all(prost_toolchain.tonic_opts, format_each = "--tonic_opt=%s")
tools = depset([tonic_plugin.executable], transitive = [tools])

if rustfmt_toolchain:
additional_args.add("--rustfmt={}".format(rustfmt_toolchain.rustfmt.path))
tools = depset(transitive = [tools, rustfmt_toolchain.all_files])
if prost_toolchain.prost_serde_plugin:
prost_serde_plugin = prost_toolchain.prost_serde_plugin[DefaultInfo].files_to_run
additional_args.add(prost_toolchain.prost_serde_plugin_flag % prost_serde_plugin.executable.path)
additional_args.add("--prost-serde_opt=no_include")
additional_args.add("--is_prost_serde")
additional_args.add_all(prost_toolchain.prost_serde_opts, format_each = "--prost-serde_opt=%s")
tools = depset([prost_serde_plugin.executable], transitive = [tools])

additional_inputs = depset([deps_info_file, proto_info.direct_descriptor_set] + [dep[ProstProtoInfo].package_info for dep in deps])

Expand Down Expand Up @@ -359,6 +363,9 @@ def _rust_prost_toolchain_impl(ctx):
tonic_plugin = ctx.attr.tonic_plugin,
tonic_plugin_flag = ctx.attr.tonic_plugin_flag,
tonic_runtime = ctx.attr.tonic_runtime,
prost_serde_opts = ctx.attr.prost_serde_opts,
prost_serde_plugin = ctx.attr.prost_serde_plugin,
prost_serde_plugin_flag = ctx.attr.prost_serde_plugin_flag,
)]

rust_prost_toolchain = rule(
Expand All @@ -384,6 +391,18 @@ rust_prost_toolchain = rule(
providers = [[rust_common.crate_info], [rust_common.crate_group_info]],
mandatory = True,
),
"prost_serde_opts": attr.string_list(
doc = "Additional options to add to prost-serde.",
),
"prost_serde_plugin": attr.label(
doc = "Additional plugins to add to prost-serde.",
cfg = "exec",
executable = True,
),
"prost_serde_plugin_flag": attr.string(
doc = "prost-serde plugin flag format. (e.g. `--plugin=protoc-gen-prost-serde=%s`))",
default = "--plugin=protoc-gen-prost-serde=%s",
),
"prost_types": attr.label(
doc = "The Prost types crates to use.",
providers = [[rust_common.crate_info], [rust_common.crate_group_info]],
Expand Down
80 changes: 46 additions & 34 deletions proto/prost/private/protoc_wrapper.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,11 @@ struct Module {
/// }
/// }
/// ```
fn generate_lib_rs(prost_outputs: &BTreeSet<PathBuf>, is_tonic: bool) -> String {
fn generate_lib_rs(
prost_outputs: &BTreeSet<PathBuf>,
is_tonic: bool,
is_prost_serde: bool,
) -> String {
let mut module_info = BTreeMap::new();

for path in prost_outputs.iter() {
Expand All @@ -133,7 +137,13 @@ fn generate_lib_rs(prost_outputs: &BTreeSet<PathBuf>, is_tonic: bool) -> String
.strip_suffix(".tonic")
.expect("Failed to strip suffix")
.to_string()
};
}
if is_prost_serde && package.ends_with(".serde") {
package = package
.strip_suffix(".serde")
.expect("Failed to strip suffix")
.to_string()
}

if package.is_empty() {
continue;
Expand All @@ -155,14 +165,21 @@ fn generate_lib_rs(prost_outputs: &BTreeSet<PathBuf>, is_tonic: bool) -> String
// Avoid a stack overflow by skipping a known bad package name
let module_name = snake_cased_package_name(&package);

module_info.insert(
module_name.clone(),
Module {
module_info
.entry(module_name.clone())
// Serde module will have same name as module its bindings are for.
.and_modify(|module: &mut Module| {
module.contents = format!(
"{}\n{}",
module.contents,
fs::read_to_string(path).expect("Failed to read file")
);
})
.or_insert(Module {
name,
contents: fs::read_to_string(path).expect("Failed to read file"),
submodules: BTreeSet::new(),
},
);
});

let module_parts = module_name.split('.').collect::<Vec<_>>();
for parent_module_index in 0..module_parts.len() {
Expand Down Expand Up @@ -437,12 +454,12 @@ struct Args {
/// The proto include paths.
proto_paths: Vec<String>,

/// The path to the rustfmt binary.
rustfmt: Option<PathBuf>,

/// Whether to generate tonic code.
is_tonic: bool,

/// Whether to generate prost serde code.
is_prost_serde: bool,

/// Extra arguments to pass to protoc.
extra_args: Vec<String>,
}
Expand All @@ -458,11 +475,11 @@ impl Args {
let mut includes = Vec::new();
let mut descriptor_set = None;
let mut out_librs: Option<PathBuf> = None;
let mut rustfmt: Option<PathBuf> = None;
let mut proto_paths = Vec::new();
let mut label: Option<String> = None;
let mut tonic_or_prost_opts = Vec::new();
let mut is_tonic = false;
let mut is_prost_serde = false;

let mut extra_args = Vec::new();

Expand All @@ -486,6 +503,11 @@ impl Args {
return;
}

if arg == "--is_prost_serde" {
is_prost_serde = true;
return;
}

if !arg.contains('=') {
extra_args.push(arg);
return;
Expand Down Expand Up @@ -527,9 +549,6 @@ impl Args {
("--out_librs", value) => {
out_librs = Some(PathBuf::from(value));
}
("--rustfmt", value) => {
rustfmt = Some(PathBuf::from(value));
}
("--proto_path", value) => {
proto_paths.push(value.to_string());
}
Expand Down Expand Up @@ -563,6 +582,9 @@ impl Args {
if is_tonic {
extra_args.push(format!("--tonic_opt={}", tonic_or_prost_opt));
}
if is_prost_serde {
extra_args.push(format!("--prost-serde_opt={}", tonic_or_prost_opt));
}
}

if protoc.is_none() {
Expand Down Expand Up @@ -610,9 +632,9 @@ impl Args {
includes,
descriptor_set: descriptor_set.unwrap(),
out_librs: out_librs.unwrap(),
rustfmt,
proto_paths,
is_tonic,
is_prost_serde,
label: label.unwrap(),
extra_args,
})
Expand Down Expand Up @@ -715,9 +737,9 @@ fn main() {
includes,
descriptor_set,
out_librs,
rustfmt,
proto_paths,
is_tonic,
is_prost_serde,
extra_args,
} = Args::parse().expect("Failed to parse args");

Expand All @@ -737,6 +759,9 @@ fn main() {
if is_tonic {
cmd.arg(format!("--tonic_out={}", out_dir.display()));
}
if is_prost_serde {
cmd.arg(format!("--prost-serde_out={}", out_dir.display()));
}
cmd.args(extra_args);
cmd.args(
proto_paths
Expand Down Expand Up @@ -830,7 +855,11 @@ fn main() {
.expect("Failed to compute proto package info");

// Write outputs
fs::write(&out_librs, generate_lib_rs(&rust_files, is_tonic)).expect("Failed to write file.");
fs::write(
&out_librs,
generate_lib_rs(&rust_files, is_tonic, is_prost_serde),
)
.expect("Failed to write file.");
fs::write(
package_info_file,
extern_paths
Expand All @@ -840,23 +869,6 @@ fn main() {
.join("\n"),
)
.expect("Failed to write file.");

// Finally run rustfmt on the output lib.rs file
if let Some(rustfmt) = rustfmt {
let fmt_status = process::Command::new(rustfmt)
.arg("--edition")
.arg("2021")
.arg("--quiet")
.arg(&out_librs)
.status()
.expect("Failed to spawn rustfmt process");
if !fmt_status.success() {
panic!(
"rustfmt failed with exit code: {}",
fmt_status.code().expect("Failed to get exit code")
);
}
}
}

/// Rust built-in keywords and reserved keywords.
Expand Down