Merge pull request #16609 from edx/mulby/fix-schedules-landing-page

ensure landing page for scheduled emails is not a redirect

openedx/core/djangoapps/schedules/management/commands/tests/send_email_base.py

@@ -39,14 +39,15 @@ ORG_DEADLINE_QUERY = 1  # courseware_orgdynamicupgradedeadlineconfiguration
 COURSE_DEADLINE_QUERY = 1  # courseware_coursedynamicupgradedeadlineconfiguration
 COMMERCE_CONFIG_QUERY = 1  # commerce_commerceconfiguration
 
-USER_QUERY = 1
+USER_QUERY = 1  # auth_user
 THEME_PREVIEW_QUERY = 1
-THEME_QUERY = 1
-SCHEDULE_CONFIG_QUERY = 1
+THEME_QUERY = 1  # theming_sitetheme
+SCHEDULE_CONFIG_QUERY = 1  # schedules_scheduleconfig
 
 NUM_QUERIES_SITE_SCHEDULES = (
     SITE_QUERY +
     SITE_CONFIG_QUERY +
+    THEME_QUERY +
     SCHEDULES_QUERY
 )
 

openedx/core/djangoapps/schedules/resolvers.py

@@ -10,7 +10,6 @@ from django.core.urlresolvers import reverse
 from django.db.models import F, Q
 from django.utils.formats import dateformat, get_format
 
-
 from edx_ace.recipient_resolver import RecipientResolver
 from edx_ace.recipient import Recipient
 
@@ -22,7 +21,7 @@ from openedx.core.djangoapps.schedules.models import Schedule, ScheduleExperienc
 from openedx.core.djangoapps.schedules.utils import PrefixedDebugLoggerMixin
 from openedx.core.djangoapps.schedules.template_context import get_base_template_context
 from openedx.core.djangoapps.site_configuration.models import SiteConfiguration
-
+from openedx.features.course_experience import course_home_url_name
 
 LOG = logging.getLogger(__name__)
 
@@ -244,7 +243,7 @@ class RecurringNudgeResolver(BinnedSchedulesBaseResolver):
         first_schedule = user_schedules[0]
         context = {
             'course_name': first_schedule.enrollment.course.display_name,
-            'course_url': reverse('course_root', args=[str(first_schedule.enrollment.course_id)]),
+            'course_url': _get_trackable_course_home_url(first_schedule.enrollment.course_id),
         }
 
         # Information for including upsell messaging in template.
@@ -284,7 +283,7 @@ class UpgradeReminderResolver(BinnedSchedulesBaseResolver):
             course_id_str = str(schedule.enrollment.course_id)
             course_id_strs.append(course_id_str)
             course_links.append({
-                'url': reverse('course_root', args=[course_id_str]),
+                'url': _get_trackable_course_home_url(schedule.enrollment.course_id),
                 'name': schedule.enrollment.course.display_name
             })
 
@@ -357,16 +356,33 @@ class CourseUpdateResolver(BinnedSchedulesBaseResolver):
             except CourseUpdateDoesNotExist:
                 continue
 
-            course_id_str = str(enrollment.course_id)
             template_context.update({
                 'course_name': schedule.enrollment.course.display_name,
-                'course_url': reverse('course_root', args=[course_id_str]),
+                'course_url': _get_trackable_course_home_url(enrollment.course_id),
+
                 'week_num': week_num,
                 'week_highlights': week_highlights,
 
                 # This is used by the bulk email optout policy
-                'course_ids': [course_id_str],
+                'course_ids': [str(enrollment.course_id)],
             })
             template_context.update(_get_upsell_information_for_schedule(user, schedule))
 
             yield (user, schedule.enrollment.course.language, template_context)
+
+
+def _get_trackable_course_home_url(course_id):
+    """
+    Get the home page URL for the course.
+
+    NOTE: For us to be able to track clicks in the email, this URL needs to point to a landing page that does not result
+    in a redirect so that the GA snippet can register the UTM parameters.
+
+    Args:
+        course_id (CourseKey): The course to get the home page URL for.
+
+    Returns:
+        A relative path to the course home page.
+    """
+    course_url_name = course_home_url_name(course_id)
+    return reverse(course_url_name, args=[str(course_id)])

openedx/core/djangoapps/schedules/tasks.py

@@ -103,15 +103,20 @@ class ScheduleMessageBaseTask(Task):
     ):
         msg_type = self.make_message_type(day_offset)
         site = Site.objects.select_related('configuration').get(id=site_id)
-        _annotate_for_monitoring(msg_type, site, bin_num, target_day_str, day_offset)
-        return self.resolver(
-            self.async_send_task,
-            site,
-            deserialize(target_day_str),
-            day_offset,
-            bin_num,
-            override_recipient_email=override_recipient_email,
-        ).send(msg_type)
+        middleware_classes = [
+            CurrentRequestUserMiddleware,
+            CurrentSiteThemeMiddleware,
+        ]
+        with emulate_http_request(site=site, middleware_classes=middleware_classes):
+            _annotate_for_monitoring(msg_type, site, bin_num, target_day_str, day_offset)
+            return self.resolver(
+                self.async_send_task,
+                site,
+                deserialize(target_day_str),
+                day_offset,
+                bin_num,
+                override_recipient_email=override_recipient_email,
+            ).send(msg_type)
 
     def make_message_type(self, day_offset):
         raise NotImplementedError