fix(cfnspec): incorrectly handling array result from jsondiff #23795
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
|
|
aws-cdk-automation
previously requested changes
Jan 23, 2023
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
kaizencc
added
pr-linter/exempt-test
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.
comcalvi
approved these changes
Jan 23, 2023
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
@Mergifyio backport v1-main |
✅ Backports have been created
|
mergify bot
pushed a commit
that referenced
this pull request
Jan 23, 2023
We are getting an error when updating the cfnspec: ```bash Error: Unexpected array diff entry: [" "] ``` We are using `json-diff` to calculate diff entries, and expect that each entry is a 2-tuple array. Indeed, the [docs](https://github.com/andreyvit/json-diff#arrays) say this. Turns out, this is only true when supplying the `--full` option. With `--full`, the output for equivalent entries is `[' ', 1]`. Without `--full`, the output for equivalent entries is `[' ']`. I considered that this might be a bug/breaking change in `json-diff`, but I did some spelunking and this is behavior that is codified in tests that haven't been changed in 11 years: https://github.com/andreyvit/json-diff/blob/35582a9d19f8b0b2773360d67937e57ce2866781/test/diff_test.coffee#L78 More likely, we were relying on an implicit default to `--full` that is now turned off, or we have never come across such an issue before (which feels unlikely). I don't think we actually want `--full`, because we want the difference and that's it. So I've instead handled this case that should be a one-off case. I have run the update on my own machine and confirm it works as expected, and the output in `CHANGELOG.md` is correct. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* (cherry picked from commit 4a701f1)
mergify bot
added a commit
that referenced
this pull request
Jan 24, 2023
#23795) (#23800) This is an automatic backport of pull request #23795 done by [Mergify](https://mergify.com). --- <details> <summary>Mergify commands and options</summary> <br /> More conditions and actions can be found in the [documentation](https://docs.mergify.com/). You can also trigger Mergify actions by commenting on this pull request: - `@Mergifyio refresh` will re-evaluate the rules - `@Mergifyio rebase` will rebase this PR on its base branch - `@Mergifyio update` will merge the base branch into this PR - `@Mergifyio backport <destination>` will backport this PR on `<destination>` branch Additionally, on Mergify [dashboard](https://dashboard.mergify.com/) you can: - look at your merge queues - generate the Mergify configuration with the config editor. Finally, you can contact us on https://mergify.com </details>
This was referenced Mar 31, 2023
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.
We are getting an error when updating the cfnspec:
Error: Unexpected array diff entry: [" "]We are using
json-diffto calculate diff entries, and expect that each entry is a 2-tuple array. Indeed, the docs say this. Turns out, this is only true when supplying the--fulloption.With
--full, the output for equivalent entries is[' ', 1]. Without--full, the output for equivalent entries is[' '].I considered that this might be a bug/breaking change in
json-diff, but I did some spelunking and this is behavior that is codified in tests that haven't been changed in 11 years: https://github.com/andreyvit/json-diff/blob/35582a9d19f8b0b2773360d67937e57ce2866781/test/diff_test.coffee#L78More likely, we were relying on an implicit default to
--fullthat is now turned off, or we have never come across such an issue before (which feels unlikely). I don't think we actually want--full, because we want the difference and that's it. So I've instead handled this case that should be a one-off case.I have run the update on my own machine and confirm it works as expected, and the output in
CHANGELOG.mdis correct.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license