fix(kernel): validate presence of required struct properties #591
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
Detect when required struct properties are not supplied, so that we can produce useful error messages to untyped jsii languages (in particular, Python). Also check for an array in place of a variadic argument, and throw a hopefully helpful message to hint at a common misuse. Fix the test to be actually variadic, which it wasn't :o.
eladb
reviewed
Jul 8, 2019
| const namedType = host.lookupType((optionalValue.type as spec.NamedTypeReference).fqn); | ||
| const props = propertiesOf(namedType, host.lookupType); | ||
|
|
||
| if (Array.isArray(value)) { |
There was a problem hiding this comment.
Wouldn't it make more sense to verify that the type is the expected type instead of what it is not. What if it's a map for example or a primitive?
There was a problem hiding this comment.
A map is actually correct, that's what a struct is (or should be), and we do already check that a primitive is not passed.
We just missed the Array because of the fact that typeof array === 'object' in JavaScript.
By doing the explicit check we also get a nicer error message.
RomainMuller
approved these changes
Jul 10, 2019
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.
Detect when required struct properties are not supplied, so that
we can produce useful error messages to untyped jsii languages (in
particular, Python).
Also check for an array in place of a variadic argument, and throw
a hopefully helpful message to hint at a common misuse.
Fix the test to be actually variadic, which it wasn't :o.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.