Return template parameters in consistent order #2975
Merged
Conversation
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
kylecarbs
approved these changes
Jul 13, 2022
Comment on lines
+26
to
+33
| // Sort variables by (filename, line) to make the ordering consistent | ||
| variables := make([]*tfconfig.Variable, 0, len(module.Variables)) | ||
| for _, v := range module.Variables { | ||
| variables = append(variables, v) | ||
| } | ||
| sort.Slice(variables, func(i, j int) bool { | ||
| return compareSourcePos(variables[i].Pos, variables[j].Pos) | ||
| }) |
There was a problem hiding this comment.
This is pretty cool. It's awesome that customers will be able to control the order that variables display in the UI 👀
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 makes the order in which we display and prompt for template parameters deterministic and consistent. It involves two different functional changes:
ParameterSchemamessages to match the order of theirvariableblocks in the template source (first lexicographically by filename, then by line number)parameter_schemas.indexdatabase column, and sorts by that column when querying for parametersFor template versions that existed prior to this change, the database migration initializes the index column by putting the variable names for each version in lexicographic order, since we don't know the original source order.
Fixes #2471