Merge pull request #367 from AvaCodeSolutions/feat/245/non-blocking-quiz

feat: #245 Add non blocking quizzes option

Author: payamnj

django_email_learning/migrations/0010_quiz_is_blocking.py

@@ -0,0 +1,17 @@
+# Generated by Django 6.0.4 on 2026-04-21 13:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("django_email_learning", "0009_quiz_limited_attempts"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="quiz",
+            name="is_blocking",
+            field=models.BooleanField(default=True),
+        ),
+    ]

django_email_learning/models.py

@@ -343,6 +343,7 @@ class Quiz(models.Model):
         validators=[MinValueValidator(1), MaxValueValidator(30)],
     )
     limited_attempts = models.BooleanField(default=True)
+    is_blocking = models.BooleanField(default=True)
 
     class Meta:
         verbose_name_plural = "Quizzes"
@@ -444,6 +445,12 @@ def limited_attempts(self) -> Optional[bool]:
             return self.quiz.limited_attempts
         return None
 
+    @property
+    def is_blocking(self) -> Optional[bool]:
+        if self.type == "quiz" and self.quiz:
+            return self.quiz.is_blocking
+        return None
+
     def human_readable_waiting_period(self) -> str:
         if self.waiting_period < 60:
             return ngettext(

django_email_learning/personalised/api/views.py

@@ -36,6 +36,9 @@ def post(self, request, *args, **kwargs):  # type: ignore[no-untyped-def]
         token = serializer.token
         answers = serializer.answers
 
+        submited_question_ids = {response.id for response in answers}
+        response_map = {response.id: response.answers for response in answers}
+
         try:
             decoded = jwt_service.decode_jwt(token=token)
         except jwt_service.InvalidTokenException as jde:
@@ -83,10 +86,19 @@ def post(self, request, *args, **kwargs):  # type: ignore[no-untyped-def]
             is_passed=passed,
         )
 
-        if passed:
-            delivery.update_hash()  # Invalidate the quiz link after successful submission
-            message = _("Congratulations! You have passed the quiz.")
-            delivery = delivery.schedule_next_delivery()
+        if passed or not quiz.is_blocking:
+            if quiz.is_blocking:
+                delivery.update_hash()  # Invalidate the quiz link after successful submission
+                message = _("Congratulations! You have passed the quiz.")
+            else:
+                message = _("Your quiz submission has been recorded.")
+                if QuizSubmission.objects.filter(delivery=delivery).count() >= 10:
+                    delivery.update_hash()  # Invalidate the quiz link after 10 attempts to prevent abuse
+
+            if (quiz.is_blocking and passed) or QuizSubmission.objects.filter(
+                delivery=delivery
+            ).count() == 1:
+                delivery = delivery.schedule_next_delivery()
 
             if not delivery:
                 enrollment.graduate()
@@ -129,6 +141,7 @@ def post(self, request, *args, **kwargs):  # type: ignore[no-untyped-def]
             organization_id=enrollment.course.organization.id,
             quiz_id=quiz.id,
             is_passed=passed,
+            is_blocking=quiz.is_blocking,
         )
         return JsonResponse(
             {
@@ -137,6 +150,30 @@ def post(self, request, *args, **kwargs):  # type: ignore[no-untyped-def]
                 "required_score": quiz.required_score,
                 "message": message,
                 "is_invalidated": quiz.limited_attempts and not passed,
+                "is_blocking": quiz.is_blocking,
+                "quiz_data": {
+                    "id": quiz.id,
+                    "title": quiz.title,
+                    "questions": [
+                        {
+                            "text": question.text,
+                            "answers": [
+                                {
+                                    "text": answer.text,
+                                    "is_correct": answer.is_correct,
+                                    "user_selected": answer.id
+                                    in response_map.get(question.id, set()),
+                                }
+                                for answer in question.answers.all()
+                            ],
+                        }
+                        for question in quiz.questions.filter(
+                            id__in=submited_question_ids
+                        )
+                    ],
+                }
+                if not quiz.is_blocking
+                else None,
             },
             status=200,
         )

django_email_learning/personalised/views.py

@@ -160,6 +160,9 @@ def get(self, request, *args, **kwargs) -> HttpResponse:  # type: ignore[no-unty
                             "submit": _("Submit"),
                             "try_again": _("Try Again"),
                             "close_window_message": _("You can now close this window!"),
+                            "non_blocking_quiz_caption": _(
+                                "This quiz is for practice and does not affect your course progress. The course content will be sent to you regardless of your quiz answers."
+                            ),
                         },
                     }
                     | self.get_app_context(),

django_email_learning/platform/api/serializers.py

