🪟 🎉 Add yaml validation to Connector Builder and disable buttons when invalid #19001
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
This reverts commit decf6d6.
github-actions
bot
added
area/platform
lmossman
commented
Nov 5, 2022
| setYamlIsValid(false); | ||
| const mark = err.mark; | ||
| if (yamlEditorModel) { | ||
| monaco.editor.setModelMarkers(yamlEditorModel, errOwner, [ |
There was a problem hiding this comment.
One small issue with this is that the error display doesn't really match the current editor theme (it is grey instead of blue). I'm not exactly sure how to customize the theme of those error windows
timroes
reviewed
Nov 7, 2022
| useEffect(() => { | ||
| if (monaco && yamlEditorRef.current && yamlValue) { | ||
| const errOwner = "yaml"; | ||
| console.log(yamlValue); |
There was a problem hiding this comment.
Are we planning to keep the console.log in production on purpose or is this a leftover?
There was a problem hiding this comment.
Sorry that was a leftover, I will remove!
timroes
approved these changes
Nov 8, 2022
Base automatically changed from
lmossman/connector-builder-logs-viewer
to
master
November 8, 2022 23:21
akashkulk
pushed a commit
that referenced
this pull request
Dec 2, 2022
… invalid (#19001) * change splitter to be single bar, and rename props * add logs viewer to testing panel * make log display height 100% * remove comment * clean up some styling, and add record count to tab title * cleanup + only render paginator and slice selector when necessary * move selected slice/page state into context and fix bug with state between streams * fix tab keys * pull LogsDisplay out into its own component to simplify ResultDisplay * simplify ResultDisplay prop * add yaml validation and error marking logic to yaml editor * generify YamlEditor * Revert "generify YamlEditor" This reverts commit decf6d6. * disable download and test buttons while yaml is invalid * remove console log and add comments
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.
What
Resolves #18918
This PR adds logic to detect when the content of the yaml editor in the Connector Builder is invalid, and if so disables the Download and Test buttons.
Screenshot of what this looks like:
How
This PR achieves the above by making a few changes:
Recommended reading order
YamlEditor.tsx- most of the new yaml validation / error marking logic borrowed from here🚨 User Impact 🚨
Users will now have a better understanding of why their yaml is invalid in the connector builder, and will be unable to perform actions that wouldn't make sense to do anyway when invalid.