Log invalid JSON environment #2000
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
vinistock
added
enhancement
st0012
approved these changes
May 1, 2024
andyw8
approved these changes
May 2, 2024
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.
Motivation
When something goes wrong with a version manager and they produce an invalid environment JSON, it's hard to debug or understand what's going on. We should log what string we tried to parse so that we can more easily diagnose issues.
Implementation
Created a
parseWithErrorHandlinghelper in theVersionManagerparent class, which tries to parse and logs the error if that fails. Then started using it in all version managers.Automated Tests
Added a test for
rbenvonly because the behaviour is the same on all other managers.