Merge pull request #634 from PROCOLLAB-github/refactor/modules

Refactor/modules

Author: Toksi86

.gitignore

@@ -51,6 +51,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 .idea/
+.codex
 
 # Translations
 *.mo

README.md

@@ -1,70 +1,31 @@
-# Procollab backend service
+# Procollab Backend
 
-## Usage
+Backend API для продукта Procollab.
 
-### Clone project
+## Стек
 
-📌 `git clone https://github.com/procollab-github/api.git`
+- Python
+- Django
+- Django REST Framework
+- Channels
+- Celery
+- PostgreSQL
+- Redis
 
-### Create virtual environment
-
-🔑 Copy `.env.example` to `.env` and change api settings
-
-### Install dependencies
-
-* 🐍 Install poetry with command `pip install poetry`
-* 📎 Install dependencies with command `poetry install`
-
-### Accept migrations
-
-🎓 Run  `python manage.py migrate`
-
-### Run project
-
-🚀 Run project via `python manage.py runserver`
-## For developers
-
-### Install pre-commit hooks
-
-To install pre-commit simply run inside the shell:
+## Базовые команды
 
 ```bash
-pre-commit install
-```
-
-To run it on all of your files, do
-
-```bash
-pre-commit run --all-files
-```
-
-## Troubleshooting
-
-## Errors caused by weasyprint
-
-### MacOS
-
-Error:
-```
-OSError: cannot load library 'pango-1.0-0': dlopen(pango-1.0-0, 0x0002): tried: 'pango-1.0-0' (no such file), '/System/Volumes/Preboot/Cryptexes/OSpango-1.0-0' (no such file), '/Users/yakser/.pyenv/versions/3.11.9/lib/pango-1.0-0' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/Users/yakser/.pyenv/versions/3.11.9/lib/pango-1.0-0' (no such file), '/opt/homebrew/lib/pango-1.0-0' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/opt/homebrew/lib/pango-1.0-0' (no such file), '/usr/lib/pango-1.0-0' (no such file, not in dyld cache), 'pango-1.0-0' (no such file), '/usr/local/lib/pango-1.0-0' (no such file), '/usr/lib/pango-1.0-0' (no such file, not in dyld cache).  Additionally, ctypes.util.find_library() did not manage to locate a library called 'pango-1.0-0'
-```
-
-Fix:
-
-```shell
-brew install weasyprint
-```
-
-### Windows
-
-Error:
+poetry install
+poetry run python manage.py migrate
+poetry run python manage.py runserver
+poetry run python manage.py test
 ```
-OSError: cannot load library 'gobject-2.0-0': error 0x7e.  Additionally, ctypes.util.find_library() did not manage to locate a library called 'gobject-2.0-0'
-```
-
-Fix:
-
-Go to [WeasyPrint docs](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#windows) step by step install dependencies. If the error persists, add the path to the windows environment variable: `C:\msys64\mingw64\bin`
 
+## Документация
 
-## [Docs](/docs/readme.md)
+- [Навигация по документации](docs/readme.md)
+- [Разработка](docs/development.md)
+- [Архитектура](docs/architecture.md)
+- [API](docs/api.md)
+- [Инфраструктура и деплой](docs/devops-state.md)
+- [Доменные модули](docs/modules/readme.md)

courses/admin_config/answers.py

@@ -1,10 +1,25 @@
 from django.contrib import admin
 
-from courses.models import UserTaskAnswer, UserTaskAnswerFile, UserTaskAnswerOption
+from courses.models import (
+    CourseTaskCheckType,
+    UserTaskAnswer,
+    UserTaskAnswerFile,
+    UserTaskAnswerOption,
+)
+from courses.services.progress import recalculate_user_progresses_for_lesson
 
 from .inlines import UserTaskAnswerFileInline, UserTaskAnswerOptionInline
 
 
+REVIEW_PROGRESS_FIELDS = {
+    "status",
+    "is_correct",
+    "review_comment",
+    "reviewed_by",
+    "reviewed_at",
+}
+
+
 @admin.register(UserTaskAnswer)
 class UserTaskAnswerAdmin(admin.ModelAdmin):
     list_display = (
@@ -44,6 +59,16 @@ class UserTaskAnswerAdmin(admin.ModelAdmin):
     )
     inlines = [UserTaskAnswerOptionInline, UserTaskAnswerFileInline]
 
+    def save_model(self, request, obj, form, change):
+        super().save_model(request, obj, form, change)
+
+        changed_fields = set(getattr(form, "changed_data", []) or [])
+        if (
+            obj.task.check_type == CourseTaskCheckType.WITH_REVIEW
+            and changed_fields & REVIEW_PROGRESS_FIELDS
+        ):
+            recalculate_user_progresses_for_lesson(obj.user, obj.task.lesson)
+
 
 @admin.register(UserTaskAnswerOption)
 class UserTaskAnswerOptionAdmin(admin.ModelAdmin):

courses/admin_config/forms.py

@@ -117,6 +117,8 @@ def clean(self):
             "image_upload",
             "В поле изображения можно загрузить только файл изображения.",
         )
+        # TODO: убрать временные флаги, когда upload -> UserFile будет вынесен
+        # в явный admin/service слой до запуска model validation.
         self.instance._has_pending_image_upload = bool(image_upload)
         self.instance._has_pending_attachment_upload = bool(attachment_upload)
         return cleaned_data

courses/api/response.py

