feat: add validation for immutable fields #180
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
DavyJ0nes
commented
Oct 13, 2022
| @@ -27,6 +41,12 @@ func TestCopyFields(t *testing.T) { | |||
| }) | |||
| } | |||
|
|
|||
| func TestValidateRequiredFields(t *testing.T) { | |||
There was a problem hiding this comment.
moved this down from higher in file to have test cases in alpha order 😅
DavyJ0nes
force-pushed
the
feat-add-validation-for-required-fields
branch
from
cfe8a76
to
a2f4b39
Compare
odsod
reviewed
Oct 13, 2022
fieldbehavior/fieldbehavior_test.go
Outdated
| CreateTime: timestamppb.Now(), // has OUTPUT_ONLY field_behavior; should be cleared. | ||
| DisplayName: "site one", // has REQUIRED field_behavior; should not be cleared. | ||
| } | ||
|
|
There was a problem hiding this comment.
IMO one t.Run should be readable as one paragraph, i.e. blank lines between t.Runs but not within
odsod
reviewed
Oct 13, 2022
fieldbehavior/immutable.go
Outdated
| return Has(field, annotations.FieldBehavior_IMMUTABLE) | ||
| } | ||
|
|
||
| func isSetOnWire(m protoreflect.Message, field protoreflect.FieldDescriptor) bool { |
There was a problem hiding this comment.
is this just an alias for protoreflect.Message.Has? IMO better to stick to the original API even if the naming is not perfect
There was a problem hiding this comment.
Yeah, I added it make the conditional easier to skim read but am ok to revert.
odsod
approved these changes
Oct 13, 2022
DavyJ0nes
force-pushed
the
feat-add-validation-for-required-fields
branch
from
a2f4b39
to
1ebc6cb
Compare
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.
Within the Field Behavior AIP there is guidance on how to handle the
IMMUTABLEfield behavior, suggesting that:This PR introduces a new validation function
fieldbehavior.ValidateImmutableFieldsWithMaskto help service owners implement this suggestion and can return anINVALID_ARGUEMNTif it makes sense for their service.It is heavily influenced by
fieldbehavior.ValidateImmutableFieldsWithMaskand copies some of that code but I felt it was more readable to copy and paste rather than having a generic implementation for both uses.As the recommendations are should and not must I didn't feel like this library should be too opinionated and error on the
fieldmask.Updatefunction.I also updated some of the comments and added a simple test for
fieldbehavior.ClearFields().