Add support new TextFormat group decoding support #1624
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
The `message_encoding = DELIMITED` feature in Editions maps the field to be a "group" however there is/was a grey space in what the the "field name" should be for TextFormat, it was using the message's name from the group but if one does an editions file with `DELIMITED` encoding on a field we get into an edge case of what exactly should the naming for TextFormat be. Upstream has address this by supporting both the message name or the field name when decoding TextFormat but keeping the existing encoding behavior. The intent appears to be the 2024 Edition will get a new feature to explicitly spec all this and thus avoid the "group like" sport this all keys off of now. The "best" way to handle this would probably be to add a new case to the enum used for the `_NameTable` that indicates when we need to decode the two forms of the field name; however, that would be a breaking change (we'd also have to rev the `ProtobufAPIVersionCheck` to go with it). Instead, we rely on the fact that the name entries are adding to the internal mappings in the `_NameTable` in order, so we output an alternate form first, and then the preferred (existing) name second, so the decoding mapping with have both forms of the protobuf name but then encoding will have the preferred as the overriding value and continue to use that.
allevato
approved these changes
Apr 10, 2024
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.
The
message_encoding = DELIMITEDfeature in Editions maps the field to be a "group" however there is/was a grey space in what the the "field name" should be for TextFormat, it was using the message's name from the group but if one does an editions file withDELIMITEDencoding on a field we get into an edge case of what exactly should the naming for TextFormat be. Upstream has address this by supporting both the message name or the field name when decoding TextFormat but keeping the existing encoding behavior. The intent appears to be the 2024 Edition will get a new feature to explicitly spec all this and thus avoid the "group like" sport this all keys off of now.