Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update from_addr for default from bulk emails (#29001)

Browse Source 
* fix: update from_addr for default from bulk emails

Co-authored-by: Kevin Valencia <kevin@bitmaker.la>
This commit is contained in:
Kevin Valencia
2021-12-06 10:28:55 -05:00
committed by GitHub
parent 87c2a59d2b
commit fa258de357
3 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lms/djangoapps/bulk_email/tasks.py
View File

@@ -42,7 +42,7 @@ from common.djangoapps.util.date_utils import get_default_time_display
from common.djangoapps.util.string_utils import _has_non_ascii_characters from common.djangoapps.util.string_utils import _has_non_ascii_characters
from lms.djangoapps.branding.api import get_logo_url_for_email from lms.djangoapps.branding.api import get_logo_url_for_email
from lms.djangoapps.bulk_email.api import get_unsubscribed_link from lms.djangoapps.bulk_email.api import get_unsubscribed_link
from lms.djangoapps.bulk_email.toggles import is_email_use_default_from_bulk_enabled from lms.djangoapps.bulk_email.toggles import is_email_use_course_id_from_for_bulk_enabled
from lms.djangoapps.bulk_email.models import CourseEmail, Optout from lms.djangoapps.bulk_email.models import CourseEmail, Optout
from lms.djangoapps.courseware.courses import get_course from lms.djangoapps.courseware.courses import get_course
from lms.djangoapps.instructor_task.models import InstructorTask from lms.djangoapps.instructor_task.models import InstructorTask
@@ -495,10 +495,10 @@ def _send_course_email(entry_id, email_id, to_list, global_email_context, subtas
course_title = global_email_context['course_title'] course_title = global_email_context['course_title']
course_language = global_email_context['course_language'] course_language = global_email_context['course_language']
# If EMAIL_USE_DEFAULT_FROM_FOR_BULK is True, use the default email from address. # If EMAIL_USE_COURSE_ID_FROM_FOR_BULK is False, use the default email from address.
# Otherwise compute a custom from address # Otherwise compute a custom from address
if is_email_use_default_from_bulk_enabled(): if not is_email_use_course_id_from_for_bulk_enabled():
from_addr = settings.DEFAULT_FROM_EMAIL from_addr = settings.BULK_EMAIL_DEFAULT_FROM_EMAIL or settings.DEFAULT_FROM_EMAIL
else: else:
# use the email from address in the CourseEmail, if it is present, otherwise compute it. # use the email from address in the CourseEmail, if it is present, otherwise compute it.
from_addr = course_email.from_addr or _get_source_address(course_email.course_id, course_title, course_language) from_addr = course_email.from_addr or _get_source_address(course_email.course_id, course_title, course_language)

11
lms/djangoapps/bulk_email/tests/test_email.py
View File

@@ -176,7 +176,7 @@ class LocalizedFromAddressPlatformLangTestCase(SendEmailWithMockedUgettextMixin,
""" """
Tests to ensure that the bulk email has the "From" address localized according to LANGUAGE_CODE. Tests to ensure that the bulk email has the "From" address localized according to LANGUAGE_CODE.
""" """
@override_settings(LANGUAGE_CODE='en') @override_settings(LANGUAGE_CODE='en', EMAIL_USE_COURSE_ID_FROM_FOR_BULK=True)
def test_english_platform(self): def test_english_platform(self):
""" """
Ensures that the source-code language (English) works well. Ensures that the source-code language (English) works well.
@@ -186,7 +186,7 @@ class LocalizedFromAddressPlatformLangTestCase(SendEmailWithMockedUgettextMixin,
message = self.send_email() message = self.send_email()
self.assertRegex(message.from_email, '.*Course Staff.*') self.assertRegex(message.from_email, '.*Course Staff.*')
@override_settings(LANGUAGE_CODE='eo') @override_settings(LANGUAGE_CODE='eo', EMAIL_USE_COURSE_ID_FROM_FOR_BULK=True)
def test_esperanto_platform(self): def test_esperanto_platform(self):
""" """
Tests the fake Esperanto language to ensure proper gettext calls. Tests the fake Esperanto language to ensure proper gettext calls.
@@ -220,7 +220,7 @@ class LocalizedFromAddressCourseLangTestCase(SendEmailWithMockedUgettextMixin, E
default_store=ModuleStoreEnum.Type.split default_store=ModuleStoreEnum.Type.split
) )
@override_settings(LANGUAGE_CODE='eo') @override_settings(LANGUAGE_CODE='eo', EMAIL_USE_COURSE_ID_FROM_FOR_BULK=True)
def test_esperanto_platform_arabic_course(self): def test_esperanto_platform_arabic_course(self):
""" """
The course language should override the platform's. The course language should override the platform's.
@@ -249,6 +249,7 @@ class TestEmailSendFromDashboardMockedHtmlToText(EmailSendFromDashboardTestCase)
# We should get back a HttpResponseForbidden (status code 403) # We should get back a HttpResponseForbidden (status code 403)
self.assertContains(response, "Email is not enabled for this course.", status_code=403) self.assertContains(response, "Email is not enabled for this course.", status_code=403)
@override_settings(EMAIL_USE_COURSE_ID_FROM_FOR_BULK=True)
@patch('lms.djangoapps.bulk_email.models.html_to_text', Mock(return_value='Mocking CourseEmail.text_message', autospec=True)) # lint-amnesty, pylint: disable=line-too-long @patch('lms.djangoapps.bulk_email.models.html_to_text', Mock(return_value='Mocking CourseEmail.text_message', autospec=True)) # lint-amnesty, pylint: disable=line-too-long
def test_send_to_self(self): def test_send_to_self(self):
""" """
@@ -288,7 +289,7 @@ class TestEmailSendFromDashboardMockedHtmlToText(EmailSendFromDashboardTestCase)
assert len(mail.outbox) == (1 + len(self.staff)) assert len(mail.outbox) == (1 + len(self.staff))
assert len([e.to[0] for e in mail.outbox]) == len([self.instructor.email] + [s.email for s in self.staff]) assert len([e.to[0] for e in mail.outbox]) == len([self.instructor.email] + [s.email for s in self.staff])
@override_settings(DEFAULT_FROM_EMAIL='test@example.com', EMAIL_USE_DEFAULT_FROM_FOR_BULK=True) @override_settings(DEFAULT_FROM_EMAIL='test@example.com', BULK_EMAIL_DEFAULT_FROM_EMAIL=None, EMAIL_USE_COURSE_ID_FROM_FOR_BULK=False) # lint-amnesty, pylint: disable=line-too-long
def test_email_from_address(self): def test_email_from_address(self):
""" """
Make sure the from_address should be the DEFAULT_FROM_EMAIL when corresponding flag is enabled. Make sure the from_address should be the DEFAULT_FROM_EMAIL when corresponding flag is enabled.
@@ -498,7 +499,7 @@ class TestEmailSendFromDashboardMockedHtmlToText(EmailSendFromDashboardTestCase)
assert len([e.to[0] for e in mail.outbox]) ==\ assert len([e.to[0] for e in mail.outbox]) ==\
len([self.instructor.email] + [s.email for s in self.staff] + [s.email for s in self.students]) len([self.instructor.email] + [s.email for s in self.staff] + [s.email for s in self.students])
@override_settings(BULK_EMAIL_DEFAULT_FROM_EMAIL="no-reply@courseupdates.edx.org") @override_settings(BULK_EMAIL_DEFAULT_FROM_EMAIL="no-reply@courseupdates.edx.org", EMAIL_USE_COURSE_ID_FROM_FOR_BULK=True) # lint-amnesty, pylint: disable=line-too-long
def test_long_course_display_name(self): def test_long_course_display_name(self):
""" """
This test tests that courses with exorbitantly large display names This test tests that courses with exorbitantly large display names

8
lms/djangoapps/bulk_email/toggles.py
View File

@@ -5,14 +5,14 @@ Toggles for bulk_email app
from edx_toggles.toggles import SettingToggle from edx_toggles.toggles import SettingToggle
# .. toggle_name: bulk_email.EMAIL_USE_DEFAULT_FROM_FOR_BULK # .. toggle_name: bulk_email.EMAIL_USE_COURSE_ID_FROM_FOR_BULK
# .. toggle_implementation: DjangoSetting # .. toggle_implementation: DjangoSetting
# .. toggle_default: False # .. toggle_default: False
# .. toggle_description: If True, use the same DEFAULT_FROM_EMAIL as the from_addr for all bulk email, to avoid issues with spam filtering # .. toggle_description: If False, use the same BULK_EMAIL_DEFAULT_FROM_EMAIL or DEFAULT_FROM_EMAIL as the from_addr for all bulk email, to avoid issues with spam filtering
# .. toggle_use_cases: open_edx # .. toggle_use_cases: open_edx
# .. toggle_creation_date: 2020-10-01 # .. toggle_creation_date: 2020-10-01
# .. toggle_tickets: OSPR-4957 # .. toggle_tickets: OSPR-4957
def is_email_use_default_from_bulk_enabled(): def is_email_use_course_id_from_for_bulk_enabled():
return SettingToggle("EMAIL_USE_DEFAULT_FROM_FOR_BULK", default=False).is_enabled() return SettingToggle("EMAIL_USE_COURSE_ID_FROM_FOR_BULK", default=False).is_enabled()