@@ -562,6 +562,7 @@ class UpdateQuiz(BaseModel):
     deadline_days: Optional[int] = Field(
         ge=MIN_QUIZ_DEADLINE, le=MAX_QUIZ_DEADLINE, examples=[14], default=None
     )
+    is_blocking: Optional[bool] = None
 
     model_config = ConfigDict(extra="forbid")
 
@@ -576,6 +577,7 @@ class QuizCreate(BaseModel):
     questions: list[QuestionCreate] = Field(min_length=1)
     type: Literal["quiz"] = "quiz"
     limited_attempts: bool = Field(default=True, examples=[True])
+    is_blocking: bool = Field(default=True, examples=[True])
 
 
 class QuizResponse(BaseModel):
@@ -586,6 +588,7 @@ class QuizResponse(BaseModel):
     deadline_days: int = Field(ge=MIN_QUIZ_DEADLINE, le=MAX_QUIZ_DEADLINE)
     questions: Any  # Will be converted to list in field_serializer
     limited_attempts: bool
+    is_blocking: bool
 
     @field_serializer("questions")
     def serialize_questions(self, questions: Any) -> list[dict]:
@@ -672,6 +675,7 @@ class QuizSubmitedEvent(BaseModel):
     score: int
     is_passed: bool
     attempt_number: int
+    is_practice: bool
 
 
 class ContentSentEvent(BaseModel):
@@ -715,7 +719,7 @@ def from_django_model(enrollment: Enrollment) -> "EnrollmentResponse":
                     event_data=None,
                 )
             )
-        for delivery in enrollment.content_deliveries.all():  # type: ignore[attr-defined]
+        for delivery in enrollment.content_deliveries.all().order_by("id"):  # type: ignore[attr-defined]
             schedule_no = 0
             for schedule in delivery.delivery_schedules.filter(
                 status=DeliveryStatus.DELIVERED
@@ -740,26 +744,34 @@ def from_django_model(enrollment: Enrollment) -> "EnrollmentResponse":
                         "submitted_at"
                     )
                     attempt = None
-                    if schedule_no == 1:
-                        attempt = quiz_attempts.first()
+                    if delivery.course_content.quiz.is_blocking:  # type: ignore[union-attr]
+                        if schedule_no == 1:
+                            attempts = [quiz_attempts.first()]
+                            attempt_number = 1
+                        elif schedule_no > 1:
+                            attempt_number = schedule_no
+                            attempts = list(quiz_attempts[1:])
+                    else:
                         attempt_number = 1
