Skip to content

fix: setup context for emitting event to segment if desired #36692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions lms/djangoapps/course_home_api/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,12 @@ def collect_progress_for_user_in_course(course_id: str, user_id: str) -> None:
progress["course_id"] = course_id
progress["enrollment_mode"] = enrollment_mode

tracker.emit(
COURSE_COMPLETION_FOR_USER_EVENT_NAME,
progress
)
context = {
"course_id": course_id,
"user_id": user.id,
}
with tracker.get_tracker().context(COURSE_COMPLETION_FOR_USER_EVENT_NAME, context):
tracker.emit(
COURSE_COMPLETION_FOR_USER_EVENT_NAME,
progress
)
20 changes: 18 additions & 2 deletions lms/djangoapps/course_home_api/tests/test_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Tests for Celery tasks used by the `course_home_api` app.
"""

from unittest.mock import patch
from unittest.mock import patch, MagicMock

from opaque_keys.edx.keys import CourseKey
from testfixtures import LogCapture
Expand Down Expand Up @@ -36,10 +36,19 @@ def setUp(self):

@patch("lms.djangoapps.course_home_api.tasks.calculate_progress_for_learner_in_course")
@patch("lms.djangoapps.course_home_api.tasks.tracker.emit")
def test_successful_event_emission(self, mock_tracker, mock_progress):
@patch("lms.djangoapps.course_home_api.tasks.tracker.get_tracker")
def test_successful_event_emission(self, mock_get_tracker, mock_tracker, mock_progress):
"""
Test to ensure a tracker event is emit by the task with the expected completion information.
"""
mock_context_manager = MagicMock()
mock_context_manager.__enter__.return_value = None
mock_context_manager.__exit__.return_value = None

mock_tracker_instance = MagicMock()
mock_tracker_instance.context.return_value = mock_context_manager
mock_get_tracker.return_value = mock_tracker_instance

mock_progress.return_value = {
"complete_count": 5,
"incomplete_count": 2,
Expand All @@ -65,6 +74,13 @@ def test_successful_event_emission(self, mock_tracker, mock_progress):

collect_progress_for_user_in_course(self.course_run_key_string, self.user.id)
mock_progress.assert_called_once_with(CourseKey.from_string(self.course_run_key_string), self.user)
mock_tracker_instance.context.assert_called_once_with(
COURSE_COMPLETION_FOR_USER_EVENT_NAME,
{
"course_id": self.course_run_key_string,
"user_id": self.user.id,
},
)
mock_tracker.assert_called_once_with(
COURSE_COMPLETION_FOR_USER_EVENT_NAME,
expected_data,
Expand Down
Loading