Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(cfnspec): incorrectly handling array result from jsondiff (backport #23795) #23800

Merged
merged 1 commit into from
Jan 24, 2023

Commits on Jan 23, 2023

  1. fix(cfnspec): incorrectly handling array result from jsondiff (#23795)

    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)
    kaizencc authored and mergify[bot] committed Jan 23, 2023
    Configuration menu
    Copy the full SHA
    b1b8fb7 View commit details
    Browse the repository at this point in the history