Update ShardID to start with 1 instead of 0 #633
Merged
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
ShardID is passed in as a field for multiple protobuf messages. We have created a guideline to not use 0 as a valid value for protobuf field in a message. Previously we used 0 as a valid ShardID which makes it impossible to differentiate between ShardID field as not set versus caller specifically passing in 0. This change forces ShardID to start with 1 instead of 0 for implementation to validate if ShardID is not passed in where it is a required field.
shawnhathaway
approved these changes
Jul 30, 2020
Closed
…oral into shard-id-to-start-from-1
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.
What changed?
This change forces ShardID to start with 1 instead of 0 for
implementation to validate if ShardID is not passed in where
it is a required field.
Why?
ShardID is passed in as a field for multiple protobuf messages. We
have created a guideline to not use 0 as a valid value for protobuf
field in a message.
Previously we used 0 as a valid ShardID which makes it impossible to
differentiate between ShardID field as not set versus caller
specifically passing in 0.
How did you test it?
Unit and Integration tests
Potential risks
This could potential cause issues with shard unavailability