fix: make yamlToDict give useful information instead of error in invalid config, fixes #5385 #5425
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
|
Download the artifacts for this pull request:
See Testing a PR |
rfay
commented
Oct 16, 2023
stasadev
approved these changes
Oct 16, 2023
There was a problem hiding this comment.
Before: unable to install add-on.
$ ddev get ddev/ddev-redis
Installing ddev/ddev-redis:v1.1.1
Downloading https://api.github.com/repos/ddev/ddev-redis/tarball/v1.1.1
v1.1.1_3526992483.tar.gz 8.06 KiB / ? [---------=------------------] 82.55% 0s
Unable to YamlToDict: yamlToDict: type string not handled (hooks)
After: there is a warning about config, and add-on is installed.
$ ddev get ddev/ddev-redis
Installing ddev/ddev-redis:v1.1.1
Downloading https://api.github.com/repos/ddev/ddev-redis/tarball/v1.1.1
v1.1.1_2471001777.tar.gz 8.06 KiB / 8.06 KiB [======================] 100.00% 0s
Configuration has invalid type '<nil>' for 'hooks'
...
Installed redis:v1.1.1 from ddev/ddev-redis
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.
The Issue
Invalid config, especially in .ddev/config.yaml (but could happen in global_config.yaml, and might happen in customer-provided yaml) was resulting in an incomprehensible message "Unable to YamlToDict: yamlToDict: type string not handled (post-start)"
How This PR Solves The Issue
Be more generous and just ignore and warn about the invalid yaml
Manual Testing Instructions
There are examples of config that causes the problem in #5385
and
Use these in .ddev/config.yaml and see the results.
Also we can expect that a well-formed config.yaml doesn't cause trouble.
Automated Testing Overview
No changes