fix: raise error on enrollment retry failure (#3016)

Author: asajjad2

courses/api.py

@@ -77,6 +77,7 @@
 from openedx.exceptions import (
     EdxApiEnrollErrorException,
     NoEdxApiAuthError,
+    OpenEdxUserMissingError,
     UnknownEdxApiEnrollException,
 )
 
@@ -186,6 +187,7 @@ def _enroll_learner_into_associated_programs():
         except (
             UnknownEdxApiEnrollException,
             NoEdxApiAuthError,
+            OpenEdxUserMissingError,
             RequestsConnectionError,
             EdxApiEnrollErrorException,
             HTTPError,

openedx/api.py

@@ -1047,6 +1047,15 @@ def enroll_in_edx_course_runs(
 
     username = user.edx_username
 
+    try:
+        created_user, _ = repair_faulty_edx_user(user)
+        if created_user is False:
+            msg = f"User {user.edx_username} does not exist in OpenEdX and could not be created"
+            raise OpenEdxUserMissingError(msg)  # noqa: TRY301
+    except Exception as exc:
+        msg = f"Failed to verify/create user {user.edx_username} in OpenEdX"
+        raise OpenEdxUserMissingError(msg) from exc
+
     results = []
     for course_run in course_runs:
         try:
@@ -1069,33 +1078,13 @@ def enroll_in_edx_course_runs(
                     )
             results.append(enrollment)
         except HTTPError as exc:  # noqa: PERF203
-            if exc.response.status_code == 406:  # noqa: PLR2004
-                log.warning(
-                    "User %s does not exist in edX, attempting to create user.",
-                    user.edx_username,
-                )
-                # If the user doesn't exist, we need to create them first
-                try:
-                    created_user, _ = repair_faulty_edx_user(user)
-                    if created_user:
-                        enrollment = edx_client.enrollments.create_student_enrollment(
-                            course_run.courseware_id,
-                            mode=mode,
-                            username=username,
-                            force_enrollment=force_enrollment,
-                        )
-                        results.append(enrollment)
-                except Exception as exc:
-                    log.exception("Failed to create user %s in edX.", user.edx_username)
-                    raise UnknownEdxApiEnrollException(user, course_run, exc) from exc
-            else:
-                log.exception(
-                    "Failed to enroll user %s in course run %s with mode %s.",
-                    user.edx_username,
-                    course_run.courseware_id,
-                    mode,
-                )
-                raise EdxApiEnrollErrorException(user, course_run, exc) from exc
+            log.error(  # noqa: TRY400
+                "Failed to enroll user %s in course run %s with mode %s.",
+                user.edx_username,
+                course_run.courseware_id,
+                mode,
+            )
+            raise EdxApiEnrollErrorException(user, course_run, exc) from exc
         except Exception as exc:  # pylint: disable=broad-except
             raise UnknownEdxApiEnrollException(user, course_run, exc) from exc
     return results

openedx/api_test.py

@@ -654,6 +654,7 @@ def test_enroll_in_edx_course_runs(settings, mocker, user, has_edx_username):
     )
     mocker.patch("openedx.api.get_edx_api_client", return_value=mock_client)
     mocker.patch("openedx.api.get_edx_api_service_client", return_value=mock_client)
+    mocker.patch("openedx.api.repair_faulty_edx_user", return_value=(None, None))
     course_runs = CourseRunFactory.build_batch(2)
 
     # Test to make sure reconcile_edx_username runs as expected.
@@ -696,6 +697,7 @@ def test_enroll_api_fail(mocker, user):
     )
     mocker.patch("openedx.api.get_edx_api_client", return_value=mock_client)
     mocker.patch("openedx.api.get_edx_api_service_client", return_value=mock_client)
+    mocker.patch("openedx.api.repair_faulty_edx_user", return_value=(None, None))
     course_run = CourseRunFactory.build()
 
     with pytest.raises(EdxApiEnrollErrorException):
@@ -713,6 +715,7 @@ def test_enroll_pro_unknown_fail(settings, mocker, user):
         side_effect=ValueError("Unexpected error")
     )
     mocker.patch("openedx.api.get_edx_api_client", return_value=mock_client)
+    mocker.patch("openedx.api.repair_faulty_edx_user", return_value=(None, None))
     course_run = CourseRunFactory.build()
 
     with pytest.raises(UnknownEdxApiEnrollException):