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

Merge pull request #18762 from edx/schen/revert_email_send

Browse Source 
Revert "Add feature to send an e-mail to staff when a student enrolls"
This commit is contained in:
Simon Chen
2018-08-09 15:28:09 -04:00
committed by GitHub
parent 8c5a0b4a38 951b1f8408
commit c5347afd05
7 changed files with 1 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
common/djangoapps/enrollment/apps.py
View File

@@ -1,20 +0,0 @@
"""
Enrollment Application Configuration
Signal handlers are connected here.
"""
from django.apps import AppConfig
class EnrollmentConfig(AppConfig):
"""
Application configuration for enrollments.
"""
name = u'enrollment'
def ready(self):
"""
Connect signal handlers.
"""
from . import handlers # pylint: disable=unused-variable

72
common/djangoapps/enrollment/handlers.py
View File

@@ -1,72 +0,0 @@
"""
Handlers and actions related to enrollment.
"""
import logging
from smtplib import SMTPException
from urlparse import urlunsplit
from django.conf import settings
from django.core.urlresolvers import reverse
from django.core.mail.message import EmailMessage
from django.dispatch import receiver
from edxmako.shortcuts import render_to_string
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
from student.models import ENROLL_STATUS_CHANGE, EnrollStatusChange
LOGGER = logging.getLogger(__name__)
@receiver(ENROLL_STATUS_CHANGE)
def send_email_to_staff_on_student_enrollment(sender, event=None, user=None, **kwargs): # pylint: disable=unused-argument
"""
Sends an e-mail to staff after a new enrollment.
This feature can be enabled by setting the e-mail of the staff in ENROLLMENT_NOTIFICATION_EMAIL in lms.env.json,
or by using a SiteConfiguration variable of the same name (which will override the env one).
Disabled by default.
"""
if event == EnrollStatusChange.enroll:
to_email = configuration_helpers.get_value('ENROLLMENT_NOTIFICATION_EMAIL',
settings.ENROLLMENT_NOTIFICATION_EMAIL)
if not to_email:
# feature disabled
return
course_id = kwargs['course_id']
site_protocol = 'https' if settings.HTTPS == 'on' else 'http'
site_domain = configuration_helpers.get_value('site_domain', settings.SITE_NAME)
context = {
'user': user,
# This full_name is dependent on edx-platform's profile implementation
'user_full_name': user.profile.name if hasattr(user, 'profile') else None,
'course_url': urlunsplit((
site_protocol,
site_domain,
reverse('about_course', args=[course_id.to_deprecated_string()]),
None,
None
)),
'user_admin_url': urlunsplit((
site_protocol,
site_domain,
reverse('admin:auth_user_change', args=[user.id]),
None,
None,
)),
}
subject = ''.join(
render_to_string('emails/new_enrollment_email_subject.txt', context).splitlines()
)
message = render_to_string('emails/new_enrollment_email_body.txt', context)
email = EmailMessage(subject=subject, body=message, from_email=settings.DEFAULT_FROM_EMAIL, to=[to_email])
try:
email.send()
except SMTPException as exception:
LOGGER.error("Failed sending e-mail about new enrollment to %s", to_email)
LOGGER.exception(exception)

81
common/djangoapps/enrollment/tests/test_emails.py
View File

