Flag enum insertions as errors #873
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
When calculating Smithy diffs, enum value insertions should be flagged as errors because they can cause backwards incompatibility concerns when enum ordinals are used for iterating, serialization, etc. Enum values appended to the end of the existing set of values should not be errors.
ianbotsf
requested review from
JordonPhillips,
kstich and
mtdowling
as code owners
mtdowling
requested changes
Jul 30, 2021
| * enum value is removed, and emits an ERROR when an enum name changes. | ||
| * Emits a NOTE when a new enum value is appended, emits an ERROR when an | ||
| * enum value is removed, emits an ERROR when an enum name changes, and | ||
| * emits an ERROR when a new enum value is inserted. |
There was a problem hiding this comment.
Throughout this PR, can we be more specific about what inserted means? We mean that an enum value was added but not at the end of the list of enum values. I think clarifying with this little tweak will save countless hours of teams not understanding the error.
| "Enum value `%s` was added", definition.getValue()))); | ||
| if (newPosition <= oldEndPosition) { | ||
| events.add(error(change.getNewShape(), String.format( | ||
| "Enum value `%s` was inserted. This can cause compatibility issues when ordinal values are " |
There was a problem hiding this comment.
I love the extra bit of context here about why this matters! Can you say something like "Enum value %s was inserted, but not at the end of the list of existing enum values. [...]" or something to that effect?
…ist of existing values'
mtdowling
approved these changes
Jul 31, 2021
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.
Issue #, if available:
(none)
Description of changes:
When calculating Smithy diffs, enum value insertions should be flagged as errors because they can cause backwards incompatibility concerns when enum ordinals are used for iterating, serialization, etc. Enum values appended to the end of the existing set of values should not be errors.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.