Prevent bad list, set, map recursion #204
Merged
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.
We currently don't allow a directly recursive list or set shape.
However, we still allow for list, set, and map shapes to be
transitively recursive unconditionally (e.g., listA -> listA is invalid,
but listA -> set -> listA is valid). This is problematic for code
generators in various languages that want to use parameteric types and
standard libraries to codegen lists, sets, and maps. For example, in
Java, a list in Smithy should be generated as a
List<X>
where X isthe code generated member of the list. However, if the list is recursive
onto itself, then it's impossible to generate valid code (e.g.,
List<List<List...
).This change requires that recursive list, set, and map shapes must have
one or more structure or union members in their recursive path in order to
define a valid shape. This will result in shapes that are far easier to
generate and provides constraints that are very helpful when converting
to other formats (for example, this might be useful in JSON schema
conversions if we want to always inline list and set shape definitions).
This change should not have a practical impact on models since no
current AWS service defines an unconditionally recursive list, set,
or map shape.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.