-                    elif schedule_no > 1:
-                        attempt_number = schedule_no
-                        attempt = quiz_attempts[attempt_number - 1 :].first()
-                    if attempt:
-                        events.append(
-                            Event(
-                                type=EventType.QUIZ_SUBMITED,
-                                timestamp=attempt.submitted_at,
-                                event_data=QuizSubmitedEvent(
-                                    quiz_id=delivery.course_content.quiz.id,  # type: ignore[union-attr]
-                                    quiz_title=delivery.course_content.quiz.title,  # type: ignore[union-attr]
-                                    score=attempt.score,
-                                    is_passed=attempt.is_passed,
-                                    attempt_number=attempt_number,
-                                ),
+                        attempts = list(quiz_attempts)
+                    if attempts:
+                        for attempt in [i for i in attempts if i is not None]:  # type: ignore[union-attr]
+                            events.append(
+                                Event(
+                                    type=EventType.QUIZ_SUBMITED,
+                                    timestamp=attempt.submitted_at,
+                                    event_data=QuizSubmitedEvent(
+                                        quiz_id=delivery.course_content.quiz.id,  # type: ignore[union-attr]
+                                        quiz_title=delivery.course_content.quiz.title,  # type: ignore[union-attr]
+                                        score=attempt.score,
+                                        is_passed=attempt.is_passed,
+                                        attempt_number=attempt_number,
+                                        is_practice=delivery.course_content.quiz.is_blocking  # type: ignore[union-attr]
+                                        is False,  # type: ignore[union-attr]
+                                    ),
+                                )
                             )
-                        )
+                            attempt_number += 1
         if (
             enrollment.status == EnrollmentStatus.COMPLETED
             and enrollment.final_state_at
@@ -831,6 +843,7 @@ def to_django_model(self, course: Course) -> CourseContent:
                 selection_strategy=self.content.selection_strategy.value,  # type: ignore[misc]
                 deadline_days=self.content.deadline_days,  # type: ignore[misc]
                 limited_attempts=self.content.limited_attempts,  # type: ignore[misc]
+                is_blocking=self.content.is_blocking,  # type: ignore[misc]
             )
             quiz.save()
             for question_data in self.content.questions:
@@ -910,6 +923,7 @@ class CourseContentSummaryResponse(BaseModel):
     is_published: bool
     type: str
     limited_attempts: Optional[bool] = None
+    is_blocking: Optional[bool] = None
 
     @field_serializer("waiting_period")
     def serialize_waiting_period(self, waiting_period: int) -> dict:

django_email_learning/platform/api/views.py

@@ -293,6 +293,8 @@ def _update_course_content_atomic(
                 quiz.deadline_days = quiz_serializer.deadline_days
             if quiz_serializer.limited_attempts is not None:
                 quiz.limited_attempts = quiz_serializer.limited_attempts
+            if quiz_serializer.is_blocking is not None:
+                quiz.is_blocking = quiz_serializer.is_blocking
             if quiz_serializer.questions is not None:
                 question_ids = set()
                 for question_data in quiz_serializer.questions:

django_email_learning/platform/views.py

@@ -249,6 +249,7 @@ def get_context_data(self, **kwargs) -> dict:  # type: ignore[no-untyped-def]
         context["appContext"]["customComponent"] = None
         context["appContext"]["quizDefaults"] = {
             "limitedAttempts": True,
+            "isBlocking": True,
         }
         context["appContext"]["direction"] = (
             "rtl" if get_language_info(course.language)["bidi"] else "ltr"
@@ -293,6 +294,11 @@ def get_locale_messages(self) -> Dict[str, str]:
             "editing": _("Editing..."),
             "edit_with_ai": _("Edit with AI"),
             "lesson_title": _("Lesson Title"),
+            "blocking_quiz": _("Blocking Quiz"),
+            "blocking_quiz_tooltip": _(
+                "If enabled, learners must pass the quiz to continue receiving course content. For practice quizzes that don't gate content, "
+                "you can disable this option so learners can continue with the course regardless of their quiz performance."
+            ),
             "lesson_waiting_tooltip": _(
                 "Set the amount of time that we should wait after the previous lesson or quiz submission before sending this lesson"
             ),
@@ -326,6 +332,7 @@ def get_locale_messages(self) -> Dict[str, str]:
             "limited_attempts": _("Limited Attempts"),
             "unlimited_attempts": _("Unlimited Attempts"),
             "two_attempts": _("2 Attempts"),
+            "practice_quiz": _("Practice Quiz"),
             "limited_attempts_tooltip": _(
                 "If limited attempts is enabled, learners only have 2 attempts to pass the quiz. "
                 "After 2 failed attempts, they will fail the course and need to restart it. If limited attempts is disabled, "
@@ -510,6 +517,7 @@ def get_locale_messages(self) -> Dict[str, str]:
             "canceled": _("Canceled"),
             "blcoked": _("Blocked"),
             "inactive": _("Inactive"),
+            "practice_attempt": _("Practice Attempt"),
         }
 
 

django_email_learning/ports/metric_recorder_protocol.py

@@ -26,7 +26,12 @@ def user_completed_course(self, course_slug: str, organization_id: int) -> None:
         ...
 
     def quiz_submitted(
-        self, course_slug: str, organization_id: int, quiz_id: int, is_passed: bool
+        self,
+        course_slug: str,
+        organization_id: int,
+        quiz_id: int,
+        is_passed: bool,
+        is_blocking: bool,
     ) -> None:
         ...
 

django_email_learning/services/defaults/log_based_metric_recorder.py

@@ -74,7 +74,12 @@ def user_completed_course(self, course_slug: str, organization_id: int) -> None:
         )
 
     def quiz_submitted(
-        self, course_slug: str, organization_id: int, quiz_id: int, is_passed: bool
+        self,
+        course_slug: str,
+        organization_id: int,
+        quiz_id: int,
+        is_passed: bool,
+        is_blocking: bool,
     ) -> None:
         logger.info(
             "Quiz submitted",
@@ -84,6 +89,7 @@ def quiz_submitted(
                 "organization_id": organization_id,
                 "quiz_id": quiz_id,
                 "is_passed": is_passed,
+                "is_blocking": is_blocking,
             },
         )
 

django_email_learning/services/metrics_service.py

@@ -48,10 +48,15 @@ def user_completed_course(self, course_slug: str, organization_id: int) -> None:
         self.metric_recorder.user_completed_course(course_slug, organization_id)
 
     def quiz_submitted(
-        self, course_slug: str, organization_id: int, quiz_id: int, is_passed: bool
+        self,
+        course_slug: str,
+        organization_id: int,
+        quiz_id: int,
+        is_passed: bool,
+        is_blocking: bool,
     ) -> None:
         self.metric_recorder.quiz_submitted(
-            course_slug, organization_id, quiz_id, is_passed
+            course_slug, organization_id, quiz_id, is_passed, is_blocking
         )
 
     def method_executed(self, method_name: str, execution_time: int) -> None: