refactor: feature flag replacements

mitodl · Jul 12, 2024 · a9754d1 · a9754d1
1 parent 6c57b5a
commit a9754d1
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 31 deletions.
diff --git a/courses/api.py b/courses/api.py
@@ -5,6 +5,7 @@
 from collections import namedtuple
 from traceback import format_exc
 
+from django.conf import settings
 from django.core.exceptions import ValidationError
 from requests.exceptions import ConnectionError as RequestsConnectionError
 from requests.exceptions import HTTPError
@@ -113,6 +114,7 @@ def create_run_enrollments(
             for all of the given course runs
     """
     successful_enrollments = []
+    send_welcome_email = settings.FEATURES.get("ENROLLMENT_WELCOME_EMAIL", False)
     try:
         enroll_in_edx_course_runs(user, runs)
     except (
@@ -155,7 +157,10 @@ def create_run_enrollments(
             successful_enrollments.append(enrollment)
             if enrollment.edx_enrolled:
                 mail_api.send_course_run_enrollment_email(enrollment)
-                mail_api.send_course_run_enrollment_welcome_email(enrollment)
+                if send_welcome_email:
+                    mail_api.send_course_run_enrollment_welcome_email(enrollment)
+                else:
+                    log.info("Feature ENROLLMENT_WELCOME_EMAIL is disabled.")
     return successful_enrollments, edx_request_success
 
 

diff --git a/courses/management/utils.py b/courses/management/utils.py
@@ -1,5 +1,7 @@
 """Utility functions/classes for course management commands"""
 
+import logging
+from django.conf import settings
 from django.core.management.base import BaseCommand, CommandError
 
 from courses.models import CourseRun, CourseRunEnrollment, Program, ProgramEnrollment
@@ -12,6 +14,8 @@
 from ecommerce import mail_api
 from mitxpro.utils import has_equal_properties
 
+log = logging.getLogger(__name__)
+
 
 def enrollment_summary(enrollment):
     """
@@ -216,7 +220,10 @@ def create_run_enrollment(
             run_enrollment.edx_enrolled = True
             run_enrollment.save_and_log(None)
             mail_api.send_course_run_enrollment_email(run_enrollment)
-            mail_api.send_course_run_enrollment_welcome_email(run_enrollment)
+            if settings.FEATURES.get("ENROLLMENT_WELCOME_EMAIL", False):
+                mail_api.send_course_run_enrollment_welcome_email(run_enrollment)
+            else:
+                log.info("Feature ENROLLMENT_WELCOME_EMAIL is disabled.")
         elif not keep_failed_enrollments:
             if created:
                 run_enrollment.delete()

diff --git a/ecommerce/mail_api.py b/ecommerce/mail_api.py
@@ -200,9 +200,6 @@ def send_course_run_enrollment_welcome_email(enrollment):
     Args:
         enrollment (CourseRunEnrollment): the enrollment for which to send the welcome email
     """
-    if not settings.FEATURES.get("ENROLLMENT_WELCOME_EMAIL", False):
-        log.info("Feature ENROLLMENT_WELCOME_EMAIL is disabled.")
-        return
     run_start_date, run_start_time = format_run_date(enrollment.run.start_date)
     run_end_date, _ = format_run_date(enrollment.run.end_date)
     run_duration = (

diff --git a/ecommerce/mail_api_test.py b/ecommerce/mail_api_test.py
@@ -150,11 +150,8 @@ def test_send_course_run_enrollment_email_error(mocker):
     )
 
 
-@pytest.mark.parametrize("enabled", [True, False])
-def test_send_course_run_enrollment_welcome_email(settings, mocker, enabled):
+def test_send_course_run_enrollment_welcome_email(mocker):
     """send_course_run_enrollment_welcome_email should send a welcome email for the given enrollment"""
-    settings.FEATURES["ENROLLMENT_WELCOME_EMAIL"] = enabled
-    mock_log = mocker.patch("ecommerce.mail_api.log")
     patched_mail_api = mocker.patch("ecommerce.mail_api.api")
     enrollment = CourseRunEnrollmentFactory.create()
 
@@ -170,28 +167,23 @@ def test_send_course_run_enrollment_welcome_email(settings, mocker, enabled):
 
     send_course_run_enrollment_welcome_email(enrollment)
 
-    if not enabled:
-        mock_log.info.assert_called_once_with(
-            "Feature ENROLLMENT_WELCOME_EMAIL is disabled."
-        )
-    else:
-        patched_mail_api.context_for_user.assert_called_once_with(
-            user=enrollment.user,
-            extra_context={
-                "enrollment": enrollment,
-                "run_start_date": run_start_date.strftime(EMAIL_DATE_FORMAT),
-                "run_start_time": run_start_time,
-                "run_date_range": date_range,
-            },
-        )
-        patched_mail_api.message_for_recipient.assert_called_once_with(
-            enrollment.user.email,
-            patched_mail_api.context_for_user.return_value,
-            EMAIL_WELCOME_COURSE_RUN_ENROLLMENT,
-        )
-        patched_mail_api.send_message.assert_called_once_with(
-            patched_mail_api.message_for_recipient.return_value
-        )
+    patched_mail_api.context_for_user.assert_called_once_with(
+        user=enrollment.user,
+        extra_context={
+            "enrollment": enrollment,
+            "run_start_date": run_start_date.strftime(EMAIL_DATE_FORMAT),
+            "run_start_time": run_start_time,
+            "run_date_range": date_range,
+        },
+    )
+    patched_mail_api.message_for_recipient.assert_called_once_with(
+        enrollment.user.email,
+        patched_mail_api.context_for_user.return_value,
+        EMAIL_WELCOME_COURSE_RUN_ENROLLMENT,
+    )
+    patched_mail_api.send_message.assert_called_once_with(
+        patched_mail_api.message_for_recipient.return_value
+    )
 
 
 @pytest.mark.parametrize("has_discount", [True, False])