Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: populate default timeout and retry after client-side timeout #896

Merged
merged 12 commits into from
Aug 25, 2021
Merged

fix: populate default timeout and retry after client-side timeout #896

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4e37426
fix: populate default `timeout` and actually retry after timeout
tswast Aug 23, 2021
4fa81d8
fix test_client tests
tswast Aug 23, 2021
4acdaa6
fix remaining unit tests
tswast Aug 24, 2021
f1f7395
Merge branch 'master' into issue889-default-timeout
tswast Aug 24, 2021
02f1829
Merge branch 'master' into issue889-default-timeout
tswast Aug 24, 2021
24d1049
add tests for timeout errors
tswast Aug 24, 2021
725de7d
retry all timeout errors
tswast Aug 24, 2021
14bb277
Merge remote-tracking branch 'origin/issue889-default-timeout' into i…
tswast Aug 24, 2021
bbfcc53
Merge branch 'master' into issue889-default-timeout
tswast Aug 24, 2021
d1fee5a
Merge branch 'master' into issue889-default-timeout
tswast Aug 25, 2021
10940af
Merge branch 'master' into issue889-default-timeout
gcf-merge-on-green[bot] Aug 25, 2021
7e7fc5c
Merge branch 'master' into issue889-default-timeout
tswast Aug 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 62 additions & 61 deletions google/cloud/bigquery/client.py
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions google/cloud/bigquery/retry.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
exceptions.BadGateway,
requests.exceptions.ChunkedEncodingError,
requests.exceptions.ConnectionError,
requests.exceptions.ReadTimeout,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the exception I get if I set the timeout to too small of a value for most requests to complete.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need a test for this exception type in tests/unit/test_retry.py?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Added.

Looking at the Requests docs, it seems ReadTimeout is just one kind of Timeout error that can happen, so I updated this to the base class and added some tests for other timeouts.

auth_exceptions.TransportError,
)

Expand Down Expand Up @@ -59,6 +60,13 @@ def _should_retry(exc):
pass ``retry=bigquery.DEFAULT_RETRY.with_deadline(30)``.
"""

DEFAULT_TIMEOUT = 5.0 * 60.0
"""The default API timeout.

This is the time to wait per request. To adjust the total wait time, set a
deadline on the retry object.
"""

job_retry_reasons = "rateLimitExceeded", "backendError"


Expand Down
4 changes: 0 additions & 4 deletions noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,6 @@ def snippets(session):
if os.environ.get("RUN_SNIPPETS_TESTS", "true") == "false":
session.skip("RUN_SNIPPETS_TESTS is set to false, skipping")

# Sanity check: Only run snippets tests if the environment variable is set.
if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed because for most snippets except for the ones that explicitly use a service account key file, the credentials from gcloud work fine. Downloading service account keys is increasingly restricted on internal projects.

session.skip("Credentials must be set via environment variable.")

constraints_path = str(
CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"
)
Expand Down
Loading