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

feat: prevent sending bulk email to disabled users (#36549)

Browse Source
This commit is contained in:
Muhammad Adeel Tajamul
2025-04-22 12:44:04 +05:00
committed by GitHub
parent 51a48b42a9
commit 6972a6a562
2 changed files with 30 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -181,7 +181,7 @@ def perform_delegate_email_batches(entry_id, course_id, task_input, action_name)
# inefficient OUTER JOIN query that would read the whole user table.
combined_set = recipient_qsets[0].union(*recipient_qsets[1:]) if len(recipient_qsets) > 1 \
else recipient_qsets[0]
recipient_fields = ['profile__name', 'email', 'username']
recipient_fields = ['profile__name', 'email', 'username', 'password']
log.info("Task %s: Preparing to queue subtasks for sending emails for course %s, email %s",
task_id, course_id, email_id)
@@ -350,6 +350,21 @@ def _filter_optouts_from_recipients(to_list, course_id):
return to_list, num_optout
def _filter_disabled_users_from_recipients(to_list, course_key_str):
"""
Filters a user if its account is disabled
"""
user_list = []
disabled_count = 0
for user in to_list:
if user['password'].startswith('!'):
log.info(f"Bulk Email User is disabled {user['email']} in course {course_key_str}")
disabled_count += 1
else:
user_list.append(user)
return user_list, disabled_count
def _get_source_address(course_id, course_title, course_language, truncate=True):
"""
Calculates an email address to be used as the 'from-address' for sent emails.
@@ -485,7 +500,8 @@ def _send_course_email(entry_id, email_id, to_list, global_email_context, subtas
# in the Optout list.
if subtask_status.get_retry_count() == 0:
to_list, num_optout = _filter_optouts_from_recipients(to_list, course_email.course_id)
subtask_status.increment(skipped=num_optout)
to_list, num_disabled = _filter_disabled_users_from_recipients(to_list, str(course_email.course_id))
subtask_status.increment(skipped=num_optout + num_disabled)
course_title = global_email_context['course_title']
course_language = global_email_context['course_language']

12
lms/djangoapps/bulk_email/tests/test_tasks.py
View File

@@ -479,3 +479,15 @@ class TestBulkEmailInstructorTask(InstructorTaskCourseTestCase):
# we should expect only one email to be sent as the other learner is not eligible to receive the message
# based on their last_login date
self._test_run_with_task(send_bulk_course_email, 'emailed', 1, 1)
def test_email_is_not_sent_to_disabled_user(self):
"""
Tests if disabled user are skipped when sending bulk email
"""
user_1 = self.create_student(username="user1", email="user1@example.com")
user_1.set_unusable_password()
user_1.save()
self.create_student(username="user2", email="user2@example.com")
with patch('lms.djangoapps.bulk_email.tasks.get_connection', autospec=True) as get_conn:
get_conn.return_value.send_messages.side_effect = cycle([None])
self._test_run_with_task(send_bulk_course_email, 'emailed', 3, 2, skipped=1)