fix(core): input validation for module templates #4995
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
thsig
force-pushed
the
module-template-default-value-validation-fix
branch
from
b6fd177
to
c86ffe8
Compare
Before this fix, we weren't performing a partial resolution pass on module template inputs before validating them against the input schema. This would result in validation errors e.g. when the schema declares a boolean field but the unresolved template is still a string value.
thsig
force-pushed
the
module-template-default-value-validation-fix
branch
from
c86ffe8
to
8ea8be1
Compare
|
Btw, thanks @shumailxyz for the excellent repro you posted on the issue! |
shumailxyz
reviewed
Aug 29, 2023
Comment on lines
+104
to
107
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
There was a problem hiding this comment.
Ah took me a while to realize that this whole diff is basically just nesting these tests under the ModuleResolver describe block.
shumailxyz
approved these changes
Aug 29, 2023
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 this PR does / why we need it:
Before this fix, we weren't performing a partial resolution pass on module template inputs before validating them against the input schema. This looks like it was a simple oversight (there's definitely no point in partially resolving an always-empty object).
This would result in validation errors e.g. when the schema declares a boolean field but the unresolved template is still a string value.
Which issue(s) this PR fixes:
Fixes #4946.
Special notes for your reviewer:
While looking at the code around input resolution and validation, I noticed that we never apply the input schema (as defined in e.g.
schema.json) against the fully resolved inputs.It looks like the idea here is to allow the user to pass through template strings that reference e.g. runtime values, which get resolved later in the flow.
If that's the case, then this may cause some surprising behaviour, since a template string for an input value that's supposed to resolve e.g. to a number or a boolean will fail validation because it's still a (template) string. CC @edvald
If this is the way we intend it to be, we should mention this wrinkle in our guide for config templates.