chore: code refactoring and a utility function for formating dates

courses/api.py

@@ -155,7 +155,7 @@ def create_run_enrollments(
             successful_enrollments.append(enrollment)
             if enrollment.edx_enrolled:
                 mail_api.send_course_run_enrollment_email(enrollment)
-                mail_api.send_welcome_course_run_enrollment_email(enrollment)
+                mail_api.send_course_run_enrollment_welcome_email(enrollment)
     return successful_enrollments, edx_request_success
 
 

courses/management/utils.py

@@ -216,7 +216,7 @@ 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_welcome_course_run_enrollment_email(run_enrollment)
+            mail_api.send_course_run_enrollment_welcome_email(run_enrollment)
         elif not keep_failed_enrollments:
             if created:
                 run_enrollment.delete()

ecommerce/mail_api.py

@@ -1,6 +1,5 @@
 """Ecommerce mail API"""
 
-import datetime
 import logging
 from urllib.parse import urlencode, urljoin
 
@@ -11,7 +10,7 @@
 
 from courses.models import CourseRun
 from ecommerce.constants import BULK_ENROLLMENT_EMAIL_TAG, CYBERSOURCE_CARD_TYPES
-from ecommerce.utils import make_checkout_url
+from ecommerce.utils import format_run_date, make_checkout_url
 from mail import api
 from mail.constants import (
     EMAIL_B2B_RECEIPT,
@@ -194,23 +193,16 @@ def send_course_run_unenrollment_email(enrollment):
         log.exception("Error sending unenrollment success email: %s", exp)  # noqa: TRY401
 
 
-def send_welcome_course_run_enrollment_email(enrollment):
+def send_course_run_enrollment_welcome_email(enrollment):
     """
-    Welcome the user of successful enrollment for a course run
+    Send welcome email to the user on successful enrollment
 
     Args:
         enrollment (CourseRunEnrollment): the enrollment for which to send the welcome email
     """
-    run_start_date = run_end_date = ""
-    run_start_time = ""
-    if enrollment.run.start_date:
-        run_start_date = enrollment.run.start_date.strftime(EMAIL_DATE_FORMAT)
-        run_start_time = enrollment.run.start_date.astimezone(
-            datetime.timezone.utc
-        ).strftime(EMAIL_TIME_FORMAT)
-    if enrollment.run.end_date:
-        run_end_date = enrollment.run.end_date.strftime(EMAIL_DATE_FORMAT)
-    date_range = (
+    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 = (
         f"{run_start_date} - {run_end_date}" if run_start_date and run_end_date else ""
     )
     try:
@@ -224,14 +216,14 @@ def send_welcome_course_run_enrollment_email(enrollment):
                         "enrollment": enrollment,
                         "run_start_date": run_start_date,
                         "run_start_time": run_start_time,
-                        "run_date_range": date_range,
+                        "run_date_range": run_duration,
                     },
                 ),
                 EMAIL_WELCOME_COURSE_RUN_ENROLLMENT,
             )
         )
     except:  # noqa: E722
-        log.exception("Error sending welcome success email")
+        log.exception("Error sending welcome email")
 
 
 def send_b2b_receipt_email(order):

ecommerce/mail_api_test.py

@@ -32,9 +32,9 @@
     send_b2b_receipt_email,
     send_bulk_enroll_emails,
     send_course_run_enrollment_email,
+    send_course_run_enrollment_welcome_email,
     send_ecommerce_order_receipt,
     send_enrollment_failure_message,
-    send_welcome_course_run_enrollment_email,
 )
 from ecommerce.models import Order
 from mail.api import EmailMetadata, UserMessageProps
@@ -150,8 +150,8 @@ def test_send_course_run_enrollment_email_error(mocker):
     )
 
 
-def test_send_welcome_course_run_enrollment_email(mocker):
-    """send_welcome_course_run_enrollment_email should send a welcome email for the given enrollment"""
+def test_send_course_run_enrollment_welcome_email(mocker):
+    """send_course_run_enrollment_welcome_email should send a welcome email for the given enrollment"""
     patched_mail_api = mocker.patch("ecommerce.mail_api.api")
     enrollment = CourseRunEnrollmentFactory.create()
 
@@ -165,7 +165,7 @@ def test_send_welcome_course_run_enrollment_email(mocker):
         f"{run_end_date.strftime(EMAIL_DATE_FORMAT)}"
     )
 
-    send_welcome_course_run_enrollment_email(enrollment)
+    send_course_run_enrollment_welcome_email(enrollment)
 
     patched_mail_api.context_for_user.assert_called_once_with(
         user=enrollment.user,

ecommerce/utils.py

@@ -1,5 +1,6 @@
 """Utility functions for ecommerce"""
 
+import datetime
 import logging
 from urllib.parse import urlencode, urljoin
 
@@ -12,6 +13,7 @@
 from ecommerce.exceptions import ParseException
 
 log = logging.getLogger(__name__)
+EMAIL_TIME_FORMAT = "%I:%M %p %Z"
 
 
 def create_delete_rule(table_name):
@@ -154,3 +156,23 @@ def is_existing_coupon_code(value):
             Coupon.objects.filter(coupon_code=value).exists()
             or B2BCoupon.objects.filter(coupon_code=value).exists()
         )
+
+
+def format_run_date(run_date):
+    """
+    Format run date to return both date and time strings.
+
+    Args:
+        run_date (datetime): The datetime to format.
+
+    Returns:
+        tuple: A tuple containing the formatted date and time strings.
+    """
+    if run_date:
+        from ecommerce.mail_api import EMAIL_DATE_FORMAT
+
+        formatted_date_time = run_date.astimezone(datetime.timezone.utc).strftime(
+            f"{EMAIL_DATE_FORMAT}-{EMAIL_TIME_FORMAT}"
+        )
+        return tuple(formatted_date_time.split("-", 1))
+    return "", ""