Add timeout to requests in oauth.py#1401
Open
renaudhartert-db wants to merge 1 commit intomainfrom
Open
Conversation
`requests.post()` and `requests.get()` calls in `databricks/sdk/oauth.py` did not pass a `timeout=` parameter. Because token refresh runs inside `session.auth` (the `header_factory` callback), it executes before the SDK's per-request timeout on the underlying `requests.Session` takes effect. When the OAuth endpoint is unreachable or slow, these calls blocked indefinitely. This change adds a default 60s timeout to the three affected call sites: `retrieve_token()`, `get_azure_entra_id_workspace_endpoints()`, and `PATOAuthTokenExchange.refresh()`. Tests added to verify the timeout is passed on each call path. Fixes #1338 Signed-off-by: Renaud Hartert <renaud.hartert@databricks.com>
renaudhartert-db
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
renaudhartert-db
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
requests.post()andrequests.get()calls indatabricks/sdk/oauth.pydid not pass atimeout=parameter. Because token refresh runs insidesession.auth(theheader_factorycallback), it executes before the SDK's per-request timeout on the underlyingrequests.Sessiontakes effect. When the OAuth endpoint is unreachable or slow, the calls blocked indefinitely.This PR adds a default 60s timeout to the three affected call sites:
retrieve_token()get_azure_entra_id_workspace_endpoints()PATOAuthTokenExchange.refresh()Test plan
requests.post/requests.getand asserttimeout=is passed at each call site.tests/test_oauth.pypasses locally (17 tests).Fixes #1338