Improve error messages on invalid YAML nodes#612
Merged
Conversation
🦋 Changeset detectedLatest commit: 381894c The changes in this PR will be included in the next version bump. This PR includes changesets to release 18 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
rkistner
approved these changes
Apr 22, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In a few places in
SyncConfigFromYaml, we use unsafe TypeScript casts trusting that nodes we expect to be yaml scalars are of the correct type.When a node that isn't a scalar (e.g. a
YamlSeqor aYamlMap) is used there, we still calltoString()and try to parse it as SQL.toString()returns a JSON array/object in that case though, causing us to report absurd parser errors. This adds a check to actually verify that we're dealing with scalars, and reports an error message at the appropriate location if that's not the case.Additionally, this skips the schema validation run if there we uncovered fatal errors. This reduces duplicate warnings now that we check most node types directly. It's not ideal because it means that fixing an error could cause us to report additional ones (e.g. if there's a syntax error in SQL and an additional property), but I think this is still an improvement for most cases. An ideal solution would probably be to handwrite a specialized schema check reporting errors with yaml nodes.