Proto file option to preserve original field order during encoding#1658
Open
theorm wants to merge 3 commits into
Open
Proto file option to preserve original field order during encoding#1658theorm wants to merge 3 commits into
theorm wants to merge 3 commits into
Conversation
Contributor
|
I just wanted to note that the requirement to emit the fields in any particular order violates the protobuf spec that says:
|
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
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.
Protobuf.js
encodemethod always sorts fields by their ID before writing a message to a byte array. However in some cases it may be necessary to tell protobuf.js to use the original order of the fields as it was defined in the.protofile. In my case protobuf.js had to be integrated with a legacy platform that uses original field order, and protobuf.js had to produce the same base64-encoded strings as the platform.This pull request introduces a
.protofile wide custom optionpbjs_encoder_field_orderwhich, if set toORIGINAL, instructs the encoder to keep the original order of the fields.