fix: validate shouldn't throw
#244
Closed
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
`validate`'s interface was inconsistent. Sometimes, it would `throw` an error; sometimes, it would return `false`. This makes it consistent: always return a boolean. I discovered this when I noticed that a test wasn't passing the right arguments to `validate`. When I fixed it, I got test failures. (You could argue that this should work the other way: it should throw instead of returning a boolean. But that's a bigger breaking change.)
gmaclennan
requested changes
Sep 4, 2024
There was a problem hiding this comment.
hmm... I actually think throwing when you pass invalid function parameters (e.g. parameters that do not type-check) is ok behaviour. It's not actually validating anything in this case, so an error is expected. We don't generally do assertions in addition to type checks, but I'm ok with adding adding a more explicit error here like "invalid schema name". I think maybe it's the test that needs updating, with two flows: one for a valid schema name (returns false), and one for an invalid schema name (throws)
|
Closing in favor of #249. |
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.
validate's interface was inconsistent. Sometimes, it wouldthrowan error; sometimes, it would returnfalse. This makes it consistent: always return a boolean.I discovered this when I noticed that a test wasn't passing the right arguments to
validate. When I fixed it, I got test failures.(You could argue that this should work the other way: it should throw instead of returning a boolean. But that's a bigger breaking change.)