@@ -1,81 +0,0 @@
"""
Tests for e-mail notifications related to user enrollment.
"""
import unittest
from django.conf import settings
from django.core import mail
from django.test.utils import override_settings
from rest_framework.test import APITestCase
from xmodule.modulestore.tests.django_utils import ModuleStoreTestCase
from xmodule.modulestore.tests.factories import CourseFactory
from course_modes.models import CourseMode
from course_modes.tests.factories import CourseModeFactory
from openedx.features.enterprise_support.tests.mixins.enterprise import EnterpriseServiceMockMixin
from student.tests.factories import UserFactory
from .test_views import EnrollmentTestMixin
@override_settings(EDX_API_KEY="i am a key")
@unittest.skipUnless(settings.ROOT_URLCONF == 'lms.urls', 'Test only valid in lms')
@override_settings(ENROLLMENT_NOTIFICATION_EMAIL="some_admins@example.com")
class EnrollmentEmailNotificationTest(EnrollmentTestMixin,
ModuleStoreTestCase,
APITestCase,
EnterpriseServiceMockMixin):
"""
Test e-mails sent to staff when a students enrolls to a course.
"""
USERNAME = "Bob"
EMAIL = "bob@example.com"
PASSWORD = "edx"
ENABLED_CACHES = ['default', 'mongo_metadata_inheritance', 'loc_cache']
ENABLED_SIGNALS = ['course_published']
shard = 3
def setUp(self):
""" Create a course and user, then log in. Also creates a course mode."""
# This function is a simplified version of test_views.EnrollmentTest.setUp
super(EnrollmentEmailNotificationTest, self).setUp()
# Pass emit_signals when creating the course so it would be cached
# as a CourseOverview.
self.course = CourseFactory.create(emit_signals=True)
self.user = UserFactory.create(
username=self.USERNAME,
email=self.EMAIL,
password=self.PASSWORD,
)
self.client.login(username=self.USERNAME, password=self.PASSWORD)
CourseModeFactory.create(
course_id=self.course.id,
mode_slug=CourseMode.DEFAULT_MODE_SLUG,
mode_display_name=CourseMode.DEFAULT_MODE_SLUG,
)
def test_email_sent_to_staff_after_enrollment(self):
"""
Tests that an e-mail is sent on enrollment (but not on other events like unenrollment).
"""
assert len(mail.outbox) == 0
# Create an enrollment and verify some data
self.assert_enrollment_status()
assert len(mail.outbox) == 1
msg = mail.outbox[0]
assert msg.subject == "New student enrollment"
assert msg.to == ["some_admins@example.com"]
# unenroll and check that unenrollment doesn't send additional e-mails
self.assert_enrollment_status(
as_server=True,
is_active=False,
)
assert len(mail.outbox) == 1

10
common/templates/emails/new_enrollment_email_body.txt
View File

@@ -1,10 +0,0 @@
<%! from django.utils.translation import ugettext as _ %>${_("Enrollment received for:")}
% if user_full_name:
${_("Learner: {username} ({full_name})").format(username=user.username, full_name=user_full_name)}
% else:
${_("Learner: {username}").format(username=user.username)}
% endif
${_("Course: {url}").format(url=course_url)}
${_("More learner data in admin: {url}").format(url=user_admin_url)}

2
common/templates/emails/new_enrollment_email_subject.txt
View File

@@ -1,2 +0,0 @@
<%! from django.utils.translation import ugettext as _ %>
${_("New student enrollment")}

2
lms/envs/aws.py
View File

@@ -222,8 +222,6 @@ CONTACT_MAILING_ADDRESS = ENV_TOKENS.get('CONTACT_MAILING_ADDRESS', CONTACT_MAIL
# Account activation email sender address
ACTIVATION_EMAIL_FROM_ADDRESS = ENV_TOKENS.get('ACTIVATION_EMAIL_FROM_ADDRESS', ACTIVATION_EMAIL_FROM_ADDRESS)
ENROLLMENT_NOTIFICATION_EMAIL = ENV_TOKENS.get('ENROLLMENT_NOTIFICATION_EMAIL', ENROLLMENT_NOTIFICATION_EMAIL)
# Currency
PAID_COURSE_REGISTRATION_CURRENCY = ENV_TOKENS.get('PAID_COURSE_REGISTRATION_CURRENCY',
PAID_COURSE_REGISTRATION_CURRENCY)

8
lms/envs/common.py
View File

@@ -1972,12 +1972,6 @@ BULK_EMAIL_LOG_SENT_EMAILS = False
# parallel, and what the SES rate is.
BULK_EMAIL_RETRY_DELAY_BETWEEN_SENDS = 0.02
############################# Enrollment E-mails ####################################
# Used to send an e-mail when students enroll in courses. Write here the destination
# e-mail address, or '' to keep it disabled.
ENROLLMENT_NOTIFICATION_EMAIL = ''
############################# Email Opt In ####################################
# Minimum age for organization-wide email opt in
@@ -2161,7 +2155,7 @@ INSTALLED_APPS = [
'course_modes.apps.CourseModesConfig',
# Enrollment API
'enrollment.apps.EnrollmentConfig',
'enrollment',
# Entitlement API
'entitlements.apps.EntitlementsConfig',