Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: renamed DeprecatedRestApiClient from EdxRestApiClient (#33916)

Browse Source 
* feat: renamed DeprecatedRestApiClient from EdxRestApiClient

* chore: Updating Python Requirements (#33917)

* fix: Put slumber in the proper alphabetical order.

---------

Co-authored-by: Yagnesh <yagnesh.nayi@manprax.com>
Co-authored-by: edX requirements bot <49161187+edx-requirements-bot@users.noreply.github.com>
This commit is contained in:
Diana Huang
2023-12-12 13:32:09 -05:00
committed by GitHub
parent 431b9dec15
commit c6485d1d27
7 changed files with 370 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
lms/djangoapps/commerce/tests/__init__.py
View File

@@ -5,14 +5,28 @@ from unittest import mock
from urllib.parse import urljoin
import httpretty
import ddt
import os
import requests
from django.conf import settings
from django.test import TestCase
from freezegun import freeze_time
from edx_rest_api_client.auth import JwtAuth
from openedx.core.djangoapps.commerce.utils import DeprecatedRestApiClient, user_agent
from common.djangoapps.student.tests.factories import UserFactory
from openedx.core.djangoapps.commerce.utils import get_ecommerce_api_base_url, get_ecommerce_api_client
from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user
__version__ = '5.6.1'
URL = 'http://example.com/api/v2'
SIGNING_KEY = 'edx'
USERNAME = 'edx'
FULL_NAME = 'édx äpp'
EMAIL = 'edx@example.com'
TRACKING_CONTEXT = {'foo': 'bar'}
ACCESS_TOKEN = 'abc123'
JWT = 'abc.123.doremi'
JSON = 'application/json'
TEST_PUBLIC_URL_ROOT = 'http://www.example.com'
TEST_API_URL = 'http://www-internal.example.com/api'
@@ -25,7 +39,87 @@ TEST_PAYMENT_DATA = {
}
class EdxRestApiClientTest(TestCase):
@ddt.ddt
class DeprecatedRestApiClientTests(TestCase):
"""
Tests for the edX Rest API client.
"""
@ddt.unpack
@ddt.data(
({'url': URL, 'signing_key': SIGNING_KEY, 'username': USERNAME,
'full_name': FULL_NAME, 'email': EMAIL}, JwtAuth),
({'url': URL, 'signing_key': SIGNING_KEY, 'username': USERNAME, 'full_name': None, 'email': EMAIL}, JwtAuth),
({'url': URL, 'signing_key': SIGNING_KEY, 'username': USERNAME,
'full_name': FULL_NAME, 'email': None}, JwtAuth),
({'url': URL, 'signing_key': SIGNING_KEY, 'username': USERNAME, 'full_name': None, 'email': None}, JwtAuth),
({'url': URL, 'signing_key': SIGNING_KEY, 'username': USERNAME}, JwtAuth),
({'url': URL, 'signing_key': None, 'username': USERNAME}, type(None)),
({'url': URL, 'signing_key': SIGNING_KEY, 'username': None}, type(None)),
({'url': URL, 'signing_key': None, 'username': None, 'oauth_access_token': None}, type(None))
)
def test_valid_configuration(self, kwargs, auth_type):
"""
The constructor should return successfully if all arguments are valid.
We also check that the auth type of the api is what we expect.
"""
api = DeprecatedRestApiClient(**kwargs)
self.assertIsInstance(api._store['session'].auth, auth_type) # pylint: disable=protected-access
@ddt.data(
{'url': None, 'signing_key': SIGNING_KEY, 'username': USERNAME},
{'url': None, 'signing_key': None, 'username': None, 'oauth_access_token': None},
)
def test_invalid_configuration(self, kwargs):
"""
If the constructor arguments are invalid, an InvalidConfigurationError should be raised.
"""
self.assertRaises(ValueError, DeprecatedRestApiClient, **kwargs)
@mock.patch('edx_rest_api_client.auth.JwtAuth.__init__', return_value=None)
def test_tracking_context(self, mock_auth):
"""
Ensure the tracking context is included with API requests if specified.
"""
DeprecatedRestApiClient(URL, SIGNING_KEY, USERNAME, FULL_NAME, EMAIL, tracking_context=TRACKING_CONTEXT)
self.assertIn(TRACKING_CONTEXT, mock_auth.call_args[1].values())
def test_oauth2(self):
"""
Ensure OAuth2 authentication is used when an access token is supplied to the constructor.
"""
with mock.patch('openedx.core.djangoapps.commerce.utils.BearerAuth.__init__', return_value=None) as mock_auth:
DeprecatedRestApiClient(URL, oauth_access_token=ACCESS_TOKEN)
mock_auth.assert_called_with(ACCESS_TOKEN)
def test_supplied_jwt(self):
"""Ensure JWT authentication is used when a JWT is supplied to the constructor."""
with mock.patch('edx_rest_api_client.auth.SuppliedJwtAuth.__init__', return_value=None) as mock_auth:
DeprecatedRestApiClient(URL, jwt=JWT)
mock_auth.assert_called_with(JWT)
def test_user_agent(self):
"""Make sure our custom User-Agent is getting built correctly."""
with mock.patch('socket.gethostbyname', return_value='test_hostname'):
default_user_agent = user_agent()
self.assertIn('python-requests', default_user_agent)
self.assertIn(f'edx-rest-api-client/{__version__}', default_user_agent)
self.assertIn('test_hostname', default_user_agent)
with mock.patch('socket.gethostbyname') as mock_gethostbyname:
mock_gethostbyname.side_effect = ValueError()
default_user_agent = user_agent()
self.assertIn('unknown_client_name', default_user_agent)
with mock.patch.dict(os.environ, {'EDX_REST_API_CLIENT_NAME': "awesome_app"}):
uagent = user_agent()
self.assertIn('awesome_app', uagent)
self.assertEqual(user_agent(), DeprecatedRestApiClient.user_agent())
class DeprecatedRestApiClientTest(TestCase):
"""
Tests to ensure the client is initialized properly.
"""

266
openedx/core/djangoapps/commerce/utils.py
View File

@@ -2,17 +2,210 @@
import requests
import slumber
import datetime
import json
import os
import socket
from django.conf import settings
from edx_rest_api_client.auth import SuppliedJwtAuth
from edx_rest_api_client.client import EdxRestApiClient
from edx_rest_api_client.auth import SuppliedJwtAuth, JwtAuth
from edx_django_utils.cache import TieredCache
from eventtracking import tracker
from openedx.core.djangoapps.oauth_dispatch.jwt import create_jwt_for_user
from requests.auth import AuthBase
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
from edx_django_utils.monitoring import set_custom_attribute
# When caching tokens, use this value to err on expiring tokens a little early so they are
# sure to be valid at the time they are used.
ACCESS_TOKEN_EXPIRED_THRESHOLD_SECONDS = 5
# How long should we wait to connect to the auth service.
# https://requests.readthedocs.io/en/master/user/advanced/#timeouts
REQUEST_CONNECT_TIMEOUT = 3.05
__version__ = '5.6.1'
REQUEST_READ_TIMEOUT = 5
ECOMMERCE_DATE_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
class BearerAuth(AuthBase):
"""
Attaches Bearer Authentication to the given Request object.
"""
def __init__(self, token):
"""
Instantiate the auth class.
"""
self.token = token
def __call__(self, r):
"""
Update the request headers.
"""
r.headers['Authorization'] = f'Bearer {self.token}'
return r
def user_agent():
"""
Return a User-Agent that identifies this client.
Example:
python-requests/2.9.1 edx-rest-api-client/1.7.2 ecommerce
The last item in the list will be the application name, taken from the
OS environment variable EDX_REST_API_CLIENT_NAME. If that environment
variable is not set, it will default to the hostname.
"""
client_name = 'unknown_client_name'
try:
client_name = os.environ.get("EDX_REST_API_CLIENT_NAME") or socket.gethostbyname(socket.gethostname())
except: # pylint: disable=bare-except
pass # using 'unknown_client_name' is good enough. no need to log.
return "{} edx-rest-api-client/{} {}".format(
requests.utils.default_user_agent(), # e.g. "python-requests/2.9.1"
__version__, # version of this client
client_name
)
USER_AGENT = user_agent()
def _get_oauth_url(url):
"""
Returns the complete url for the oauth2 endpoint.
Args:
url (str): base url of the LMS oauth endpoint, which can optionally include some or all of the path
``/oauth2/access_token``. Common example settings that would work for ``url`` would include:
LMS_BASE_URL = 'http://edx.devstack.lms:18000'
BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL = 'http://edx.devstack.lms:18000/oauth2'
"""
stripped_url = url.rstrip('/')
if stripped_url.endswith('/access_token'):
return url
if stripped_url.endswith('/oauth2'):
return stripped_url + '/access_token'
return stripped_url + '/oauth2/access_token'
def get_oauth_access_token(url, client_id, client_secret, token_type='jwt', grant_type='client_credentials',
refresh_token=None,
timeout=(REQUEST_CONNECT_TIMEOUT, REQUEST_READ_TIMEOUT)):
"""
Retrieves OAuth 2.0 access token using the given grant type.
Args:
url (str): Oauth2 access token endpoint, optionally including part of the path.
client_id (str): client ID
client_secret (str): client secret
Kwargs:
token_type (str): Type of token to return. Options include bearer and jwt.
grant_type (str): One of 'client_credentials' or 'refresh_token'
refresh_token (str): The previous access token (for grant_type=refresh_token)
Raises:
requests.RequestException if there is a problem retrieving the access token.
Returns:
tuple: Tuple containing (access token string, expiration datetime).
"""
now = datetime.datetime.utcnow()
data = {
'grant_type': grant_type,
'client_id': client_id,
'client_secret': client_secret,
'token_type': token_type,
}
if refresh_token:
data['refresh_token'] = refresh_token
else:
assert grant_type != 'refresh_token', "refresh_token parameter required"
response = requests.post(
_get_oauth_url(url),
data=data,
headers={
'User-Agent': USER_AGENT,
},
timeout=timeout
)
response.raise_for_status() # Raise an exception for bad status codes.
try:
data = response.json()
access_token = data['access_token']
expires_in = data['expires_in']
except (KeyError, json.decoder.JSONDecodeError) as json_error:
raise requests.RequestException(response=response) from json_error
expires_at = now + datetime.timedelta(seconds=expires_in)
return access_token, expires_at
def get_and_cache_oauth_access_token(url, client_id, client_secret, token_type='jwt', grant_type='client_credentials',
refresh_token=None,
timeout=(REQUEST_CONNECT_TIMEOUT, REQUEST_READ_TIMEOUT)):
"""
Retrieves a possibly cached OAuth 2.0 access token using the given grant type.
See ``get_oauth_access_token`` for usage details.
First retrieves the access token from the cache and ensures it has not expired. If
the access token either wasn't found in the cache, or was expired, retrieves a new
access token and caches it for the lifetime of the token.
Note: Consider tokens to be expired ACCESS_TOKEN_EXPIRED_THRESHOLD_SECONDS early
to ensure the token won't expire while it is in use.
Returns:
tuple: Tuple containing (access token string, expiration datetime).
"""
oauth_url = _get_oauth_url(url)
cache_key = 'edx_rest_api_client.access_token.{}.{}.{}.{}'.format(
token_type,
grant_type,
client_id,
oauth_url,
)
cached_response = TieredCache.get_cached_response(cache_key)
# Attempt to get an unexpired cached access token
if cached_response.is_found:
_, expiration = cached_response.value
# Double-check the token hasn't already expired as a safety net.
adjusted_expiration = expiration - datetime.timedelta(seconds=ACCESS_TOKEN_EXPIRED_THRESHOLD_SECONDS)
if datetime.datetime.utcnow() < adjusted_expiration:
return cached_response.value
# Get a new access token if no unexpired access token was found in the cache.
oauth_access_token_response = get_oauth_access_token(
oauth_url,
client_id,
client_secret,
grant_type=grant_type,
refresh_token=refresh_token,
timeout=timeout,
)
# Cache the new access token with an expiration matching the lifetime of the token.
_, expiration = oauth_access_token_response
expires_in = (expiration - datetime.datetime.utcnow()).seconds - ACCESS_TOKEN_EXPIRED_THRESHOLD_SECONDS
TieredCache.set_all_tiers(cache_key, oauth_access_token_response, expires_in)
return oauth_access_token_response
def create_tracking_context(user):
""" Assembles attributes from user and request objects to be sent along
in E-Commerce API calls for tracking purposes. """
@@ -53,7 +246,7 @@ def ecommerce_api_client(user, session=None):
]
jwt = create_jwt_for_user(user, additional_claims=claims, scopes=scopes)
return EdxRestApiClient(
return DeprecatedRestApiClient(
configuration_helpers.get_value('ECOMMERCE_API_URL', settings.ECOMMERCE_API_URL),
jwt=jwt,
session=session
@@ -76,3 +269,70 @@ def get_ecommerce_api_client(user):
client.auth = SuppliedJwtAuth(jwt)
return client
class DeprecatedRestApiClient(slumber.API):
"""
API client for edX REST API.
(deprecated) See docs/decisions/0002-oauth-api-client-replacement.rst.
"""
@classmethod
def user_agent(cls):
return USER_AGENT
@classmethod
def get_oauth_access_token(cls, url, client_id, client_secret, token_type='bearer',
timeout=(REQUEST_CONNECT_TIMEOUT, REQUEST_READ_TIMEOUT)):
"""
To help transition to OAuthAPIClient, use DeprecatedRestApiClient.
get_and_cache_jwt_oauth_access_token instead'
'of DeprecatedRestApiClient.get_oauth_access_token to share cached jwt token used by OAuthAPIClient.'
"""
return get_oauth_access_token(url, client_id, client_secret, token_type=token_type, timeout=timeout)
@classmethod
def get_and_cache_jwt_oauth_access_token(cls, url, client_id, client_secret,
timeout=(REQUEST_CONNECT_TIMEOUT, REQUEST_READ_TIMEOUT)):
return get_and_cache_oauth_access_token(url, client_id, client_secret, token_type="jwt", timeout=timeout)
def __init__(self, url, signing_key=None, username=None, full_name=None, email=None,
timeout=5, issuer=None, expires_in=30, tracking_context=None, oauth_access_token=None,
session=None, jwt=None, **kwargs):
"""
DeprecatedRestApiClient is deprecated. Use OAuthAPIClient instead.
Instantiate a new client. You can pass extra kwargs to Slumber like
'append_slash'.
Raises:
ValueError: If a URL is not provided.
"""
set_custom_attribute('api_client', 'DeprecatedRestApiClient')
if not url:
raise ValueError('An API url must be supplied!')
if jwt:
auth = SuppliedJwtAuth(jwt)
elif oauth_access_token:
auth = BearerAuth(oauth_access_token)
elif signing_key and username:
auth = JwtAuth(username, full_name, email, signing_key,
issuer=issuer, expires_in=expires_in, tracking_context=tracking_context)
else:
auth = None
session = session or requests.Session()
session.headers['User-Agent'] = self.user_agent()
session.timeout = timeout
super().__init__(
url,
session=session,
auth=auth,
**kwargs
)

5
requirements/edx/base.txt
View File

@@ -46,7 +46,7 @@ attrs==23.1.0
# openedx-events
# openedx-learning
# referencing
babel==2.13.1
babel==2.14.0
# via
# -r requirements/edx/kernel.in
# enmerkar
@@ -830,7 +830,7 @@ platformdirs==3.11.0
# via snowflake-connector-python
polib==1.2.0
# via edx-i18n-tools
prompt-toolkit==3.0.41
prompt-toolkit==3.0.42
# via click-repl
psutil==5.9.6
# via
@@ -1072,6 +1072,7 @@ six==1.16.0
# python-memcached
slumber==0.7.1
# via
# -r requirements/edx/kernel.in
# edx-bulk-grades
# edx-enterprise
# edx-rest-api-client

6
requirements/edx/development.txt
View File

@@ -98,7 +98,7 @@ attrs==23.1.0
# openedx-events
# openedx-learning
# referencing
babel==2.13.1
babel==2.14.0
# via
# -r requirements/edx/doc.txt
# -r requirements/edx/testing.txt
@@ -338,7 +338,7 @@ dill==0.3.7
# via
# -r requirements/edx/testing.txt
# pylint
distlib==0.3.7
distlib==0.3.8
# via
# -r requirements/edx/testing.txt
# virtualenv
@@ -1418,7 +1418,7 @@ polib==1.2.0
# -r requirements/edx/doc.txt
# -r requirements/edx/testing.txt
# edx-i18n-tools
prompt-toolkit==3.0.41
prompt-toolkit==3.0.42
# via
# -r requirements/edx/doc.txt
# -r requirements/edx/testing.txt

4
requirements/edx/doc.txt
View File

@@ -63,7 +63,7 @@ attrs==23.1.0
# openedx-events
# openedx-learning
# referencing
babel==2.13.1
babel==2.14.0
# via
# -r requirements/edx/base.txt
# enmerkar
@@ -987,7 +987,7 @@ polib==1.2.0
# via
# -r requirements/edx/base.txt
# edx-i18n-tools
prompt-toolkit==3.0.41
prompt-toolkit==3.0.42
# via
# -r requirements/edx/base.txt
# click-repl

1
requirements/edx/kernel.in
View File

@@ -148,6 +148,7 @@ social-auth-core
simplejson
Shapely # Geometry library, used for image click regions in capa
six # Utilities for supporting Python 2 & 3 in the same codebase
slumber # The following dependency is unsupported and used by the DeprecatedRestApiClient
social-auth-app-django
sorl-thumbnail
sortedcontainers # Provides SortedKeyList, used for lists of XBlock assets

6
requirements/edx/testing.txt
View File

@@ -69,7 +69,7 @@ attrs==23.1.0
# openedx-events
# openedx-learning
# referencing
babel==2.13.1
babel==2.14.0
# via
# -r requirements/edx/base.txt
# enmerkar
@@ -254,7 +254,7 @@ diff-cover==8.0.1
# via -r requirements/edx/coverage.txt
dill==0.3.7
# via pylint
distlib==0.3.7
distlib==0.3.8
# via virtualenv
django==3.2.23
# via
@@ -1058,7 +1058,7 @@ polib==1.2.0
# -r requirements/edx/base.txt
# -r requirements/edx/testing.in
# edx-i18n-tools
prompt-toolkit==3.0.41
prompt-toolkit==3.0.42
# via
# -r requirements/edx/base.txt
# click-repl