JSON serialization of default value for fields with explicit presence #238
Conversation
This file contains hidden or 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
antongrbin
commented
Oct 25, 2022
| assertEquals(JsonPrimitive(TestAllTypesProto3.NestedEnum.fromValue(0).name!!), parsedJson["optionalNestedEnum"]) | ||
|
|
||
| assertEquals(JsonNull, parsedJson["optionalNestedMessage"]) | ||
| assertFalse("optionalNestedMessage" in parsedJson) |
Contributor
Author
There was a problem hiding this comment.
I looked deeper into this, please see explanation in PR description about this.
This was referenced Oct 25, 2022
garyp
reviewed
Oct 25, 2022
|
|
||
| if (value == null && fd.oneofMember) continue | ||
| if (!fd.oneofMember && !jsonConfig.outputDefaultValues && fd.type.isDefaultValue(value)) continue | ||
| val oneOfOrExplicitPresence = (fd.oneofMember || fd.type.hasPresence) |
Collaborator
There was a problem hiding this comment.
If I remember right, I think fd.type.hasPresence will always be true for oneof fields. So you might be able to simplify this and only test for fd.type.hasPresence and drop the explicit test for fd.oneofMember.
Contributor
Author
There was a problem hiding this comment.
I applied the change, thank you. The tests that we have still pass.
I tried quickly to trace where hasPresence is being set for oneOf fields but I couldn't find it easily :) I would appreciate a pointer so I can better understand what I'm doing :)
Collaborator
There was a problem hiding this comment.
hasPresence in the generated code is set here:
File.Field.Numbered.hasPresence, which is set here during the parsing of the proto files:
. That's where the oneof-related logic is coming from.
garyp
approved these changes
Oct 25, 2022
garyp
pushed a commit
that referenced
this pull request
Mar 7, 2023
…#238) Fixes #235 * Change the behavior for JSON serialization for fields with explicit presence. * If unset -> don't emit on the wire. * If set -> emit on the wire, even if the value is default (regardless of the `jsonConfig.outputDefaultValues`) This is consistent with the following: https://github.com/protocolbuffers/protobuf/blob/main/docs/field_presence.md#semantic-differences This PR also changes behavior of `outputDefaultValues` for unset nested message fields. Before we were outputting `null` and now we don't output any value. This is consistent with c++, python and java, as explained here: noom/protobuf#5 Run all unit tests in `runtime`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Fixes #235
Changes
jsonConfig.outputDefaultValues)This is consistent with the following:
https://github.com/protocolbuffers/protobuf/blob/main/docs/field_presence.md#semantic-differences
This PR also changes behavior of
outputDefaultValuesfor unset nested message fields. Before we were outputtingnulland now we don't output any value. This is consistent with c++, python and java, as explained here: noom/protobuf#5Tested
Run all unit tests in
runtime