[cli] Show rich diffs for JSON/YAML objects/arrays #9380
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 displaying a diff between textual values, first try to decode the old and new values as JSON and YAML. If both values decode successfully, render the diff between the decoded values rather than the diff between the text. Fixes #5831.
|
I have one reservation about this change as currently written, which is that the kind of diff observed by the object diff may not match the kind of diff observed by the textual diff. It feels like this will be most confusing for providers that are themselves diffing these properties as text. In that case, it is possible for the provider to indicate that a property has changed while the renderer will show it as an update with no actual changes to the value. In these cases, we could opt to continue rendering the textual diff--thoughts? |
AaronFriel
approved these changes
Apr 13, 2022
bors bot
added a commit
that referenced
this pull request
Jan 18, 2023
11803: Display text-based diff if yaml/json diff is semantically equal r=aq17 a=aq17 Fixes #11799 #9380 and #9484 introduced changes that render JSON/YAML parsable strings as objects in diffs – therefore, examples such as`"foo:\n bar: {}\n baz: {}\n"` and `"#foo\nfoo:\n bar: {}\n baz: {}\n"` are recognized as equal. This change causes the display to fall back to showing the text-based diff if the JSON/YAML rendering does not indicate any diff. It also prints all object keys even if the value is empty, i.e. `bar: {}` or `bar: ""` will be printed instead of `bar` being omitted. Co-authored-by: aq17 <aqiu@pulumi.com>
bors bot
added a commit
that referenced
this pull request
Jan 19, 2023
11803: Display text-based diff if yaml/json diff is semantically equal r=aq17 a=aq17 Fixes #11799 #9380 and #9484 introduced changes that render JSON/YAML parsable strings as objects in diffs – therefore, examples such as`"foo:\n bar: {}\n baz: {}\n"` and `"#foo\nfoo:\n bar: {}\n baz: {}\n"` are recognized as equal. This change causes the display to fall back to showing the text-based diff if the JSON/YAML rendering does not indicate any diff. It also prints all object keys even if the value is empty, i.e. `bar: {}` or `bar: ""` will be printed instead of `bar` being omitted. Co-authored-by: aq17 <aqiu@pulumi.com>
bors bot
added a commit
that referenced
this pull request
Jan 19, 2023
11803: Display text-based diff if yaml/json diff is semantically equal r=aq17 a=aq17 Fixes #11799 #9380 and #9484 introduced changes that render JSON/YAML parsable strings as objects in diffs – therefore, examples such as`"foo:\n bar: {}\n baz: {}\n"` and `"#foo\nfoo:\n bar: {}\n baz: {}\n"` are recognized as equal. This change causes the display to fall back to showing the text-based diff if the JSON/YAML rendering does not indicate any diff. It also prints all object keys even if the value is empty, i.e. `bar: {}` or `bar: ""` will be printed instead of `bar` being omitted. Co-authored-by: aq17 <aqiu@pulumi.com>
bors bot
added a commit
that referenced
this pull request
Jan 19, 2023
11803: Display text-based diff if yaml/json diff is semantically equal r=aq17 a=aq17 Fixes #11799 #9380 and #9484 introduced changes that render JSON/YAML parsable strings as objects in diffs – therefore, examples such as`"foo:\n bar: {}\n baz: {}\n"` and `"#foo\nfoo:\n bar: {}\n baz: {}\n"` are recognized as equal. This change causes the display to fall back to showing the text-based diff if the JSON/YAML rendering does not indicate any diff. It also prints all object keys even if the value is empty, i.e. `bar: {}` or `bar: ""` will be printed instead of `bar` being omitted. 11893: update package details anchors r=sean1588 a=sean1588 fixes: pulumi/registry#1819 OK taking this for round 2. The first [PR](#11861) to make this change I ended up reverting because there were some pages (the function pages and module pages) still being generated with empty href tags. I have addressed this and updated the change to define the DisplayName and RepositoryName props on the `packageDetails` struct for the individual module pages and function pages. This updates the repository anchor in the Package Details section of the api docs pages. I updated it to display `<package name> repository` for the anchor text in place of the url that was previously shown there.  So now this will show the following on the following pages: 1. the root index package pages 2. the module pages 3. the resource pages 4. the function pages 11903: ApplyT: Coerce new type wrappers r=abhinav a=abhinav Adds support to ApplyT to automatically coerce new type wrappers when calling the provided functions. With this change, the following is valid: var idout pu.IDOutput = ... idout.ApplyT(func(id string) string { // ... }) Note that this does not use `To{Type}Output` methods at this time. We will likely want to add that in the future given #11750. We can do that in a backwards compatible way. This coerces only those values that are defined with language-level type wrappers in the following form: type ID string This *does not* coerce types with different undedrlying representations. Specifically, the following conversons are not supported even though they're supported by Go using the `T(v)` syntax. string => int string => []byte []byte => string The choice to convert between these types should be made explicitly by the user so that they get the semantics they want. Resolves #11784 11922: ci: freeze 3.52.1 for release r=dixler a=dixler Patch release to provide better stack traces for python #11887 Co-authored-by: aq17 <aqiu@pulumi.com> Co-authored-by: Sean Holung <sean.holung@gmail.com> Co-authored-by: Robbie McKinstry <robbie@pulumi.com> Co-authored-by: Abhinav Gupta <abhinav@pulumi.com> Co-authored-by: Kyle Dixler <kyle@pulumi.com>
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.
When displaying a diff between textual values, first try to decode the
old and new values as JSON and YAML. If both values decode successfully,
render the diff between the decoded values rather than the diff between
the text.
Fixes #5831.