Skip to content

Implement retry logic with exponential backoff for OpenID discovery document fetching #3

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Implement retry logic with exponential backoff for OpenID discovery document fetching #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 18 additions & 3 deletions intuitlib/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,19 @@
from base64 import b64encode, b64decode
from datetime import datetime
from requests.sessions import Session
from requests.adapters import HTTPAdapter
from urllib3.util.retry import Retry

from intuitlib.config import DISCOVERY_URL, ACCEPT_HEADER
from intuitlib.enums import Scopes
from intuitlib.exceptions import AuthClientError


def get_discovery_doc(environment, session=None):
def get_discovery_doc(environment, session=None, max_retries=3):
"""Gets discovery doc based on environment specified.
:param environment: App environment, accepted values: 'sandbox','production','prod','e2e'
:param session: `requests.Session` object if a session is already being used, defaults to None
:param max_retries: Maximum number of retry attempts, defaults to 3
:return: Discovery doc response
:raises HTTPError: if response status != 200
"""
Expand All @@ -43,11 +46,23 @@ def get_discovery_doc(environment, session=None):
discovery_url = DISCOVERY_URL['sandbox']
else:
discovery_url = environment


retry_strategy = Retry(
total=max_retries,
backoff_factor=1,
status_forcelist=[429, 500, 502, 503, 504],
)

if session is not None and isinstance(session, Session):
adapter = HTTPAdapter(max_retries=retry_strategy)
session.mount("https://", adapter)
response = session.get(url=discovery_url)
else:
response = requests.get(url=discovery_url)
adapter = HTTPAdapter(max_retries=retry_strategy)
with requests.Session() as temp_session:
temp_session.mount("https://", adapter)
response = temp_session.get(url=discovery_url)

if response.status_code != 200:
raise AuthClientError(response)
return response.json()
Expand Down
8 changes: 5 additions & 3 deletions tests/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,12 @@ def test_get_discovery_doc_custom_url_input(self):
assert discovery_doc['issuer'] =='https://oauth.platform.intuit.com/op/v1'
assert discovery_doc['userinfo_endpoint'] == 'https://sandbox-accounts.platform.intuit.com/v1/openid_connect/userinfo'

@mock.patch('intuitlib.utils.requests.get')
def test_get_discovery_doc_bad_response(self, mock_get):
@mock.patch('intuitlib.utils.requests.Session')
def test_get_discovery_doc_bad_response(self, mock_session_class):
mock_session = mock.Mock()
mock_session_class.return_value.__enter__.return_value = mock_session
mock_resp = self.mock_request(status=400)
mock_get.return_value = mock_resp
mock_session.get.return_value = mock_resp

with pytest.raises(AuthClientError):
get_discovery_doc('sandbox')
Expand Down