feat: improve aiohttp client error messages #1201
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
rhatgadkar-goog
approved these changes
Dec 2, 2024
rhatgadkar-goog
added a commit
to GoogleCloudPlatform/alloydb-python-connector
that referenced
this pull request
Dec 3, 2024
This change is similar to GoogleCloudPlatform/cloud-sql-python-connector#1201, except for AlloyDB. In short, we want to use the AlloyDB API's response body for error messages, because they are more detailed.
rhatgadkar-goog
suggested changes
Dec 3, 2024
@rhatgadkar-goog Moved asserts out of |
rhatgadkar-goog
approved these changes
Dec 3, 2024
hessjcg
approved these changes
Dec 3, 2024
rhatgadkar-goog
added a commit
to GoogleCloudPlatform/alloydb-python-connector
that referenced
this pull request
Dec 4, 2024
This change is similar to GoogleCloudPlatform/cloud-sql-python-connector#1201, except for AlloyDB.
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.
By default,
aiohttpon bad requests will discard response body andoutput generic error message in response,
Bad Request,Forbidden, etc.The Cloud SQL Admin APIs response body contains more detailed error messages.
We need to raise these to the end user for them to be able to resolve common config
issues on their own.
In #362 we caught
403errors and implemented a custom error messageto point users at the most common config issues, Cloud SQL API not being enabled,
missing
Cloud SQL Clientrole etc. However, this was not a catch-all (as noted by #1199)and more of a temporary fix.
This PR implements a more robust solution, copying the actual Cloud SQL Admin API
response body's error message to the end user.
Note
Example common scenario: Calling the Python Connector with a typo in your instance name.
Old Error Message:
New Error Message after PR:
Related aio-libs/aiohttp#4600
I looked into using a custom response class but it seemed over the top
compared to the working approach here.
Closes #477