Skip to content

Commit f571e8a

Browse files
nthriveni-sonata-ship-itnthriveni-sonata-ship-it
committed
feat: add SES-ready enrollment email templates and supporting fields (no behavior change)
1 parent f0f7c29 commit f571e8a

23 files changed

Lines changed: 183 additions & 140 deletions

‎common/djangoapps/student/tasks.py‎

Lines changed: 106 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Celery task for course enrollment email
33
"""
44
import logging
5+
from datetime import datetime
6+
57
from celery import shared_task
68
from django.conf import settings
79
from django.contrib.auth import get_user_model
@@ -29,6 +31,74 @@
2931
MAX_RETRIES = 3
3032

3133

34+
def _build_enrollment_email_image_urls(language='en'):
35+
"""
36+
Build absolute URLs for enrollment email images (SES only).
37+
38+
This function constructs full image URLs for SES (Simple Email Service) email delivery. These URLs are required because SES email clients cannot resolve relative paths or Django static file paths—they need absolute URLs. Braze does NOT use these image URL keys; they are ignored by Braze and only used when the SES path is enabled.
39+
40+
Args:
41+
language (str): Language code ('en' or 'es') to select correct image variants
42+
43+
Returns:
44+
dict: Mapping of image variable names to absolute URLs
45+
46+
How it works:
47+
1. settings.LMS_ROOT_URL is evaluated at runtime (e.g., 'https://courses.edx.org')
48+
2. f-string interpolates this value into the path
49+
3. SES email client receives complete URL: 'https://courses.edx.org/static/images/enrollment_email/...'
50+
4. Browser/email client can fetch image directly without context about Django
51+
52+
Example flow:
53+
- Python (settings): LMS_ROOT_URL = 'https://courses.edx.org'
54+
- f-string: f"{settings.LMS_ROOT_URL}/static/images/enrollment_email/person_icon_{language}.png"
55+
- Result: 'https://courses.edx.org/static/images/enrollment_email/person_icon_en.png'
56+
- SES email client: Makes HTTP GET to that URL, renders image
57+
"""
58+
lms_root = configuration_helpers.get_value(
59+
"LMS_ROOT_URL", settings.LMS_ROOT_URL
60+
).rstrip('/')
61+
62+
# NOTE: Image URLs for SES templates.
63+
# Currently not used in Braze flow — will be enabled during SES migration.
64+
# Construct image URLs based on language
65+
image_urls = {
66+
'logo_url': f"{lms_root}/static/images/edx_logo.png",
67+
'you_are_enrolled_en': f"{lms_root}/static/images/enrollment_email/you_are_enrolled_en.png",
68+
'banner_default': f"{lms_root}/static/images/enrollment_email/banner_default.png",
69+
'timer_icon_en': f"{lms_root}/static/images/enrollment_email/timer_icon_en.png",
70+
'person_icon_en': f"{lms_root}/static/images/enrollment_email/person_icon_en.png",
71+
'dollar_icon_en': f"{lms_root}/static/images/enrollment_email/dollar_icon_en.png",
72+
'goal_idea_icon_en': f"{lms_root}/static/images/enrollment_email/goal_idea_icon_en.png",
73+
'flag_icon_pink_en': f"{lms_root}/static/images/enrollment_email/flag_icon_pink_en.png",
74+
'flag_icon_black_en_es': f"{lms_root}/static/images/enrollment_email/flag_icon_black_en_es.png",
75+
'flag_icon_orange_en': f"{lms_root}/static/images/enrollment_email/flag_icon_orange_en.png",
76+
'vertical_line_white_en': f"{lms_root}/static/images/enrollment_email/vertical_line_white_en.png",
77+
'vertical_line_orange_en': f"{lms_root}/static/images/enrollment_email/vertical_line_orange_en.png",
78+
'vertical_line_black_en': f"{lms_root}/static/images/enrollment_email/vertical_line_black_en.png",
79+
'community_illustration_en': f"{lms_root}/static/images/enrollment_email/community_illustration_en.png",
80+
}
81+
82+
# If Spanish, override with Spanish variants
83+
if language == 'es':
84+
spanish_overrides = {
85+
'banner_default': f"{lms_root}/static/images/enrollment_email/banner_default.png", # Same for both languages
86+
'arrow_icon_es': f"{lms_root}/static/images/enrollment_email/arrow_icon_es.png",
87+
'timer_icon_es': f"{lms_root}/static/images/enrollment_email/timer_icon_es.png",
88+
'person_icon_es': f"{lms_root}/static/images/enrollment_email/person_icon_es.png",
89+
'dollar_icon_es': f"{lms_root}/static/images/enrollment_email/dollar_icon_es.png",
90+
'flag_icon_white_es': f"{lms_root}/static/images/enrollment_email/flag_icon_white_es.png",
91+
'flag_icon_grey_es': f"{lms_root}/static/images/enrollment_email/flag_icon_grey_es.png",
92+
'flag_icon_black_en_es': f"{lms_root}/static/images/enrollment_email/flag_icon_black_en_es.png", # Same for both
93+
'calendar_icon_es': f"{lms_root}/static/images/enrollment_email/calendar_icon_es.png",
94+
'community_icon_es': f"{lms_root}/static/images/enrollment_email/community_icon_es.png",
95+
'slant_line_es': f"{lms_root}/static/images/enrollment_email/slant_line_es.png",
96+
}
97+
image_urls.update(spanish_overrides)
98+
99+
return image_urls
100+
101+
32102
@shared_task(bind=True, ignore_result=True)
33103
@set_code_owner_attribute
34104
def send_course_enrollment_email(
@@ -64,13 +134,16 @@ def send_course_enrollment_email(
64134
"course_price": CourseMode.min_course_price_for_currency(
65135
course_id=course_id, currency="USD"
66136
),
137+
# Strip trailing slashes so template concatenation like
138+
# "{{ lms_base_url }}/courses/..." never produces a double slash.
67139
"lms_base_url": configuration_helpers.get_value(
68140
"LMS_ROOT_URL", settings.LMS_ROOT_URL
69-
),
141+
).rstrip('/'),
70142
"learning_base_url": configuration_helpers.get_value(
71143
"LEARNING_MICROFRONTEND_URL", settings.LEARNING_MICROFRONTEND_URL
72-
),
73-
"track_mode": track_mode
144+
).rstrip('/'),
145+
"track_mode": track_mode,
146+
"current_year": datetime.now().year,
74147
}
75148

76149
try:
@@ -86,9 +159,14 @@ def send_course_enrollment_email(
86159
{
87160
"course_date_blocks": course_date_blocks,
88161
"goals_enabled": ENABLE_COURSE_GOALS.is_enabled(course_key),
162+
"user_name": user.get_full_name() or user.first_name or user.username,
89163
}
90164
)
91165

166+
# Inject absolute image URLs for SES rendering. Braze ignores these extra
167+
# keys; they're consumed only when the SES path is enabled.
168+
canvas_entry_properties.update(_build_enrollment_email_image_urls(language='en'))
169+
92170
try:
93171
course_uuid = get_course_uuid_for_course(course_id)
94172
if course_uuid is None:
@@ -102,25 +180,30 @@ def send_course_enrollment_email(
102180
marketing_root_url = settings.MKTG_URLS.get("ROOT")
103181
instructors = get_instructors(course_run, marketing_root_url)
104182
enrollment_count = int(course_run.get("enrollment_count")) if course_run.get("enrollment_count") else 0
105-
canvas_entry_properties.update(
106-
{
107-
"instructors": instructors,
108-
"instructors_count": "even" if len(instructors) % 2 == 0 else "odd",
109-
"min_effort": course_run.get("min_effort"),
110-
"max_effort": course_run.get("max_effort"),
111-
"weeks_to_complete": course_run.get("weeks_to_complete"),
112-
"learners_count": "{:,}".format(enrollment_count) if enrollment_count > 100 else "",
113-
"banner_image_url": course_run.get("image").get("src", "") if course_run.get("image") else "",
114-
"course_title": course_run.get("title"),
115-
"short_description": course_run.get("short_description"),
116-
"pacing_type": course_run.get("pacing_type"),
117-
"partner_image_url": owners[0].get("logo_image_url") if owners else "",
118-
"org_name": owners[0].get("name") if owners else "",
119-
}
120-
)
183+
canvas_entry_properties.update({
184+
"instructors": instructors,
185+
"instructors_count": "even" if len(instructors) % 2 == 0 else "odd",
186+
"min_effort": course_run.get("min_effort"),
187+
"max_effort": course_run.get("max_effort"),
188+
"weeks_to_complete": course_run.get("weeks_to_complete"),
189+
"learners_count": (
190+
"{:,}".format(enrollment_count) if enrollment_count > 100 else ""
191+
),
192+
"banner_image_url": (
193+
course_run.get("image").get("src", "") if course_run.get("image") else ""
194+
),
195+
"course_title": course_run.get("title"),
196+
"short_description": course_run.get("short_description"),
197+
"pacing_type": course_run.get("pacing_type"),
198+
"partner_image_url": owners[0].get("logo_image_url") if owners else "",
199+
"org_name": owners[0].get("name") if owners else "",
200+
})
121201
except Exception as err: # pylint: disable=broad-except
122202
is_course_run_missing = True
123-
log.warning(f"[Course Enrollment] Course run call failed for user: {user_id} course: {course_id} error: {err}")
203+
log.warning(
204+
f"[Course Enrollment] Course run call failed for user: {user_id} "
205+
f"course: {course_id} error: {err}"
206+
)
124207

125208
if is_course_run_missing or is_course_date_missing:
126209
segment_properties = {
@@ -140,6 +223,8 @@ def send_course_enrollment_email(
140223
canvas_entry_properties=canvas_entry_properties,
141224
)
142225
except Exception as exc: # pylint: disable=broad-except
143-
log.error(f"[Course Enrollment] Email sending failed with exception: {exc}")
226+
log.error(
227+
f"[Course Enrollment] Email sending failed with exception: {exc}"
228+
)
144229
countdown = 60 * (self.request.retries + 1)
145230
raise self.retry(exc=exc, countdown=countdown, max_retries=MAX_RETRIES)

0 commit comments

Comments
 (0)