structured run output: impose canonical ordering on jsonstate and jsonplan packages #32649
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
liamcervante
force-pushed
the
liamcervante/json-changes-ordering
branch
from
26cd87e
to
fe285de
Compare
liamcervante
added
the
1.4-backport
jbardin
approved these changes
Feb 9, 2023
|
Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch. |
kmoe
pushed a commit
to kmoe/terraform
that referenced
this pull request
Mar 1, 2023
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 is a follow up from a comment left by @apparentlymart on an earlier PR: #32629 (comment)
This PR imposes the "canonical" ordering of addresses on the jsonplan and jsonstate generation packages, so the produced JSON will be ordered according to the
Lessfunctions in theaddrspackage. With this change, the jsonformat package that produces the human readable output from the JSON state and plan outputs does not need to worry about ordering at all as they can simply trust the ordering in the json structures.I'd be quite happy to close this PR without merging if we don't want to change the public API of the JSON outputs, or I could update the 1.4 changelog with something about the ordering being fixed. I just think if we want to use some kind of canonical ordering it makes sense to do it here, instead of having to convert addresses back into the internal structs after we've already converted them into strings for JSON.