Return more specific errors from URI validation #11
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
In testing a resolver update in an app that users this library, we're getting error messages like, ``` BadUri "https://sns.us-east-1.amazonaws.com/SimpleNotificationService-60eadc530605d63b8e62a523676ef735.pem" ``` This looks entirely valid to me, but the library currently returns `BadUri` for 3 distinct validations, so breaking them up might help be realize what's going on. Hopefully.
| mDomain = uriRegName <$> uriAuthority uri | ||
|
|
||
| unless (scheme == validScheme) $ throwE $ BadScheme scheme | ||
| domain <- fromMaybeM (throwE $ NoAuthority certUrlStr) mDomain |
There was a problem hiding this comment.
I appreciate being explicit about this and no longer just tacitly relying on the hope that "" will not satisfy validRegPattern
Comment on lines
154
to
156
| | BadScheme String | ||
| | NoAuthority String | ||
| | BadDomain String |
There was a problem hiding this comment.
Might it be even better to debug if BadScheme also included the value of validScheme and BadDomain included validRegPattern to make sure these values are what you think they are?
There was a problem hiding this comment.
Yes absolutely. In hindsight, now knowing what my bug actually was, that would've resulted in an error like,
Bad domain, aws.blah.com. Expected to match "^localhost$"
(Assuming I made a nicer displayException.)
Which would've immediately showed me the issue.
chris-martin
approved these changes
May 30, 2024
I don't need to release this at the moment, and don't plan to. Since that's the case, I want to note it in the Unreleased section explicitly so it's noticed the next time we do a release.
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.
In testing a resolver update in an app that uses this library, we're
getting error messages like,
This looks entirely valid to me, but the library currently returns
BadUrifor 3 distinct validations, so breaking them up might help merealize what's going on. Hopefully.