Provide a way to ignore json_name in HTTP/JSON transcoding
#6082
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
Motivation: There is a bug in protoc that always adds json_name to the descriptor. This happens by default when compiling proto files in Bazel. To mitigate this bug, I propose to add `HttpJsonTranscodingQueryParamMatchRule.IGORE_JSON` to forcibliy ignore json_name when matching query params or path variables. Modifications: - Add `HttpJsonTranscodingQueryParamMatchRule.INGORE_JSON` - If enabled, the `json_name` field option is ignored. Result: - Fixes line#5890 - You can now ignore the `json_name` field option when trancoding HTTP/JSON to gRPC messages.
ikhoon
commented
Feb 3, 2025
| @@ -172,16 +174,20 @@ static GrpcService of(GrpcService delegate, HttpJsonTranscodingOptions httpJsonT | |||
| continue; | |||
| } | |||
|
|
|||
| // TODO(ikhoon): Extract the build-time code into a separate class such as | |||
| // HttpJsonTranscodingServiceBuilder or HttpJsonTranscodingSpecGenerator | |||
There was a problem hiding this comment.
This class gets bigger and bigger. Looks like it needs some refactoring.
|
@mscheong01 I want to inform you of this change as you added the |
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.
Motivation:
There is a bug in
protocthat always adds json_name to the descriptor. protocolbuffers/protobuf#5587This happens by default when compiling proto files in Bazel. To mitigate this bug, I propose to add
HttpJsonTranscodingQueryParamMatchRule.JSON_NAMEto decide whether to use or ignore json_name when matching query params.Modifications:
HttpJsonTranscodingQueryParamMatchRule.JSON_NAMEjson_namefield option is used to match query parameters.ORIGINAL_FIELDorLOWER_CAMEL_CASE[ORIGINAL_FIELD, JSON_NAME]. the json_name is used only when there is no matching original field.HttpJsonTranscodingQueryParamMatchRule.JSON_NAMEis explicitly specified viaHttpJsonTranscodingOptionsBuilder.queryParamMatchRules(). By default,JSON_NAMEis set.Result:
Fixes JSON transcoding has backwards incompatible change in 1.27.0, due to json_name field always populated by protoc #5890
You can now choose whether to use the
json_namefield option when transcoding HTTP/JSON to gRPC messages.