Move EvaluateArguments context variables to end of enums#346
Merged
connor4312 merged 1 commit intomicrosoft:mainfrom Nov 8, 2022
Merged
Move EvaluateArguments context variables to end of enums#346connor4312 merged 1 commit intomicrosoft:mainfrom
connor4312 merged 1 commit intomicrosoft:mainfrom
Conversation
This PR moves the newly added 'variables' enum for EvaluateArguments context to be added at the end instead of at the start of the array. Reordering the parameters is breaking change for downstream generators.
Member
|
This seems fine but can you tell me more about what it breaks? |
|
The C# code generator that we own generates strongly typed enums to represent the enums in the protocol. Adding a new item to one of these enums other than at the end causes the underlying values of the previous enum values to change, that is: becomes I don't think this is an issue for the TypeScript generator, since it uses union types for this instead of enums, but it breaks backwards compatibility between different versions of our protocol library. |
roblourens
approved these changes
Nov 7, 2022
Member
|
I think depending on the order of enum types, which are effectively a Set, is a little questionable, but I'm fine taking this fix |
connor4312
approved these changes
Nov 8, 2022
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
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.
This PR moves the newly added 'variables' enum for EvaluateArguments context from 87fdf65 to be added at the end instead of at the start of the array.
Reordering the parameters is breaking change for downstream generators.
cc @andrewcrawley