fix: Fix LTI based duplicate email users automatically

Author: arslanashraf7

openedx/api.py

@@ -113,6 +113,14 @@ def _is_duplicate_username_error(resp, data):
     )
 
 
+def _is_duplicate_email_error(resp, data):
+    """Check if the response indicates a duplicate email error."""
+    return (
+        resp.status_code == status.HTTP_409_CONFLICT
+        and data.get("error_code") == "duplicate-email"
+    )
+
+
 def _is_bad_request(resp):
     """Check if the response indicates a bad request."""
     return resp.status_code in (
@@ -257,7 +265,7 @@ def _set_edx_error(open_edx_user, data):
     open_edx_user.save()
 
 
-def _create_edx_user_request(open_edx_user, user, access_token):
+def _create_edx_user_request(open_edx_user, user, access_token):  # noqa: C901, PLR0915
     """
     Handle the actual user creation request to Open edX with retry logic for duplicate usernames.
 
@@ -344,6 +352,16 @@ def _create_edx_user_request(open_edx_user, user, access_token):
                     attempt = 0
                 continue
             else:
+                # Only try for LTI user duplicate email error if the response error was duplicate-email
+                if _is_duplicate_email_error(resp, data):
+                    client = get_edx_api_lti_dup_email_client()
+                    dup_email_fix_resp = client.fix_lti_user(
+                        email=user.email, username=current_username
+                    )
+                    if dup_email_fix_resp.status_code == status.HTTP_200_OK:
+                        open_edx_user.has_been_synced = True
+                        open_edx_user.save()
+                        return True
                 break
 
         if _is_bad_request(resp):
@@ -923,6 +941,17 @@ def get_edx_api_course_detail_client():
     return edx_client.course_detail
 
 
+def get_edx_api_lti_dup_email_client():
+    """
+    Gets an edx api client instance for use with the grades api
+
+    Returns:
+        CourseDetails: edx api course client instance
+    """
+    edx_client = get_edx_api_service_client()
+    return edx_client.lti_tools
+
+
 def get_edx_api_course_mode_client():
     """
     Gets an edx api client instance for use with the grades api

openedx/api_test.py

@@ -244,8 +244,20 @@ def test_create_edx_user(  # noqa: PLR0913
         },
     ],
 )
-def test_create_edx_user_409_errors(settings, error_data):
-    """Test that create_edx_user handles a 409 response from the edX API"""
+@pytest.mark.parametrize(
+    "lti_fix_response_status",
+    [
+        status.HTTP_200_OK,
+        status.HTTP_400_BAD_REQUEST,
+        status.HTTP_500_INTERNAL_SERVER_ERROR,
+    ],
+)
+def test_create_edx_user_409_errors(settings, error_data, lti_fix_response_status):
+    """Test that create_edx_user handles a 409 response from the edX API
+    1. If the error is duplicate-email, it should call the LTI fix endpoint
+    2. If the LTI fix endpoint returns 200, the user should be marked as synced
+    3. If the LTI fix endpoint returns non-200, the user should be marked as having a sync error
+    """
     user = UserFactory.create(
         openedx_user__has_been_synced=False,
     )
@@ -262,19 +274,35 @@ def test_create_edx_user_409_errors(settings, error_data):
         json=error_data,
         status=status.HTTP_409_CONFLICT,
     )
+    resp3 = responses.add(
+        responses.POST,
+        f"{settings.OPENEDX_API_BASE_URL}/api/lti-user-fix/",
+        json={},
+        status=lti_fix_response_status,
+    )
 
     create_edx_user(user)
 
     assert resp1.call_count == 0
     assert resp2.call_count == 1
+    is_duplicate_email = error_data.get("error_code") == "duplicate-email"
+    if is_duplicate_email:
+        assert resp3.call_count == 1
+    else:
+        assert resp3.call_count == 0
 
     user.refresh_from_db()
 
     edx_user = user.openedx_users.first()
 
-    assert edx_user.has_been_synced is False
-    assert edx_user.has_sync_error is True
-    assert edx_user.sync_error_data == error_data
+    if lti_fix_response_status == status.HTTP_200_OK and is_duplicate_email:
+        assert edx_user.has_been_synced is True
+        assert edx_user.has_sync_error is False
+        assert edx_user.sync_error_data is None
+    else:
+        assert edx_user.has_been_synced is False
+        assert edx_user.has_sync_error is True
+        assert edx_user.sync_error_data == error_data
 
 
 @responses.activate

poetry.lock

@@ -42,7 +42,7 @@ djangorestframework = "^3.12.4"
 djoser = "^2.1.0"
 drf-extensions = "^0.8.0"
 drf-spectacular = "^0.28.0"
-edx-api-client = "^1.13.0"
+edx-api-client = { git = "https://github.com/mitodl/edx-api-client", branch = "arslan/8853-fix-lti-dup-users" }
 hubspot-api-client = "^6.1.0"
 ipython = "^8.0.0"
 mitol-django-apigateway = "2025.8.14"