From 58dcddb5139ed10a73696b901cd6e802950a0343 Mon Sep 17 00:00:00 2001 From: dyudyunov Date: Wed, 19 Jan 2022 15:55:29 +0200 Subject: [PATCH 1/2] fix: certificate generation without Persistent Grades Fix for an error related to endless recursion Dev Notes: The student gets the passing grade -> CourseGradeFactory sends the `COURSE_GRADE_NOW_PASSED` signal after the grade calculation -> `listen_for_passing_grade` receives the signal and calls `generate_certificate_task` -> `generate_certificate_task` calls `_generate_regular_certificate_task` -> `_generate_regular_certificate_task` trying to get grade by calling the `_get_course_grade` -> `_get_course_grade` calls `CourseGradeFactory().read()` but I have persistent grades off, so actually that ends with `CourseGradeFactory().update()` -> `CourseGradeFactory().update()` sends the `COURSE_GRADE_NOW_PASSED` And so on --- .../certificates/generation_handler.py | 6 +- lms/djangoapps/grades/course_grade_factory.py | 55 ++++++++++--------- 2 files changed, 33 insertions(+), 28 deletions(-) diff --git a/lms/djangoapps/certificates/generation_handler.py b/lms/djangoapps/certificates/generation_handler.py index 59ffd4729e46..0c4884d0dc42 100644 --- a/lms/djangoapps/certificates/generation_handler.py +++ b/lms/djangoapps/certificates/generation_handler.py @@ -68,7 +68,7 @@ def _generate_regular_certificate_task(user, course_key, generation_mode=None): eligible and a certificate can be generated. """ enrollment_mode = _get_enrollment_mode(user, course_key) - course_grade = _get_course_grade(user, course_key) + course_grade = _get_course_grade(user, course_key, send_grade_signals=False) if _can_generate_regular_certificate(user, course_key, enrollment_mode, course_grade): return _generate_certificate_task(user=user, course_key=course_key, enrollment_mode=enrollment_mode, course_grade=course_grade, generation_mode=generation_mode) @@ -371,11 +371,11 @@ def _get_grade_value(course_grade): return '' -def _get_course_grade(user, course_key): +def _get_course_grade(user, course_key, send_grade_signals=False): """ Get the user's course grade in this course run. Note that this may be None. """ - return CourseGradeFactory().read(user, course_key=course_key) + return CourseGradeFactory().read(user, course_key=course_key, send_grade_signals=send_grade_signals) def _get_enrollment_mode(user, course_key): diff --git a/lms/djangoapps/grades/course_grade_factory.py b/lms/djangoapps/grades/course_grade_factory.py index 3ca0199f5d6c..01c1b8549a0c 100644 --- a/lms/djangoapps/grades/course_grade_factory.py +++ b/lms/djangoapps/grades/course_grade_factory.py @@ -33,6 +33,7 @@ def read( course_structure=None, course_key=None, create_if_needed=True, + send_grade_signals=True, ): """ Returns the CourseGrade for the given user in the course. @@ -51,7 +52,7 @@ def read( if assume_zero_if_absent(course_data.course_key): return self._create_zero(user, course_data) elif create_if_needed: - return self._update(user, course_data) + return self._update(user, course_data, send_grade_signals=send_grade_signals) else: return None @@ -161,13 +162,16 @@ def _read(user, course_data): ) @staticmethod - def _update(user, course_data, force_update_subsections=False): + def _update(user, course_data, force_update_subsections=False, send_grade_signals=True): """ - Computes, saves, and returns a CourseGrade object for the - given user and course. - Sends a COURSE_GRADE_CHANGED signal to listeners and - COURSE_GRADE_NOW_PASSED if learner has passed course or - COURSE_GRADE_NOW_FAILED if learner is now failing course + Computes, saves, and returns a CourseGrade object for the given user and course. + + send_grade_signals defines if signals should be sent. Use it to avoid recursion issues in + cases when the signal listener trying to get grades but Persistent Grades are disabled. + If True - sends: + COURSE_GRADE_CHANGED signal to listeners and + COURSE_GRADE_NOW_PASSED if learner has passed course or + COURSE_GRADE_NOW_FAILED if learner is now failing course """ should_persist = should_persist_grades(course_data.course_key) if should_persist and force_update_subsections: @@ -194,26 +198,27 @@ def _update(user, course_data, force_update_subsections=False): passed=course_grade.passed, ) - COURSE_GRADE_CHANGED.send_robust( - sender=None, - user=user, - course_grade=course_grade, - course_key=course_data.course_key, - deadline=course_data.course.end, - ) - if course_grade.passed: - COURSE_GRADE_NOW_PASSED.send( - sender=CourseGradeFactory, - user=user, - course_id=course_data.course_key, - ) - else: - COURSE_GRADE_NOW_FAILED.send( - sender=CourseGradeFactory, + if send_grade_signals: + COURSE_GRADE_CHANGED.send_robust( + sender=None, user=user, - course_id=course_data.course_key, - grade=course_grade, + course_grade=course_grade, + course_key=course_data.course_key, + deadline=course_data.course.end, ) + if course_grade.passed: + COURSE_GRADE_NOW_PASSED.send( + sender=CourseGradeFactory, + user=user, + course_id=course_data.course_key, + ) + else: + COURSE_GRADE_NOW_FAILED.send( + sender=CourseGradeFactory, + user=user, + course_id=course_data.course_key, + grade=course_grade, + ) log.info( 'Grades: Update, %s, User: %s, %s, persisted: %s', From b87ba33d132dfb512128d0064c57c8f461e681c0 Mon Sep 17 00:00:00 2001 From: dyudyunov Date: Thu, 20 Jan 2022 12:45:49 +0200 Subject: [PATCH 2/2] test: :ambulance: add test to catch recursion when persistent grades disabled --- .../certificates/generation_handler.py | 7 +++- .../grades/tests/test_course_grade_factory.py | 38 +++++++++++++++++-- 2 files changed, 40 insertions(+), 5 deletions(-) diff --git a/lms/djangoapps/certificates/generation_handler.py b/lms/djangoapps/certificates/generation_handler.py index 0c4884d0dc42..5c261a009551 100644 --- a/lms/djangoapps/certificates/generation_handler.py +++ b/lms/djangoapps/certificates/generation_handler.py @@ -50,7 +50,7 @@ def generate_allowlist_certificate_task(user, course_key, generation_mode=None): Create a task to generate an allowlist certificate for this user in this course run. """ enrollment_mode = _get_enrollment_mode(user, course_key) - course_grade = _get_course_grade(user, course_key) + course_grade = _get_course_grade(user, course_key, send_grade_signals=False) if _can_generate_allowlist_certificate(user, course_key, enrollment_mode): return _generate_certificate_task(user=user, course_key=course_key, enrollment_mode=enrollment_mode, course_grade=course_grade, generation_mode=generation_mode) @@ -371,9 +371,12 @@ def _get_grade_value(course_grade): return '' -def _get_course_grade(user, course_key, send_grade_signals=False): +def _get_course_grade(user, course_key, send_grade_signals=True): """ Get the user's course grade in this course run. Note that this may be None. + + Use send_grade_signals=False to avoid firing the course grade signals recursively. + See details in lms/djangoapps/grades/course_grade_factory.py _update method. """ return CourseGradeFactory().read(user, course_key=course_key, send_grade_signals=send_grade_signals) diff --git a/lms/djangoapps/grades/tests/test_course_grade_factory.py b/lms/djangoapps/grades/tests/test_course_grade_factory.py index 99f851c32808..e5b1e6e708dc 100644 --- a/lms/djangoapps/grades/tests/test_course_grade_factory.py +++ b/lms/djangoapps/grades/tests/test_course_grade_factory.py @@ -2,18 +2,21 @@ Tests for the CourseGradeFactory class. """ import itertools -from unittest.mock import patch +from unittest.mock import patch, Mock import ddt from django.conf import settings from edx_toggles.toggles.testutils import override_waffle_switch +import pytest from common.djangoapps.student.tests.factories import UserFactory +from lms.djangoapps.certificates.config import AUTO_CERTIFICATE_GENERATION from lms.djangoapps.courseware.access import has_access from lms.djangoapps.grades.config.tests.utils import persistent_grades_feature_flags from openedx.core.djangoapps.content.block_structure.factory import BlockStructureFactory -from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase -from xmodule.modulestore.tests.factories import CourseFactory +from openedx.core.djangoapps.signals.signals import COURSE_GRADE_NOW_PASSED +from xmodule.modulestore.tests.django_utils import SharedModuleStoreTestCase # lint-amnesty, pylint: disable=wrong-import-order +from xmodule.modulestore.tests.factories import CourseFactory # lint-amnesty, pylint: disable=wrong-import-order from ..config.waffle import ASSUME_ZERO_GRADE_IF_ABSENT, waffle_switch from ..course_grade import CourseGrade, ZeroCourseGrade @@ -73,6 +76,35 @@ def test_course_grade_feature_gating(self, feature_flag, course_setting): grade_factory.read(self.request.user, self.course) assert mock_read_grade.called == (feature_flag and course_setting) + @patch.dict(settings.FEATURES, {'PERSISTENT_GRADES_ENABLED_FOR_ALL_TESTS': False}) + def test_no_recursion_without_persistent_grades(self): + """ + Course grade signals should not be fired recursively when persistent grades are disabled. + """ + self.mock_process_signal = Mock() # pylint: disable=attribute-defined-outside-init + + def handler(**kwargs): + """ + Mock signal receiver. + """ + self.mock_process_signal() + + with persistent_grades_feature_flags( + global_flag=False, + enabled_for_all_courses=False, + course_id=self.course.id, + enabled_for_course=False + ): + with override_waffle_switch(AUTO_CERTIFICATE_GENERATION, active=True), mock_get_score(2, 2): + COURSE_GRADE_NOW_PASSED.connect(handler) + try: + CourseGradeFactory().update(self.request.user, self.course) + except RecursionError: + pytest.fail("The COURSE_GRADE_NOW_PASSED signal fired recursively.") + + self.mock_process_signal.assert_called_once() + COURSE_GRADE_NOW_PASSED.disconnect(handler) + def test_read_and_update(self): grade_factory = CourseGradeFactory()