LMS app massive changes (#2754)

* lms API: Displaying lesson count in the modules
* lms API: hiding modules that has not been started yet
* lms admin: module archiving, various speedups
* question admin: filtering by course

Some code revamp in the `lms` app:
* Fixed ModuleViewSet name
* lms app serializers split

Author: f213

src/apps/homework/admin/question/admin.py

@@ -19,6 +19,9 @@ class QuestionAdmin(ModelAdmin):
         "product",
         "tariff",
     ]
+    list_filter = [
+        "lesson__module__course__group",
+    ]
     fields = [
         "module",
         "lesson",

src/apps/homework/admin/question/form.py

@@ -10,7 +10,7 @@
 
 
 class QuestionForm(ModelForm):
-    module = forms.ModelChoiceField(label=_("Module"), queryset=Module.objects.for_admin(), required=False)
+    module = forms.ModelChoiceField(label=_("Module"), queryset=Module.objects.for_admin().exclude(archived=True), required=False)
     lesson = forms.ModelChoiceField(label=_("Lesson"), queryset=Lesson.objects.for_admin(), required=False)
 
     class Meta:

src/apps/homework/api/serializers/question.py

@@ -4,6 +4,25 @@
 
 from apps.homework.api.serializers.stats import HomeworkStatsSerializer
 from apps.homework.models import Question
+from apps.products.models import Course
+from core.serializers import MarkdownField
+
+
+class QuestionCourseSerializer(serializers.ModelSerializer):
+    homework_check_recommendations = MarkdownField()
+
+    class Meta:
+        model = Course
+        fields = [
+            "id",
+            "slug",
+            "name",
+            "cover",
+            "chat",
+            "calendar_ios",
+            "calendar_google",
+            "homework_check_recommendations",
+        ]
 
 
 class QuestionSerializer(serializers.ModelSerializer):
@@ -37,16 +56,14 @@ class Meta:
             "course",
         ]
 
-    @extend_schema_field(lazy_serializer("apps.lms.api.serializers.LMSCourseSerializer")())
+    @extend_schema_field(QuestionCourseSerializer)
     def get_course(self, question: Question) -> dict:
-        from apps.lms.api.serializers import LMSCourseSerializer
-
         course = question.get_course(user=self.context["request"].user)
 
         if course is None:
             course = question.get_legacy_course()
 
-        return LMSCourseSerializer(course).data
+        return QuestionCourseSerializer(course).data
 
     @extend_schema_field(lazy_serializer("apps.lms.api.serializers.BreadcrumbsSerializer")())
     def get_breadcrumbs(self, question: Question) -> dict | None:

src/apps/homework/factory.py

@@ -4,7 +4,12 @@
 
 
 @register
-def question(self: FixtureFactory, course: Course | None = None, name: str | None = None, **kwargs: dict) -> Question:
+def question(
+    self: FixtureFactory,
+    course: Course | None = None,
+    name: str | None = None,
+    **kwargs: dict,
+) -> Question:
     question = Question.objects.create(
         name=name or f"Please {self.faker.bs()} two times",
         **kwargs,

src/apps/lms/admin/lesson/admin.py

@@ -34,13 +34,18 @@ class LessonAdmin(ModelAdmin):
     }
 
     list_display = [
-        "name",
+        "id",
         "course_name",
         "module_name",
         "material_title",
         "question_name",
     ]
 
+    list_display_links = [
+        "id",
+        "course_name",
+    ]
+
     class Media:
         js = ["admin/js/vendor/jquery/jquery.js", "admin/add_material_link.js", "admin/remove_call_select.js"]
         css = {
@@ -75,10 +80,6 @@ def question_name(self, lesson: Lesson) -> str:
 
         return "—"
 
-    @admin.display(description=_("Name"))
-    def name(self, lesson: Lesson) -> str:
-        return str(lesson)
-
     def has_add_permission(self, request: HttpRequest) -> bool:
         return False
 

src/apps/lms/admin/module/actions.py

@@ -0,0 +1,44 @@
+from typing import Any
+
+from django.contrib.admin.models import CHANGE
+from django.db.models import QuerySet
+from django.http import HttpRequest
+from django.utils.translation import gettext_lazy as _
+
+from apps.lms.models import Module
+from core.admin import admin
+from core.tasks import write_admin_log
+
+
+@admin.action(description=_("Put to archive"))
+def archive(modeladmin: Any, request: HttpRequest, queryset: QuerySet[Module]) -> None:
+    for module in queryset.iterator():
+        write_admin_log.delay(
+            action_flag=CHANGE,
+            app="lms",
+            model="Module",
+            change_message="Module archived (bulk action)",
+            object_id=module.id,
+            user_id=request.user.id,
+        )
+
+    count = queryset.update(archived=True)
+
+    modeladmin.message_user(request, f"{count} modules archived")
+
+
+@admin.action(description=_("Extract from archive"))
+def unarchive(modeladmin: Any, request: HttpRequest, queryset: QuerySet[Module]) -> None:
+    for module in queryset.iterator():
+        write_admin_log.delay(
+            action_flag=CHANGE,
+            app="lms",
+            model="Module",
+            change_message="Module unarchived (bulk action)",
+            object_id=module.id,
+            user_id=request.user.id,
+        )
+
+    count = queryset.update(archived=False)
+
+    modeladmin.message_user(request, f"{count} modules unarchived")

src/apps/lms/admin/module/admin.py

@@ -4,9 +4,22 @@
 from django.utils.translation import gettext_lazy as _
 
 from apps.lms.admin.lesson.inline import LessonInline
+from apps.lms.admin.module import actions
 from apps.lms.models import Module
 from apps.products.admin.filters import CourseFilter
 from core.admin import ModelAdmin, admin
+from core.admin.filters import DefaultFalseBooleanFilter
+
+
+class Archived(DefaultFalseBooleanFilter):
+    title = _("Archived")
+    parameter_name = "archived"
+
+    def t(self, request: HttpRequest, queryset: QuerySet[Module]) -> QuerySet:
+        return queryset.filter(archived=True)
+
+    def f(self, request: HttpRequest, queryset: QuerySet[Module]) -> QuerySet:
+        return queryset.filter(archived=False)
 
 
 @admin.register(Module)
@@ -15,6 +28,7 @@ class ModuleAdmin(SortableAdminBase, ModelAdmin):
         "name",
         "start_date",
         "course",
+        "archived",
         "description",
         "text",
     ]
@@ -27,12 +41,17 @@ class ModuleAdmin(SortableAdminBase, ModelAdmin):
         "lesson_count",
     ]
     list_filter = [
+        Archived,
         CourseFilter,
     ]
 
     inlines = [
         LessonInline,
     ]
+    actions = [
+        actions.archive,
+        actions.unarchive,
+    ]
 
     class Media:
         js = ["admin/js/vendor/jquery/jquery.js", "admin/autoset-hidden-fiend-during-lesson-adding.js"]

src/apps/lms/api/serializers/__init__.py

@@ -0,0 +1,10 @@
+from apps.lms.api.serializers.breadcrums import BreadcrumbsSerializer
+from apps.lms.api.serializers.lesson import LessonSerializer
+from apps.lms.api.serializers.module import ModuleDetailSerializer, ModuleSerializer
+
+__all__ = [
+    "BreadcrumbsSerializer",
+    "LessonSerializer",
+    "ModuleDetailSerializer",
+    "ModuleSerializer",
+]

src/apps/lms/api/serializers/breadcrums.py

@@ -0,0 +1,50 @@
+from drf_spectacular.utils import extend_schema_field, inline_serializer
+from rest_framework import serializers
+
+from apps.lms.api.serializers.module import ModuleSerializer
+from apps.lms.models import Course, Lesson
+from core.serializers import MarkdownField
+
+
+class LMSCourseSerializer(serializers.ModelSerializer):
+    homework_check_recommendations = MarkdownField()
+
+    class Meta:
+        model = Course
+        fields = [
+            "id",
+            "slug",
+            "name",
+            "cover",
+            "chat",
+            "calendar_ios",
+            "calendar_google",
+            "homework_check_recommendations",
+        ]
+
+
+class BreadcrumbsSerializer(serializers.ModelSerializer):
+    module = ModuleSerializer()
+    course = LMSCourseSerializer(source="module.course")
+    lesson = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Lesson
+        fields = [
+            "module",
+            "course",
+            "lesson",
+        ]
+
+    @extend_schema_field(
+        field=inline_serializer(
+            name="LessonPlainSerializer",
+            fields={
+                "id": serializers.IntegerField(),
+            },
+        )
+    )
+    def get_lesson(self, lesson: Lesson) -> dict:
+        return {
+            "id": lesson.id,
+        }

src/apps/lms/api/serializers.py renamed to src/apps/lms/api/serializers/lesson.py

@@ -1,13 +1,12 @@
 from typing import Literal
 
-from drf_spectacular.utils import OpenApiExample, extend_schema_field, extend_schema_serializer, inline_serializer
+from drf_spectacular.utils import extend_schema_field, inline_serializer
 from rest_framework import serializers
 
 from apps.homework.api.serializers import HomeworkStatsSerializer, QuestionSerializer
 from apps.homework.models import Question
-from apps.lms.models import Call, Course, Lesson, Module
+from apps.lms.models import Call, Lesson
 from apps.notion.models import Material as NotionMaterial
-from core.serializers import MarkdownField
 
 
 class NotionMaterialSerializer(serializers.ModelSerializer):
@@ -109,75 +108,3 @@ def get_homework(self, lesson: Lesson) -> dict | None:
             question = Question.objects.for_user(user).get(pk=lesson.question_id)  # extra N+1 query to annotate the question with statistics
 
             return HomeworkStatsSerializer(question, context=self.context).data
-
-
-@extend_schema_serializer(
-    examples=[
-        OpenApiExample(
-            name="Markdown in descrpition",
-            value={
-                "id": 100500,
-                "name": "Первая неделя",
-                "start_date": "2023-12-01 15:30:00+03:00",
-                "description": "Cамая важная неделя",
-                "text": "<p><strong>Первая</strong> неделя — <em>самая важная неделя</em></p>",
-            },
-        ),
-    ]
-)
-class ModuleSerializer(serializers.ModelSerializer):
-    text = MarkdownField()
-
-    class Meta:
-        model = Module
-        fields = [
-            "id",
-            "name",
-            "start_date",
-            "description",
-            "text",
-        ]
-
-
-class LMSCourseSerializer(serializers.ModelSerializer):
-    homework_check_recommendations = MarkdownField()
-
-    class Meta:
-        model = Course
-        fields = [
-            "id",
-            "slug",
-            "name",
-            "cover",
-            "chat",
-            "calendar_ios",
-            "calendar_google",
-            "homework_check_recommendations",
-        ]
-
-
-class BreadcrumbsSerializer(serializers.ModelSerializer):
-    module = ModuleSerializer()
-    course = LMSCourseSerializer(source="module.course")
-    lesson = serializers.SerializerMethodField()
-
-    class Meta:
-        model = Lesson
-        fields = [
-            "module",
-            "course",
-            "lesson",
-        ]
-
-    @extend_schema_field(
-        field=inline_serializer(
-            name="LessonPlainSerializer",
-            fields={
-                "id": serializers.IntegerField(),
-            },
-        )
-    )
-    def get_lesson(self, lesson: Lesson) -> dict:
-        return {
-            "id": lesson.id,
-        }