chore: add additional logging to JWT auth middleware authenticate_cre…

…dentials (#292)

CHANGELOG.rst

@@ -12,6 +12,14 @@ Change Log
 Unreleased
 ----------
 
+[8.4.1] - 2022-12-18
+--------------------
+
+Added
+~~~~~
+
+* Additional logging in `authenticate_credentials` within the JWT authentication middleware for debugging purposes.
+
 [8.4.0] - 2022-12-16
 --------------------
 

edx_rest_framework_extensions/__init__.py

@@ -1,3 +1,3 @@
 """ edx Django REST Framework extensions. """
 
-__version__ = '8.4.0'  # pragma: no cover
+__version__ = '8.4.1'  # pragma: no cover

edx_rest_framework_extensions/auth/jwt/authentication.py

@@ -148,7 +148,7 @@ def authenticate_credentials(self, payload):
             if attributes_updated:
                 user.save()
         except Exception as authentication_error:
-            msg = 'User retrieval failed.'
+            msg = f'[edx-drf-extensions] User retrieval failed for username {username}.'
             logger.exception(msg)
             raise exceptions.AuthenticationFailed(msg) from authentication_error
 

edx_rest_framework_extensions/auth/jwt/tests/test_authentication.py

@@ -167,7 +167,7 @@ def test_authenticate_credentials_user_retrieval_failed(self):
                     JwtAuthentication().authenticate_credentials,
                     {'username': 'test', 'email': 'test@example.com'}
                 )
-                logger.assert_called_with('User retrieval failed.')
+                logger.assert_called_with('[edx-drf-extensions] User retrieval failed for username test.')
 
     def test_authenticate_credentials_no_usernames(self):
         """ Verify an AuthenticationFailed exception is raised if the payload contains no username claim. """