Test HTML Content
" ) + CourseOverview.load_from_module_store(self.course.id) # block_name_to_be_tested can be `html_block` or `vertical_block`. # These attributes help ensure the positive and negative tests are in sync. diff --git a/lms/djangoapps/experiments/factories.py b/lms/djangoapps/experiments/factories.py index d0aa1d89e1..fe7ea054dc 100644 --- a/lms/djangoapps/experiments/factories.py +++ b/lms/djangoapps/experiments/factories.py @@ -1,4 +1,5 @@ import factory +import factory.fuzzy from experiments.models import ExperimentData, ExperimentKeyValue from student.tests.factories import UserFactory diff --git a/lms/djangoapps/experiments/utils.py b/lms/djangoapps/experiments/utils.py index a8e28f68ef..346a8eb991 100644 --- a/lms/djangoapps/experiments/utils.py +++ b/lms/djangoapps/experiments/utils.py @@ -3,21 +3,41 @@ from course_modes.models import ( get_cosmetic_verified_display_price ) from courseware.date_summary import ( - VerifiedUpgradeDeadlineDate + verified_upgrade_deadline_link, verified_upgrade_link_is_valid ) -def check_and_get_upgrade_link(user, course_id): +def check_and_get_upgrade_link_and_date(user, enrollment=None, course=None): """ For an authenticated user, return a link to allow them to upgrade in the specified course. """ - if user.is_authenticated(): - upgrade_data = VerifiedUpgradeDeadlineDate(None, user, course_id=course_id) - if upgrade_data.is_enabled: - return upgrade_data + if enrollment is None and course is None: + raise ValueError("Must specify either an enrollment or a course") - return None + if enrollment: + if course is None: + course = enrollment.course + elif enrollment.course_id != course.id: + raise ValueError("{} refers to a different course than {} which was supplied".format( + enrollment, course + )) + + if enrollment.user_id != user.id: + raise ValueError("{} refers to a different user than {} which was supplied".format( + enrollment, user + )) + + if enrollment is None: + enrollment = CourseEnrollment.get_enrollment(user, course.id) + + if user.is_authenticated() and verified_upgrade_link_is_valid(enrollment): + return ( + verified_upgrade_deadline_link(user, course), + enrollment.upgrade_deadline + ) + + return (None, None) def get_experiment_user_metadata_context(course, user): @@ -26,23 +46,26 @@ def get_experiment_user_metadata_context(course, user): """ enrollment_mode = None enrollment_time = None + enrollment = None try: - enrollment = CourseEnrollment.objects.get(user_id=user.id, course_id=course.id) + enrollment = CourseEnrollment.objects.select_related( + 'course' + ).get(user_id=user.id, course_id=course.id) if enrollment.is_active: enrollment_mode = enrollment.mode enrollment_time = enrollment.created except CourseEnrollment.DoesNotExist: pass # Not enrolled, used the default None values - upgrade_data = check_and_get_upgrade_link(user, course.id) + upgrade_link, upgrade_date = check_and_get_upgrade_link_and_date(user, enrollment, course) return { - 'upgrade_link': upgrade_data and upgrade_data.link, + 'upgrade_link': upgrade_link, 'upgrade_price': unicode(get_cosmetic_verified_display_price(course)), 'enrollment_mode': enrollment_mode, 'enrollment_time': enrollment_time, 'pacing_type': 'self_paced' if course.self_paced else 'instructor_paced', - 'upgrade_deadline': upgrade_data and upgrade_data.date, + 'upgrade_deadline': upgrade_date, 'course_key': course.id, 'course_start': course.start, 'course_end': course.end, diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py index 1eacc49303..5674a9e3ea 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_recurring_nudge.py @@ -10,25 +10,42 @@ from django.conf import settings from edx_ace.channel import ChannelType from edx_ace.test_utils import StubPolicy, patch_channels, patch_policies from edx_ace.utils.date import serialize +from edx_ace.message import Message from mock import Mock, patch from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import CourseLocator +from course_modes.models import CourseMode +from course_modes.tests.factories import CourseModeFactory +from courseware.models import DynamicUpgradeDeadlineConfiguration from openedx.core.djangoapps.schedules import resolvers, tasks from openedx.core.djangoapps.schedules.management.commands import send_recurring_nudge as nudge from openedx.core.djangoapps.schedules.tests.factories import ScheduleConfigFactory, ScheduleFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory, SiteFactory -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms, FilteredQueryCountMixin from student.tests.factories import UserFactory +# 1) Load the current django site +# 2) Query the schedules to find all of the template context information +NUM_QUERIES_NO_MATCHING_SCHEDULES = 2 + +# 3) Query all course modes for all courses in returned schedules +NUM_QUERIES_WITH_MATCHES = NUM_QUERIES_NO_MATCHING_SCHEDULES + 1 + +NUM_COURSE_MODES_QUERIES = 1 + + @ddt.ddt @skip_unless_lms @skipUnless('openedx.core.djangoapps.schedules.apps.SchedulesConfig' in settings.INSTALLED_APPS, "Can't test schedules if the app isn't installed") -class TestSendRecurringNudge(CacheIsolationTestCase): +class TestSendRecurringNudge(FilteredQueryCountMixin, CacheIsolationTestCase): # pylint: disable=protected-access + ENABLED_CACHES = ['default'] + def setUp(self): super(TestSendRecurringNudge, self).setUp() @@ -40,6 +57,8 @@ class TestSendRecurringNudge(CacheIsolationTestCase): self.site_config = SiteConfigurationFactory.create(site=site) ScheduleConfigFactory.create(site=self.site_config.site) + DynamicUpgradeDeadlineConfiguration.objects.create(enabled=True) + @patch.object(nudge.Command, 'resolver_class') def test_handle(self, mock_resolver): test_time = datetime.datetime(2017, 8, 1, tzinfo=pytz.UTC) @@ -73,16 +92,21 @@ class TestSendRecurringNudge(CacheIsolationTestCase): schedules = [ ScheduleFactory.create( start=datetime.datetime(2017, 8, 3, 18, 44, 30, tzinfo=pytz.UTC), - enrollment__user=UserFactory.create(), enrollment__course__id=CourseLocator('edX', 'toy', 'Bin') - ) for _ in range(schedule_count) + ) for i in range(schedule_count) ] + bins_in_use = frozenset((s.enrollment.user.id % tasks.RECURRING_NUDGE_NUM_BINS) for s in schedules) + test_time = datetime.datetime(2017, 8, 3, 18, tzinfo=pytz.UTC) test_time_str = serialize(test_time) for b in range(tasks.RECURRING_NUDGE_NUM_BINS): - # waffle flag takes an extra query before it is cached - with self.assertNumQueries(3 if b == 0 else 2): + expected_queries = NUM_QUERIES_NO_MATCHING_SCHEDULES + if b in bins_in_use: + # to fetch course modes for valid schedules + expected_queries += NUM_COURSE_MODES_QUERIES + + with self.assertNumQueries(expected_queries, table_blacklist=WAFFLE_TABLES): tasks.recurring_nudge_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=-3, bin_num=b, org_list=[schedules[0].enrollment.course.org], @@ -92,9 +116,9 @@ class TestSendRecurringNudge(CacheIsolationTestCase): @patch.object(tasks, '_recurring_nudge_schedule_send') def test_no_course_overview(self, mock_schedule_send): - schedule = ScheduleFactory.create( start=datetime.datetime(2017, 8, 3, 20, 34, 30, tzinfo=pytz.UTC), + enrollment__user=UserFactory.create(), ) schedule.enrollment.course_id = CourseKey.from_string('edX/toy/Not_2012_Fall') schedule.enrollment.save() @@ -102,8 +126,7 @@ class TestSendRecurringNudge(CacheIsolationTestCase): test_time = datetime.datetime(2017, 8, 3, 20, tzinfo=pytz.UTC) test_time_str = serialize(test_time) for b in range(tasks.RECURRING_NUDGE_NUM_BINS): - # waffle flag takes an extra query before it is cached - with self.assertNumQueries(3 if b == 0 else 2): + with self.assertNumQueries(NUM_QUERIES_NO_MATCHING_SCHEDULES, table_blacklist=WAFFLE_TABLES): tasks.recurring_nudge_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=-3, bin_num=b, org_list=[schedule.enrollment.course.org], @@ -175,7 +198,7 @@ class TestSendRecurringNudge(CacheIsolationTestCase): test_time = datetime.datetime(2017, 8, 3, 17, tzinfo=pytz.UTC) test_time_str = serialize(test_time) - with self.assertNumQueries(3): + with self.assertNumQueries(NUM_QUERIES_WITH_MATCHES, table_blacklist=WAFFLE_TABLES): tasks.recurring_nudge_schedule_bin( limited_config.site.id, target_day_str=test_time_str, day_offset=-3, bin_num=0, org_list=org_list, exclude_orgs=exclude_orgs, @@ -199,7 +222,7 @@ class TestSendRecurringNudge(CacheIsolationTestCase): test_time = datetime.datetime(2017, 8, 3, 19, 44, 30, tzinfo=pytz.UTC) test_time_str = serialize(test_time) - with self.assertNumQueries(3): + with self.assertNumQueries(NUM_QUERIES_WITH_MATCHES, table_blacklist=WAFFLE_TABLES): tasks.recurring_nudge_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=-3, bin_num=user.id % tasks.RECURRING_NUDGE_NUM_BINS, @@ -234,24 +257,164 @@ class TestSendRecurringNudge(CacheIsolationTestCase): sent_messages = [] - templates_override = deepcopy(settings.TEMPLATES) - templates_override[0]['OPTIONS']['string_if_invalid'] = "TEMPLATE WARNING - MISSING VARIABLE [%s]" - with self.settings(TEMPLATES=templates_override): + with self.settings(TEMPLATES=self._get_template_overrides()): with patch.object(tasks, '_recurring_nudge_schedule_send') as mock_schedule_send: mock_schedule_send.apply_async = lambda args, *_a, **_kw: sent_messages.append(args) - with self.assertNumQueries(3): + with self.assertNumQueries(NUM_QUERIES_WITH_MATCHES, table_blacklist=WAFFLE_TABLES): tasks.recurring_nudge_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=day, - bin_num=user.id % tasks.RECURRING_NUDGE_NUM_BINS, org_list=[schedules[0].enrollment.course.org], + bin_num=self._calculate_bin_for_user(user), org_list=[schedules[0].enrollment.course.org], ) self.assertEqual(len(sent_messages), 1) - for args in sent_messages: - tasks._recurring_nudge_schedule_send(*args) + # Load the site + # Check the schedule config + with self.assertNumQueries(2): + for args in sent_messages: + tasks._recurring_nudge_schedule_send(*args) self.assertEqual(mock_channel.deliver.call_count, 1) for (_name, (_msg, email), _kwargs) in mock_channel.deliver.mock_calls: for template in attr.astuple(email): self.assertNotIn("TEMPLATE WARNING", template) + + def test_user_in_course_with_verified_coursemode_receives_upsell(self): + user = UserFactory.create() + course_id = CourseLocator('edX', 'toy', 'Course1') + + first_day_of_schedule = datetime.datetime.now(pytz.UTC) + verification_deadline = first_day_of_schedule + datetime.timedelta(days=21) + target_day = first_day_of_schedule + target_hour_as_string = serialize(target_day) + nudge_day = 3 + + schedule = ScheduleFactory.create(start=first_day_of_schedule, + enrollment__user=user, + enrollment__course__id=course_id) + schedule.enrollment.course.self_paced = True + schedule.enrollment.course.save() + + CourseModeFactory( + course_id=course_id, + mode_slug=CourseMode.VERIFIED, + expiration_datetime=verification_deadline + ) + schedule.upgrade_deadline = verification_deadline + + bin_task_parameters = [ + target_hour_as_string, + nudge_day, + user, + schedule.enrollment.course.org + ] + sent_messages = self._stub_sender_and_collect_sent_messages(bin_task=tasks.recurring_nudge_schedule_bin, + stubbed_send_task=patch.object(tasks, '_recurring_nudge_schedule_send'), + bin_task_params=bin_task_parameters) + + self.assertEqual(len(sent_messages), 1) + + message_attributes = sent_messages[0][1] + self.assertTrue(self._contains_upsell_attribute(message_attributes)) + + def test_no_upsell_button_when_DUDConfiguration_is_off(self): + DynamicUpgradeDeadlineConfiguration.objects.create(enabled=False) + + user = UserFactory.create() + course_id = CourseLocator('edX', 'toy', 'Course1') + + first_day_of_schedule = datetime.datetime.now(pytz.UTC) + target_day = first_day_of_schedule + target_hour_as_string = serialize(target_day) + nudge_day = 3 + + schedule = ScheduleFactory.create(start=first_day_of_schedule, + enrollment__user=user, + enrollment__course__id=course_id) + schedule.enrollment.course.self_paced = True + schedule.enrollment.course.save() + + bin_task_parameters = [ + target_hour_as_string, + nudge_day, + user, + schedule.enrollment.course.org + ] + sent_messages = self._stub_sender_and_collect_sent_messages(bin_task=tasks.recurring_nudge_schedule_bin, + stubbed_send_task=patch.object(tasks, '_recurring_nudge_schedule_send'), + bin_task_params=bin_task_parameters) + + self.assertEqual(len(sent_messages), 1) + + message_attributes = sent_messages[0][1] + self.assertFalse(self._contains_upsell_attribute(message_attributes)) + + def test_user_with_no_upgrade_deadline_is_not_upsold(self): + user = UserFactory.create() + course_id = CourseLocator('edX', 'toy', 'Course1') + + first_day_of_schedule = datetime.datetime.now(pytz.UTC) + target_day = first_day_of_schedule + target_hour_as_string = serialize(target_day) + nudge_day = 3 + + schedule = ScheduleFactory.create(start=first_day_of_schedule, + upgrade_deadline=None, + enrollment__user=user, + enrollment__course__id=course_id) + schedule.enrollment.course.self_paced = True + schedule.enrollment.course.save() + + verification_deadline = first_day_of_schedule + datetime.timedelta(days=21) + CourseModeFactory( + course_id=course_id, + mode_slug=CourseMode.VERIFIED, + expiration_datetime=verification_deadline + ) + schedule.upgrade_deadline = verification_deadline + + bin_task_parameters = [ + target_hour_as_string, + nudge_day, + user, + schedule.enrollment.course.org + ] + sent_messages = self._stub_sender_and_collect_sent_messages(bin_task=tasks.recurring_nudge_schedule_bin, + stubbed_send_task=patch.object(tasks, '_recurring_nudge_schedule_send'), + bin_task_params=bin_task_parameters) + + self.assertEqual(len(sent_messages), 1) + + message_attributes = sent_messages[0][1] + self.assertFalse(self._contains_upsell_attribute(message_attributes)) + + def _stub_sender_and_collect_sent_messages(self, bin_task, stubbed_send_task, bin_task_params): + sent_messages = [] + + with self.settings(TEMPLATES=self._get_template_overrides()), stubbed_send_task as mock_schedule_send: + + mock_schedule_send.apply_async = lambda args, *_a, **_kw: sent_messages.append(args) + + bin_task( + self.site_config.site.id, + target_day_str=bin_task_params[0], + day_offset=bin_task_params[1], + bin_num=self._calculate_bin_for_user(bin_task_params[2]), + org_list=[bin_task_params[3]] + ) + + return sent_messages + + def _get_template_overrides(self): + templates_override = deepcopy(settings.TEMPLATES) + templates_override[0]['OPTIONS']['string_if_invalid'] = "TEMPLATE WARNING - MISSING VARIABLE [%s]" + return templates_override + + def _calculate_bin_for_user(self, user): + return user.id % tasks.RECURRING_NUDGE_NUM_BINS + + def _contains_upsell_attribute(self, msg_attr): + msg = Message.from_string(msg_attr) + tmp = msg.context["show_upsell"] + return msg.context["show_upsell"] diff --git a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py index 8a6ed80d0f..9003aa45fd 100644 --- a/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py +++ b/openedx/core/djangoapps/schedules/management/commands/tests/test_send_upgrade_reminder.py @@ -14,21 +14,41 @@ from mock import Mock, patch from opaque_keys.edx.keys import CourseKey from opaque_keys.edx.locator import CourseLocator +from course_modes.models import CourseMode +from course_modes.tests.factories import CourseModeFactory +from courseware.models import DynamicUpgradeDeadlineConfiguration from openedx.core.djangoapps.schedules import resolvers, tasks from openedx.core.djangoapps.schedules.management.commands import send_upgrade_reminder as reminder from openedx.core.djangoapps.schedules.tests.factories import ScheduleConfigFactory, ScheduleFactory from openedx.core.djangoapps.site_configuration.tests.factories import SiteConfigurationFactory, SiteFactory -from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms +from openedx.core.djangoapps.waffle_utils.testutils import WAFFLE_TABLES +from openedx.core.djangolib.testing.utils import CacheIsolationTestCase, skip_unless_lms, FilteredQueryCountMixin from student.tests.factories import UserFactory +# 1) Load the current django site +# 2) Query the schedules to find all of the template context information +NUM_QUERIES_NO_MATCHING_SCHEDULES = 2 + +# 3) Query all course modes for all courses in returned schedules +NUM_QUERIES_WITH_MATCHES = NUM_QUERIES_NO_MATCHING_SCHEDULES + 1 + +# 1) Global dynamic deadline switch +# 2) E-commerce configuration +NUM_QUERIES_WITH_DEADLINE = 2 + +NUM_COURSE_MODES_QUERIES = 1 + + @ddt.ddt @skip_unless_lms @skipUnless('openedx.core.djangoapps.schedules.apps.SchedulesConfig' in settings.INSTALLED_APPS, "Can't test schedules if the app isn't installed") -class TestUpgradeReminder(CacheIsolationTestCase): +class TestUpgradeReminder(FilteredQueryCountMixin, CacheIsolationTestCase): # pylint: disable=protected-access + ENABLED_CACHES = ['default'] + def setUp(self): super(TestUpgradeReminder, self).setUp() @@ -74,20 +94,26 @@ class TestUpgradeReminder(CacheIsolationTestCase): schedules = [ ScheduleFactory.create( upgrade_deadline=datetime.datetime(2017, 8, 3, 18, 44, 30, tzinfo=pytz.UTC), - enrollment__user=UserFactory.create(), enrollment__course__id=CourseLocator('edX', 'toy', 'Bin') - ) for _ in range(schedule_count) + ) for i in range(schedule_count) ] + bins_in_use = frozenset((s.enrollment.user.id % tasks.UPGRADE_REMINDER_NUM_BINS) for s in schedules) + test_time = datetime.datetime(2017, 8, 3, 18, tzinfo=pytz.UTC) test_time_str = serialize(test_time) for b in range(tasks.UPGRADE_REMINDER_NUM_BINS): - # waffle flag takes an extra query before it is cached - with self.assertNumQueries(3 if b == 0 else 2): + expected_queries = NUM_QUERIES_NO_MATCHING_SCHEDULES + if b in bins_in_use: + # to fetch course modes for valid schedules + expected_queries += NUM_COURSE_MODES_QUERIES + + with self.assertNumQueries(expected_queries, table_blacklist=WAFFLE_TABLES): tasks.upgrade_reminder_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=2, bin_num=b, org_list=[schedules[0].enrollment.course.org], ) + self.assertEqual(mock_schedule_send.apply_async.call_count, schedule_count) self.assertFalse(mock_ace.send.called) @@ -103,8 +129,7 @@ class TestUpgradeReminder(CacheIsolationTestCase): test_time = datetime.datetime(2017, 8, 3, 20, tzinfo=pytz.UTC) test_time_str = serialize(test_time) for b in range(tasks.UPGRADE_REMINDER_NUM_BINS): - # waffle flag takes an extra query before it is cached - with self.assertNumQueries(3 if b == 0 else 2): + with self.assertNumQueries(NUM_QUERIES_NO_MATCHING_SCHEDULES, table_blacklist=WAFFLE_TABLES): tasks.upgrade_reminder_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=2, bin_num=b, org_list=[schedule.enrollment.course.org], @@ -176,7 +201,7 @@ class TestUpgradeReminder(CacheIsolationTestCase): test_time = datetime.datetime(2017, 8, 3, 17, tzinfo=pytz.UTC) test_time_str = serialize(test_time) - with self.assertNumQueries(3): + with self.assertNumQueries(NUM_QUERIES_WITH_MATCHES, table_blacklist=WAFFLE_TABLES): tasks.upgrade_reminder_schedule_bin( limited_config.site.id, target_day_str=test_time_str, day_offset=2, bin_num=0, org_list=org_list, exclude_orgs=exclude_orgs, @@ -200,7 +225,7 @@ class TestUpgradeReminder(CacheIsolationTestCase): test_time = datetime.datetime(2017, 8, 3, 19, 44, 30, tzinfo=pytz.UTC) test_time_str = serialize(test_time) - with self.assertNumQueries(3): + with self.assertNumQueries(NUM_QUERIES_WITH_MATCHES, table_blacklist=WAFFLE_TABLES): tasks.upgrade_reminder_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=2, bin_num=user.id % tasks.UPGRADE_REMINDER_NUM_BINS, @@ -212,18 +237,31 @@ class TestUpgradeReminder(CacheIsolationTestCase): @ddt.data(*itertools.product((1, 10, 100), (2, 10))) @ddt.unpack def test_templates(self, message_count, day): + DynamicUpgradeDeadlineConfiguration.objects.create(enabled=True) + now = datetime.datetime.now(pytz.UTC) + future_date = now + datetime.timedelta(days=21) user = UserFactory.create() schedules = [ ScheduleFactory.create( - upgrade_deadline=datetime.datetime(2017, 8, 3, 19, 44, 30, tzinfo=pytz.UTC), + upgrade_deadline=future_date, enrollment__user=user, enrollment__course__id=CourseLocator('edX', 'toy', 'Course{}'.format(course_num)) ) for course_num in range(message_count) ] - test_time = datetime.datetime(2017, 8, 3, 19, tzinfo=pytz.UTC) + for schedule in schedules: + schedule.enrollment.course.self_paced = True + schedule.enrollment.course.save() + + CourseModeFactory( + course_id=schedule.enrollment.course.id, + mode_slug=CourseMode.VERIFIED, + expiration_datetime=future_date + ) + + test_time = future_date test_time_str = serialize(test_time) patch_policies(self, [StubPolicy([ChannelType.PUSH])]) @@ -241,7 +279,10 @@ class TestUpgradeReminder(CacheIsolationTestCase): with patch.object(tasks, '_upgrade_reminder_schedule_send') as mock_schedule_send: mock_schedule_send.apply_async = lambda args, *_a, **_kw: sent_messages.append(args) - with self.assertNumQueries(3): + # we execute one query per course to see if it's opted out of dynamic upgrade deadlines, however, + # since we create a new course for each schedule in this test, we expect there to be one per message + num_expected_queries = NUM_QUERIES_WITH_MATCHES + NUM_QUERIES_WITH_DEADLINE + message_count + with self.assertNumQueries(num_expected_queries, table_blacklist=WAFFLE_TABLES): tasks.upgrade_reminder_schedule_bin( self.site_config.site.id, target_day_str=test_time_str, day_offset=day, bin_num=user.id % tasks.UPGRADE_REMINDER_NUM_BINS, diff --git a/openedx/core/djangoapps/schedules/signals.py b/openedx/core/djangoapps/schedules/signals.py index cbf5201fd4..685118aa64 100644 --- a/openedx/core/djangoapps/schedules/signals.py +++ b/openedx/core/djangoapps/schedules/signals.py @@ -112,7 +112,7 @@ def _get_upgrade_deadline_delta_setting(course_id): # Check if the course has a deadline course_config = CourseDynamicUpgradeDeadlineConfiguration.current(course_id) - if course_config.enabled: + if course_config.enabled and not course_config.opt_out: delta = course_config.deadline_days return delta diff --git a/openedx/core/djangoapps/schedules/tasks.py b/openedx/core/djangoapps/schedules/tasks.py index c9c7a7968b..821c7997c5 100644 --- a/openedx/core/djangoapps/schedules/tasks.py +++ b/openedx/core/djangoapps/schedules/tasks.py @@ -12,6 +12,7 @@ from django.core.urlresolvers import reverse from django.db.models import F, Min from django.db.utils import DatabaseError from django.utils.formats import dateformat, get_format +import pytz from edx_ace import ace from edx_ace.message import Message @@ -19,6 +20,8 @@ from edx_ace.recipient import Recipient from edx_ace.utils.date import deserialize from opaque_keys.edx.keys import CourseKey +from courseware.date_summary import verified_upgrade_deadline_link, verified_upgrade_link_is_valid + from edxmako.shortcuts import marketing_link from openedx.core.djangoapps.schedules.message_type import ScheduleMessageType from openedx.core.djangoapps.schedules.models import Schedule, ScheduleConfig @@ -105,6 +108,40 @@ def _recurring_nudge_schedule_send(site_id, msg_str): # TODO: delete once _recurring_nudge_schedules_for_bin is fully rolled out def _recurring_nudge_schedules_for_hour(site, target_hour, org_list, exclude_orgs=False): + users, schedules = _gather_users_and_schedules_for_target_hour(target_hour, org_list, exclude_orgs) + + dashboard_relative_url = reverse('dashboard') + for (user, user_schedules) in groupby(schedules, lambda s: s.enrollment.user): + user_schedules = list(user_schedules) + course_id_strs = [str(schedule.enrollment.course_id) for schedule in user_schedules] + + first_schedule = user_schedules[0] + + template_context = { + 'student_name': user.profile.name, + + 'course_name': first_schedule.enrollment.course.display_name, + 'course_url': absolute_url(site, reverse('course_root', args=[str(first_schedule.enrollment.course_id)])), + + # This is used by the bulk email optout policy + 'course_ids': course_id_strs, + # Platform information + 'homepage_url': encode_url(marketing_link('ROOT')), + 'dashboard_url': absolute_url(site, dashboard_relative_url), + 'template_revision': settings.EDX_PLATFORM_REVISION, + 'platform_name': settings.PLATFORM_NAME, + 'contact_mailing_address': settings.CONTACT_MAILING_ADDRESS, + 'social_media_urls': encode_urls_in_dict(getattr(settings, 'SOCIAL_MEDIA_FOOTER_URLS', {})), + 'mobile_store_urls': encode_urls_in_dict(getattr(settings, 'MOBILE_STORE_URLS', {})), + } + + # Information for including upsell messaging in template. + _add_upsell_button_information_to_template_context(user, first_schedule, template_context) + + yield (user, first_schedule.enrollment.course.language, template_context) + + +def _gather_users_and_schedules_for_target_hour(target_hour, org_list, exclude_orgs): beginning_of_day = target_hour.replace(hour=0, minute=0, second=0) users = User.objects.filter( courseenrollment__schedule__start__gte=beginning_of_day, @@ -120,6 +157,8 @@ def _recurring_nudge_schedules_for_hour(site, target_hour, org_list, exclude_org schedules = Schedule.objects.select_related( 'enrollment__user__profile', 'enrollment__course', + ).prefetch_related( + 'enrollment__course__modes' ).filter( enrollment__user__in=users, start__gte=beginning_of_day, @@ -138,32 +177,7 @@ def _recurring_nudge_schedules_for_hour(site, target_hour, org_list, exclude_org LOG.debug('Scheduled Nudge: Query = %r', schedules.query.sql_with_params()) - dashboard_relative_url = reverse('dashboard') - - for (user, user_schedules) in groupby(schedules, lambda s: s.enrollment.user): - user_schedules = list(user_schedules) - course_id_strs = [str(schedule.enrollment.course_id) for schedule in user_schedules] - - first_schedule = user_schedules[0] - template_context = { - 'student_name': user.profile.name, - - 'course_name': first_schedule.enrollment.course.display_name, - 'course_url': absolute_url(site, reverse('course_root', args=[str(first_schedule.enrollment.course_id)])), - - # This is used by the bulk email optout policy - 'course_ids': course_id_strs, - - # Platform information - 'homepage_url': encode_url(marketing_link('ROOT')), - 'dashboard_url': absolute_url(site, dashboard_relative_url), - 'template_revision': settings.EDX_PLATFORM_REVISION, - 'platform_name': settings.PLATFORM_NAME, - 'contact_mailing_address': settings.CONTACT_MAILING_ADDRESS, - 'social_media_urls': encode_urls_in_dict(getattr(settings, 'SOCIAL_MEDIA_FOOTER_URLS', {})), - 'mobile_store_urls': encode_urls_in_dict(getattr(settings, 'MOBILE_STORE_URLS', {})), - } - yield (user, first_schedule.enrollment.course.language, template_context) + return users, schedules @task(ignore_result=True, routing_key=ROUTING_KEY) @@ -219,6 +233,10 @@ def _recurring_nudge_schedules_for_bin(site, target_day, bin_num, org_list, excl # This is used by the bulk email optout policy 'course_ids': course_id_strs, }) + + # Information for including upsell messaging in template. + _add_upsell_button_information_to_template_context(user, first_schedule, template_context) + yield (user, first_schedule.enrollment.course.language, template_context) @@ -289,14 +307,6 @@ def _upgrade_reminder_schedules_for_bin(site, target_day, bin_num, org_list, exc template_context.update({ 'student_name': user.profile.name, 'user_personal_address': user.profile.name if user.profile.name else user.username, - 'user_schedule_upgrade_deadline_time': dateformat.format( - schedule.upgrade_deadline, - get_format( - 'DATE_FORMAT', - lang=first_schedule.enrollment.course.language, - use_l10n=True - ) - ), 'course_name': first_schedule.enrollment.course.display_name, 'course_url': absolute_url(site, reverse('course_root', args=[str(first_schedule.enrollment.course_id)])), @@ -306,6 +316,8 @@ def _upgrade_reminder_schedules_for_bin(site, target_day, bin_num, org_list, exc 'cert_image': absolute_url(site, static('course_experience/images/verified-cert.png')), }) + _add_upsell_button_information_to_template_context(user, first_schedule, template_context) + yield (user, first_schedule.enrollment.course.language, template_context) @@ -344,6 +356,8 @@ def get_schedules_with_target_date_by_bin_and_orgs(schedule_date_field, target_d schedules = Schedule.objects.select_related( 'enrollment__user__profile', 'enrollment__course', + ).prefetch_related( + 'enrollment__course__modes' ).filter( enrollment__user__in=users, enrollment__is_active=True, @@ -360,3 +374,32 @@ def get_schedules_with_target_date_by_bin_and_orgs(schedule_date_field, target_d schedules = schedules.using("read_replica") return schedules + + +def _add_upsell_button_information_to_template_context(user, schedule, template_context): + enrollment = schedule.enrollment + course = enrollment.course + + verified_upgrade_link = _get_link_to_purchase_verified_certificate(user, schedule) + has_verified_upgrade_link = verified_upgrade_link is not None + + if has_verified_upgrade_link: + template_context['upsell_link'] = verified_upgrade_link + template_context['user_schedule_upgrade_deadline_time'] = dateformat.format( + enrollment.dynamic_upgrade_deadline, + get_format( + 'DATE_FORMAT', + lang=course.language, + use_l10n=True + ) + ) + + template_context['show_upsell'] = has_verified_upgrade_link + + +def _get_link_to_purchase_verified_certificate(a_user, a_schedule): + enrollment = a_schedule.enrollment + if enrollment.dynamic_upgrade_deadline is None or not verified_upgrade_link_is_valid(enrollment): + return None + + return verified_upgrade_deadline_link(a_user, enrollment.course) diff --git a/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.html b/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.html index 0d7dacd7da..bee7b4e05a 100644 --- a/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.html +++ b/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.html @@ -36,7 +36,7 @@
- + {# email client support for style sheets is pretty spotty, so we have to inline all of these styles #} 1 %} href="{{ dashboard_url }}" @@ -46,20 +46,48 @@ style=" color: #ffffff; text-decoration: none; - border-radius: 4px; - -webkit-border-radius: 4px; - -moz-border-radius: 4px; + border-radius: .3rem; + -webkit-border-radius: .3rem; + -moz-border-radius: .3rem; background-color: #005686; - border-top: 10px solid #005686; - border-bottom: 10px solid #005686; - border-right: 16px solid #005686; - border-left: 16px solid #005686; + border-top: .15rem solid #005686; + border-bottom: .15rem solid #005686; + border-right: .15rem solid #005686; + border-left: .15rem solid #005686; display: inline-block; + padding: 1rem 5rem; "> - + {# old email clients require the use of the font tag :( #} {% trans "Start learning now" %}
+ {% if show_upsell %} ++ {% blocktrans trimmed %} + Don't miss the opportunity to highlight your new knowledge and skills by earning a verified + certificate. Upgrade by {{ user_schedule_upgrade_deadline_time }}. + {% endblocktrans %} +
++ + {% trans "Upgrade Now" %} + +
+ {% endif %} diff --git a/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.txt b/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.txt index a3abd340a1..a6704ac851 100644 --- a/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.txt +++ b/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/recurringnudge_day3/email/body.txt @@ -15,3 +15,12 @@ {% trans "Start learning now" %} <{{ course_url }}> {% endif %} + +{% if show_upsell %} +{% blocktrans trimmed %} + Don't miss the opportunity to highlight your new knowledge and skills by earning a verified + certificate. Upgrade by {{ user_schedule_upgrade_deadline_time }}. + + Upgrade Now! <{{ upsell_link }}> +{% endblocktrans %} +{% endif %} diff --git a/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/upgradereminder/email/body.html b/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/upgradereminder/email/body.html index d33c12d25f..68a1bd2fe9 100644 --- a/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/upgradereminder/email/body.html +++ b/openedx/core/djangoapps/schedules/templates/schedules/edx_ace/upgradereminder/email/body.html @@ -30,7 +30,7 @@ {% endblocktrans %} - +