@@ -0,0 +1,12 @@
+from rest_framework import serializers
+
+
+def serialize_response(
+    serializer_class: type[serializers.Serializer],
+    payload,
+    *,
+    many: bool = False,
+):
+    serializer = serializer_class(data=payload, many=many)
+    serializer.is_valid(raise_exception=True)
+    return serializer.data

courses/api/views/course_read.py

@@ -5,6 +5,7 @@
     CourseDetailSerializer,
     CourseStructureSerializer,
 )
+from courses.api.response import serialize_response
 from courses.queries import (
     build_course_detail_payload,
     build_course_list_payload,
@@ -17,29 +18,32 @@
 class CourseListAPIView(AuthenticatedCourseAPIView):
 
     def get(self, request):
-        serializer = CourseCardSerializer(
-            data=build_course_list_payload(request.user),
-            many=True,
+        return Response(
+            serialize_response(
+                CourseCardSerializer,
+                build_course_list_payload(request.user),
+                many=True,
+            )
         )
-        serializer.is_valid(raise_exception=True)
-        return Response(serializer.data)
 
 
 class CourseDetailAPIView(AuthenticatedCourseAPIView):
 
     def get(self, request, pk: int):
-        serializer = CourseDetailSerializer(
-            data=build_course_detail_payload(request.user, pk)
+        return Response(
+            serialize_response(
+                CourseDetailSerializer,
+                build_course_detail_payload(request.user, pk),
+            )
         )
-        serializer.is_valid(raise_exception=True)
-        return Response(serializer.data)
 
 
 class CourseStructureAPIView(AuthenticatedCourseAPIView):
 
     def get(self, request, pk: int):
-        serializer = CourseStructureSerializer(
-            data=build_course_structure_payload(request.user, pk)
+        return Response(
+            serialize_response(
+                CourseStructureSerializer,
+                build_course_structure_payload(request.user, pk),
+            )
         )
-        serializer.is_valid(raise_exception=True)
-        return Response(serializer.data)

courses/api/views/lesson_read.py

@@ -1,5 +1,6 @@
 from rest_framework.response import Response
 
+from courses.api.response import serialize_response
 from courses.api.serializers import LessonDetailSerializer
 from courses.queries import build_lesson_detail_payload
 
@@ -9,8 +10,9 @@
 class LessonDetailAPIView(AuthenticatedCourseAPIView):
 
     def get(self, request, pk: int):
-        serializer = LessonDetailSerializer(
-            data=build_lesson_detail_payload(request.user, pk)
+        return Response(
+            serialize_response(
+                LessonDetailSerializer,
+                build_lesson_detail_payload(request.user, pk),
+            )
         )
-        serializer.is_valid(raise_exception=True)
-        return Response(serializer.data)

courses/services/answers.py

@@ -61,15 +61,15 @@ def _resolve_task_options(
     return options
 
 
-def _resolve_user_files(file_ids: list[str]) -> list[UserFile]:
+def _resolve_user_files(user, file_ids: list[str]) -> list[UserFile]:
     if not file_ids:
         return []
 
     unique_ids = list(dict.fromkeys(file_ids))
     if len(unique_ids) != len(file_ids):
         raise ValidationError({"file_ids": "Переданы дублирующиеся файлы."})
 
-    files = list(UserFile.objects.filter(pk__in=unique_ids))
+    files = list(UserFile.objects.filter(pk__in=unique_ids, user=user))
     files_by_id = {file.pk: file for file in files}
     missing_ids = [file_id for file_id in unique_ids if file_id not in files_by_id]
     if missing_ids:
@@ -305,11 +305,12 @@ def _validate_question_task(task: CourseTask) -> None:
 
 
 def _resolve_question_payload(
+    user,
     task: CourseTask,
     payload: TaskAnswerSubmitPayload,
 ) -> tuple[str, list[CourseTaskOption], list[UserFile]]:
     selected_options = _resolve_task_options(task, payload.option_ids)
-    selected_files = _resolve_user_files(payload.file_ids)
+    selected_files = _resolve_user_files(user, payload.file_ids)
     _validate_payload_by_answer_type(
         task,
         payload,
@@ -348,6 +349,7 @@ def _submit_question_answer(
 ) -> SubmitAnswerResult:
     _validate_question_task(task)
     normalized_text, selected_options, selected_files = _resolve_question_payload(
+        user,
         task,
         payload,
     )

courses/tests/helpers.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 from datetime import date, timedelta
 from uuid import uuid4
 
@@ -25,6 +26,14 @@
 from users.models import CustomUser
 
 
+@dataclass(frozen=True)
+class CourseTestContext:
+    user: CustomUser
+    course: Course
+    module: CourseModule
+    lesson: CourseLesson
+
+
 def unique_suffix() -> str:
     return uuid4().hex[:8]
 
@@ -122,6 +131,25 @@ def create_lesson(
     )
 
 
+def create_course_context(
+    *,
+    user_prefix: str = "courses-test",
+    course_title: str = "Course",
+    module_title: str = "Module",
+    lesson_title: str = "Lesson",
+) -> CourseTestContext:
+    user = create_user(prefix=user_prefix)
+    course = create_course(title=course_title)
+    module = create_module(course, title=module_title)
+    lesson = create_lesson(module, title=lesson_title)
+    return CourseTestContext(
+        user=user,
+        course=course,
+        module=module,
+        lesson=lesson,
+    )
+
+
 def create_informational_task(
     lesson: CourseLesson,
     *,