tonic-health: commit generated code #1065
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
This saves users from needing protoc available on their path if they're not generating other tonic code at build time, either. The generated modules can be regenerated by enabling the `gen-proto` feature, which will trigger the relevant part of the build script.
LucioFranco
requested changes
Aug 22, 2022
tonic-health/build.rs
Outdated
| @@ -1,11 +1,15 @@ | |||
| use std::env; | |||
| use std::path::PathBuf; | |||
| // This build file is used to generate the code as a one-off, | |||
There was a problem hiding this comment.
For prost-types we generate the code via a bootstrap test. This test runs on CI and verifies that the generated code checked in matches locally generated code on the ci box. This removes the need for an awkward feature and gives you the CI check automatically. You can see that approach here https://github.com/tokio-rs/console/blob/606cf721bdd831ee4fa8622081a654fa5b1926b8/console-api/tests/bootstrap.rs
There was a problem hiding this comment.
Ah, that makes sense, I see now. I've pushed a commit to do it the same way here, thanks for the pointer.
As suggested by @LucioFranco in https://github.com/hyperium/tonic/pull/1065\#discussion_r951580189. This avoids the need for a feature which would show up in docs.rs, and achieves the same goals via CI.
flemosr
added a commit
to flemosr/tonic
that referenced
this pull request
Aug 28, 2022
As suggested by @LucioFranco in hyperium#1068 (comment). This avoids the need for consumers to have `protoc` in their path. Implemented following changes in hyperium#1065.
LucioFranco
pushed a commit
that referenced
this pull request
Sep 21, 2022
* types: add tonic as dependency, add error_details.proto * types: add BadRequest support from flemosr/tonic-richer-error * types: adjust code following suggestions Adjustments following suggestions by @LucioFranco in #1068. Adjust style, remove unecessary prints, avoid glob imports, apply `non_exhaustive` to `ErrorDetails` and `ErrorDetail`, avoid pub fields in `ErrorDetails`, adjust `WithErrorDetails::with_error_details_vec` args, add `gen_details_bytes`. * types: add generated protobuf code As suggested by @LucioFranco in #1068 (comment). This avoids the need for consumers to have `protoc` in their path. Implemented following changes in #1065. * types: add custom metadata support This allows consumers to provide custom metadata when creating a `Status` with error details. * types: adjust code following suggestions Adjustments following suggestions by @LucioFranco in #1068. Move `error_details_vec` mod into `error_details` mod, adjust doc comments, rename `WithErrorDetails` trait to `StatusExt`.
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.
This PR resolves #1052 by making the build.rs code and tonic-build dependency optional, as suggested by @nashley in the comments of that issue.
Motivation
See #1052. In brief, this avoids consumers having to have a
protocbinary available in order to usetonic-health, which is helpful if they have also committed their generated code.Solution
src/generated