refactor

Author: arslanashraf7

src/ol_openedx_lti_utilities/ol_openedx_lti_utilities/views.py

@@ -4,6 +4,7 @@
 
 import logging
 
+from django.db import transaction
 from django.http import Http404, HttpResponseBadRequest
 from edx_rest_framework_extensions import permissions
 from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
@@ -18,6 +19,7 @@
 from rest_framework import status
 from rest_framework.response import Response
 from rest_framework.views import APIView
+from social_django.models import UserSocialAuth
 
 log = logging.getLogger(__name__)
 
@@ -85,25 +87,34 @@ def post(self, request):
 
         # A user that is created by LTI will always have the same username as
         # lti_user_id in LtiUser table.
-        lti_user = LtiUser.objects.filter(edx_user__email=user_email).first()
-        if not lti_user:
-            log.error("No user was found against the given email (%s)", user_email)
-            raise Http404
-        if lti_user.lti_user_id != lti_user.edx_user.username:
-            log.error(
-                "User with email (%s) does not appear to be an LTI-created user",
-                user_email,
-            )
-            return HttpResponseBadRequest(
-                "User with the given email does not appear to be an LTI-created user."
-            )
-
-        user = lti_user.edx_user
-        user.email = user.email.split("@")[0] + "@" + PLACEHOLDER_EMAIL_DOMAIN
-        user.save()
+        with transaction.atomic():
+            lti_user = LtiUser.objects.filter(edx_user__email=user_email).first()
+            if not lti_user:
+                log.error("No user was found against the given email (%s)", user_email)
+                raise Http404
+            if lti_user.lti_user_id != lti_user.edx_user.username:
+                log.error(
+                    "User with email (%s) does not appear to be an LTI-created user",
+                    user_email,
+                )
+                return HttpResponseBadRequest(
+                    "User with the given email does not appear to be an "
+                    "LTI-created user."
+                )
+
+            user = lti_user.edx_user
+            user.email = user.email.split("@")[0] + "@" + PLACEHOLDER_EMAIL_DOMAIN
+            user.save()
+            # Remove social auth records for this user
+            UserSocialAuth.objects.filter(user=user).delete()
+            # Remove the old LTI mapping so that a new one gets created the next time
+            # users access edX via LTI
+            lti_user.delete()
+
         # Send the user for retirement and deactivate the account
         try:
             create_retirement_request_and_deactivate_account(user)
         except Exception as e:  # noqa: BLE001
             log.error("Error retiring and deactivating user: %s", e)  # noqa: TRY400
+
         return Response(status=status.HTTP_200_OK)

src/ol_openedx_lti_utilities/tests/test_views.py

@@ -30,7 +30,10 @@ def setUp(self):
     @patch(
         "ol_openedx_lti_utilities.views.create_retirement_request_and_deactivate_account"
     )
-    def test_successful_lti_user_fix(self, mock_retirement_user, mock_lti_user_model):
+    @patch("ol_openedx_lti_utilities.views.UserSocialAuth.objects")
+    def test_successful_lti_user_fix(
+        self, mock_user_social_auth_objects, mock_retirement_user, mock_lti_user_model
+    ):
         """Test successful LTI user fix."""
         # Mock LTI user with bad username
         mock_lti_user = Mock()
@@ -50,6 +53,8 @@ def test_successful_lti_user_fix(self, mock_retirement_user, mock_lti_user_model
         response = self.client.post(self.url, payload)
         mock_edx_user.save.assert_called_once()
         mock_retirement_user.assert_called_once_with(mock_edx_user)
+        mock_qs = mock_user_social_auth_objects.filter.return_value
+        mock_user_social_auth_objects.filter.return_value.delete.assert_called_once()
 
         assert response.status_code == status.HTTP_200_OK