Add validator for xmlFlattened + xmlName #2439
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
Adds a validator for the xmlFlattened trait that checks if the member's target is a list that has a member with xmlName, and that xmlName doesn't match the name of the xmlFlattened member. xmlFlattened causes the xmlName of the list member to be ignored. This is called out in our docs: https://smithy.io/2.0/spec/protocol-traits.html#flattened-list-serialization, but we were missing a validator for it. It is a warning because you might mean to do this, i.e. if the list is used in multiple places. I also added some suppressions to our protocol tests that are testing the behavior for models that would trip up this validator.
kstich
reviewed
Nov 1, 2024
| @@ -1,5 +1,15 @@ | |||
| $version: "2.0" | |||
|
|
|||
| metadata suppressions = [ | |||
There was a problem hiding this comment.
Is it prohibitive to use the @suppress trait instead of a metadata suppression? It's a nice bit of documentation on that specific member as well that it's intending to test the behavior.
Comment on lines
34
to
37
| model.getShape(member.getTarget()) | ||
| .flatMap(Shape::asListShape) | ||
| .flatMap(listShape -> validateMemberTargetingList(member, listShape)) | ||
| .ifPresent(events::add); |
There was a problem hiding this comment.
IMO reading this as a stream is harder than just reading ifs since we know the member target should exist.
Shape target = model.expectShape(member.getTarget());
if (target.isListShape()) {
validateMemberTargetListing(member, targetList).ifPresent(events::add);
}
There was a problem hiding this comment.
True I forgot we run that type of validation first, so we can expect the member target to exist.
kstich
approved these changes
Nov 11, 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.
Adds a validator for the xmlFlattened trait that checks if the member's target is a list that has a member with xmlName, and that xmlName doesn't match the name of the xmlFlattened member. xmlFlattened causes the xmlName of the list member to be ignored. This is called out in our docs:
https://smithy.io/2.0/spec/protocol-traits.html#flattened-list-serialization, but we were missing a validator for it. It is a warning because you might mean to do this, i.e. if the list is used in multiple places.
I also added some suppressions to our protocol tests that are testing the behavior for models that would trip up this validator.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.