prost-build: CodeGenerator::boxed method
#1019
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
caspermeijn
reviewed
Mar 29, 2024
mzabaluev
commented
Mar 29, 2024
prost-build/src/code_generator.rs
Outdated
Comment on lines
1030
to
1032
| if field.label == Some(Label::Repeated as i32) { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
Note that this changes the logic from the original: now any boxed match from the config will be ignored if the field is repeated, while previously it gave true. But I think that was wrong, because it never makes sense to box a Vec.
There was a problem hiding this comment.
To think of it, this should be reverted if we want this to be merged for 0.12.x releases.
There was a problem hiding this comment.
The quick fix is to split this function into a boxed_field and boxed_oneof variants. Make sure to document why two variants are needed.
Maybe you could add a deprecation warning like this:
println!("cargo:warning=Field X is repeated and manually marked as boxed. This is deprecated and support will be removed in a later release");There was a problem hiding this comment.
The quick fix is to split this function into a
boxed_fieldandboxed_oneofvariants. Make sure to document why two variants are needed.
I don't like this idea. The logic would need to be replicated, even though it's mostly the same for regular fields and oneof members. More so with the deprecation warning, which I have now added as per your suggestion.
Done, with some complication and a questionable behavioral change that I have commented on above. |
caspermeijn
reviewed
Apr 5, 2024
prost-build/src/code_generator.rs
Outdated
Comment on lines
1030
to
1032
| if field.label == Some(Label::Repeated as i32) { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
The quick fix is to split this function into a boxed_field and boxed_oneof variants. Make sure to document why two variants are needed.
Maybe you could add a deprecation warning like this:
println!("cargo:warning=Field X is repeated and manually marked as boxed. This is deprecated and support will be removed in a later release");
A helper method to capture the logic of deciding whether a field needs to be boxed. This follows the pattern with other methods like `optional`, and will allow reusing the logic in the upcoming builder codegen.
The bit in CodeGenerator::append_oneof was pretty much the same, except the configuration is looked up for the oneof name. Rearrange the logic so that intermediate values are bound when needed. If a repeated fields is configured to be boxed, a deprecation warning will be emitted by the build script.
mzabaluev
force-pushed
the
codegen-refactor-boxed
branch
from
c64f1f2
to
3fa4069
Compare
caspermeijn
requested changes
May 3, 2024
Co-authored-by: Casper Meijn <casper@meijn.net>
caspermeijn
approved these changes
May 5, 2024
|
Thank you for your contribution. I appreciate your patience during the review. |
caspermeijn
added a commit
to caspermeijn/prost
that referenced
this pull request
May 5, 2024
_PROST!_ is a [Protocol Buffers](https://developers.google.com/protocol-buffers/) implementation for the [Rust Language](https://www.rust-lang.org/). `prost` generates simple, idiomatic Rust code from `proto2` and `proto3` files. This patch update brings new fixes: - fix: include_file should handle proto without package (tokio-rs#1002) - Place Config::format behind the format feature flag - Handle keyword `Self` after stripping enum type prefix (tokio-rs#998) ## Documentation - fix(readme): fix the link and badge for CI (tokio-rs#1049) ## Internal - style(codegen): `Syntax` to a separate file (tokio-rs#1029) - chore(codegen): extract c string escaping to a separate file (tokio-rs#1028) - style(prost-build): `CodeGenerator::boxed` method (tokio-rs#1019) - style(prost-build): Consolidate field data into struct (tokio-rs#1017) - style(prost-build): `BytesType and MapType` into a `collections` module. (tokio-rs#1030) - style(prost-build): Split `Config` and `Module` into a separate module and files (tokio-rs#1020) - style(prost-build): prost_path helper (tokio-rs#1018) - style: Fix toml indent (tokio-rs#1048) - style: Fix clippy warnings and enable clippy in CI (tokio-rs#1008) - build: Use git submodule to download protobuf sources (tokio-rs#1014) - ci: Add TOML validation with `taplo` (tokio-rs#1034) - tests: Create a separate tempdir for each test (tokio-rs#1044) - tests: Remove GoogleMessage3 and GoogleMessage4 benchmarks (tokio-rs#1037) - chore: Update internal crates to Rust edition 2021 (tokio-rs#1039) - chore: Update crate descriptions (tokio-rs#1038) - chore: Fix clippy checks in CI (tokio-rs#1032) - chore: Add Casper Meijn as author (tokio-rs#1025)
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 8, 2024
_PROST!_ is a [Protocol Buffers](https://developers.google.com/protocol-buffers/) implementation for the [Rust Language](https://www.rust-lang.org/). `prost` generates simple, idiomatic Rust code from `proto2` and `proto3` files. This patch update brings new fixes: - fix: include_file should handle proto without package (#1002) - Place Config::format behind the format feature flag - Handle keyword `Self` after stripping enum type prefix (#998) ## Documentation - fix(readme): fix the link and badge for CI (#1049) ## Internal - style(codegen): `Syntax` to a separate file (#1029) - chore(codegen): extract c string escaping to a separate file (#1028) - style(prost-build): `CodeGenerator::boxed` method (#1019) - style(prost-build): Consolidate field data into struct (#1017) - style(prost-build): `BytesType and MapType` into a `collections` module. (#1030) - style(prost-build): Split `Config` and `Module` into a separate module and files (#1020) - style(prost-build): prost_path helper (#1018) - style: Fix toml indent (#1048) - style: Fix clippy warnings and enable clippy in CI (#1008) - build: Use git submodule to download protobuf sources (#1014) - ci: Add TOML validation with `taplo` (#1034) - tests: Create a separate tempdir for each test (#1044) - tests: Remove GoogleMessage3 and GoogleMessage4 benchmarks (#1037) - chore: Update internal crates to Rust edition 2021 (#1039) - chore: Update crate descriptions (#1038) - chore: Fix clippy checks in CI (#1032) - chore: Add Casper Meijn as author (#1025)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A helper method to capture the logic of deciding whether a field needs to be boxed. This follows the pattern with other methods like
optional, and will allow reusing the logic in the upcoming builder codegen in #901.