feat: add concrete errors to public API #36
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
This commit adds four concrete errors to the public API and ensures that all returned errors are either instances of those concrete types OR are wrapped by more descriptive errors. The four error types are: 1. ClientError: for all errors that are the result of the client making semantic error in their request 2. ServerError: for all the (uncommon) cases where the server returns data that is somehow and unexpectedly invalid. 3. APIError: for any errors that occurs when interacting with the SQL Admin API. These errors wrap the underlying google.golang.org/api/googleapi.Error types. 4. DialError: for any error that occurs when attempting to connect to a particular SQL instance. By providing concrete errors or wrapping concrete errors, we allow our clients to uses the errors.As API to possibly react differently to errors coming out of the dialer.
kurtisvg
suggested changes
Aug 9, 2021
There was a problem hiding this comment.
High level thoughts:
DialError seems good. Should there be a high level error to capture anything during a refresh (e.g. RefreshError)? It seems like it might be useful between differentiating "the dial didn't' work" and "this refresh operation wasn't successful".
I'm not sure I understand why APIError and ServerError are two different error types. Do I really care if the API returned a non 2xx code vs a bad response (or a response I couldn't parse)? Seems like differentiating isn't useful.
Also, use initializers everywhere for errors.
|
I've consolidated |
|
Could |
|
RefreshError seems better than ServerError |
kurtisvg
approved these changes
Aug 12, 2021
Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
This was referenced Apr 5, 2022
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.
This commit adds three concrete errors to the public API and ensures that
all returned errors are either instances of those concrete types OR are
wrapped by more descriptive errors.
The three error types are:
ConfigError: for all errors that are the result of the client making
a semantic error in their request
RefreshError: for all the (uncommon) cases where the server returns
data that is somehow and unexpectedly invalid.
DialError: for any error that occurs when interacting with the SQL
Admin API or when attempting to connect to a
particular SQL instance.
By providing concrete errors or wrapping concrete errors, we allow our
clients to uses the errors.As API to possibly react differently to
errors coming out of the dialer.
Fixes #37