Skip to content

Fix logging statements in oauth.py #93

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

Closed
wants to merge 2 commits into from
Closed

Fix logging statements in oauth.py #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94bb2d0
Apply some linting rules to oauth.py
jbylund Mar 7, 2023
e2f315a
(joe) re-black
jbylund Mar 10, 2023
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
32 changes: 20 additions & 12 deletions src/databricks/sql/auth/oauth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

logger = logging.getLogger(__name__)

# pylint: disable=invalid-name


class OAuthManager:
OIDC_REDIRECTOR_PATH = "oidc"
Expand All @@ -38,12 +40,13 @@ def __get_redirect_url(redirect_port: int):
def __fetch_well_known_config(idp_url: str):
known_config_url = f"{idp_url}/.well-known/oauth-authorization-server"
try:
response = requests.get(url=known_config_url)
response = requests.get(url=known_config_url, timeout=10)
Copy link
Contributor

Choose a reason for hiding this comment

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

Generally we like to keep these timeouts configurable. Perhaps when instantiating the OAuthManager?

except RequestException as e:
logger.error(
f"Unable to fetch OAuth configuration from {idp_url}.\n"
"Unable to fetch OAuth configuration from %s.\n"
Copy link
Contributor

Choose a reason for hiding this comment

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

Why the change from f-strings throughout?

"Verify it is a valid workspace URL and that OAuth is "
"enabled on this account."
"enabled on this account.",
idp_url,
)
raise e

Expand All @@ -59,9 +62,10 @@ def __fetch_well_known_config(idp_url: str):
return response.json()
except requests.exceptions.JSONDecodeError as e:
logger.error(
f"Unable to decode OAuth configuration from {idp_url}.\n"
"Unable to decode OAuth configuration from %s.\n"
"Verify it is a valid workspace URL and that OAuth is "
"enabled on this account."
"enabled on this account.",
idp_url,
)
raise e

Expand Down Expand Up @@ -96,24 +100,25 @@ def __get_authorization_code(self, client, auth_url, scope, state, challenge):
code_challenge=challenge,
code_challenge_method="S256",
)
logger.info(f"Opening {auth_req_uri}")
logger.info("Opening %s", auth_req_uri)

webbrowser.open_new(auth_req_uri)
logger.info(
f"Listening for OAuth authorization callback at {redirect_url}"
"Listening for OAuth authorization callback at %s", redirect_url
)
httpd.handle_request()
self.redirect_port = port
break
except OSError as e:
if e.errno == 48:
logger.info(f"Port {port} is in use")
logger.info("Port %d is in use", port)
last_error = e
except Exception as e:
logger.error("unexpected error", e)
Copy link
Author

Choose a reason for hiding this comment

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

This is probably the issue that brought me here in the first place. The format string here has no positions for arguments, but one argument was provided.

logger.error("Unexpected error: %s", e, exc_info=True)
if self.redirect_port is None:
logger.error(
f"Tried all the ports {self.port_range} for oauth redirect, but can't find free port"
"Tried all the ports %s for oauth redirect, but can't find a free port",
self.port_range,
)
raise last_error

Expand Down Expand Up @@ -150,7 +155,9 @@ def __send_token_request(token_request_url, data):
"Accept": "application/json",
"Content-Type": "application/x-www-form-urlencoded",
}
response = requests.post(url=token_request_url, data=data, headers=headers)
response = requests.post(
url=token_request_url, data=data, headers=headers, timeout=5
)
return response.json()

def __send_refresh_token_request(self, hostname, refresh_token):
Expand Down Expand Up @@ -206,7 +213,8 @@ def check_and_refresh_access_token(

# Try to refresh using the refresh token
logger.debug(
f"Attempting to refresh OAuth access token that expired on {expiration_time}"
"Attempting to refresh OAuth access token that expired at %s",
expiration_time,
)
oauth_response = self.__send_refresh_token_request(hostname, refresh_token)
fresh_access_token, fresh_refresh_token = self.__get_tokens_from_response(
Expand Down