Raw JSON in Answers (#2744)

* Added json `content` field to the answer
* More straightforward serializers during answer creation
* Linter now fails on django warnings

---------

Co-authored-by: Claude <[email protected]>

Author: f213

Makefile

@@ -14,7 +14,7 @@ lint:
 	poetry run ruff check src
 	poetry run mypy src
 	$(manage) makemigrations --check --no-input --dry-run
-	$(manage) check
+	$(manage) check --fail-level WARNING
 	$(manage) spectacular --api-version v1 --fail-on-warn > /dev/null
 	poetry run toml-sort pyproject.toml --check
 	poetry run pymarkdown scan README.md

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

@@ -1,5 +1,6 @@
 from drf_spectacular.utils import extend_schema_field
 from rest_framework import serializers
+from rest_framework.exceptions import ValidationError
 
 from apps.homework.api.serializers.question import QuestionSerializer
 from apps.homework.api.serializers.reaction import ReactionDetailedSerializer
@@ -12,6 +13,7 @@
 class AnswerSerializer(serializers.ModelSerializer):
     author = UserSafeSerializer()
     text = MarkdownField()
+    legacy_text = MarkdownField(source="text")
     src = serializers.CharField(source="text")
     parent = SoftField(source="parent.slug")  # type: ignore
     question = serializers.CharField(source="question.slug")
@@ -29,6 +31,8 @@ class Meta:
             "author",
             "parent",
             "text",
+            "legacy_text",
+            "content",
             "src",
             "has_descendants",
             "is_editable",
@@ -104,18 +108,28 @@ class Meta:
             "question",
             "parent",
             "text",
+            "content",
         ]
 
 
 class AnswerUpdateSerializer(serializers.ModelSerializer):
-    """For swagger only"""
-
     class Meta:
         model = Answer
         fields = [
             "text",
+            "content",
         ]
 
+    def validate(self, data: dict) -> dict:
+        """Copy-paste from AnswerCreator. Remove it after frontend migration"""
+        text = data.get("text")
+        content = data.get("content")
+        if text is None or len(text) == 0:  # validating json
+            if not isinstance(content, dict) or not len(content.keys()):
+                raise ValidationError("Please provide text or content field")
+
+        return data
+
 
 class AnswerCommentTreeSerializer(AnswerTreeSerializer):
     class Meta:

src/apps/homework/api/viewsets.py

@@ -4,7 +4,7 @@
 from django.utils.decorators import method_decorator
 from django.utils.functional import cached_property
 from drf_spectacular.utils import extend_schema
-from rest_framework.exceptions import MethodNotAllowed, PermissionDenied
+from rest_framework.exceptions import MethodNotAllowed
 from rest_framework.generics import get_object_or_404
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.request import Request
@@ -23,7 +23,7 @@
     ReactionCreateSerializer,
     ReactionDetailedSerializer,
 )
-from apps.homework.models import Answer, Question
+from apps.homework.models import Answer
 from apps.homework.models.answer import AnswerQuerySet
 from apps.homework.models.reaction import Reaction
 from apps.homework.services import ReactionCreator
@@ -53,7 +53,7 @@ class AnswerViewSet(DisablePaginationWithQueryParamMixin, AppViewSet):
     queryset = Answer.objects.for_viewset()
     serializer_class = AnswerSerializer
     serializer_action_classes = {
-        "partial_update": AnswerCreateSerializer,
+        "partial_update": AnswerUpdateSerializer,
         "retrieve": AnswerTreeSerializer,
     }
 
@@ -66,15 +66,15 @@ class AnswerViewSet(DisablePaginationWithQueryParamMixin, AppViewSet):
     @extend_schema(request=AnswerCreateSerializer, responses=AnswerTreeSerializer)
     def create(self, request: Request, *args: Any, **kwargs: dict[str, Any]) -> Response:
         """Create an answer"""
-        self._check_question_permissions(user=self.user, question_slug=request.data["question"])
 
         answer = AnswerCreator(
-            question_slug=request.data["question"],
+            question_slug=request.data.get("question"),  # type: ignore
             parent_slug=request.data.get("parent"),
-            text=request.data["text"],
+            text=request.data.get("text", ""),
+            content=request.data.get("content", {}),
         )()
 
-        answer = self.get_queryset().get(pk=answer.pk)  # augment answer with methods from .for_viewset() to display it properly
+        answer = self.get_queryset().get(pk=answer.pk)  # augment answer with annotations from .for_viewset() to display it properly
         Serializer = self.get_serializer_class(action="retrieve")
         return Response(
             Serializer(
@@ -128,11 +128,6 @@ def limit_queryset_for_list(self, queryset: AnswerQuerySet) -> AnswerQuerySet:
 
         return queryset
 
-    @staticmethod
-    def _check_question_permissions(user: User, question_slug: str) -> None:
-        if not Question.objects.for_user(user).filter(slug=question_slug).exists():
-            raise PermissionDenied()
-
     @property
     def user(self) -> User:
         return self.request.user  # type: ignore

src/apps/homework/migrations/0025_answer_json.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.23 on 2025-08-22 14:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("homework", "0024_drop_question_courses_field"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="answer",
+            name="content",
+            field=models.JSONField(blank=True, null=True, default=dict),
+        ),
+    ]

src/apps/homework/models/answer.py

@@ -62,6 +62,7 @@ class Answer(TestUtilsMixin, TreeNode):
     do_not_crosscheck = models.BooleanField(_("Exclude from cross-checking"), default=False, db_index=True)
 
     text = models.TextField()
+    content = models.JSONField(blank=True, null=True, default=dict)
 
     class Meta:
         verbose_name = _("Homework answer")

src/apps/homework/services/answer_creator.py

@@ -1,10 +1,11 @@
 import contextlib
 from dataclasses import dataclass
+from typing import Callable
 
 from django.db import transaction
 from django.utils import timezone
 from django.utils.functional import cached_property
-from rest_framework.exceptions import NotAuthenticated
+from rest_framework.exceptions import NotAuthenticated, NotFound, ValidationError
 
 from apps.homework.models import Answer, Question
 from apps.studying.models import Study
@@ -17,6 +18,7 @@
 @dataclass
 class AnswerCreator(BaseService):
     text: str
+    content: dict
     question_slug: str
     parent_slug: str | None = None
 
@@ -29,13 +31,21 @@ def act(self) -> Answer:
 
         return instance
 
+    def get_validators(self) -> list[Callable]:
+        return [
+            self.validate_question_slug,
+            self.validate_parent_slug,
+            self.validate_json_or_text,
+        ]
+
     def create(self) -> Answer:
         return Answer.objects.create(
             parent=self.parent,
             question=self.question,
             author=self.author,
             study=self.study,
             text=self.text,
+            content=self.content,
         )
 
     @cached_property
@@ -48,15 +58,23 @@ def author(self) -> User:
 
     @cached_property
     def parent(self) -> Answer | None:
-        if not is_valid_uuid(self.parent_slug):
+        if self.parent_slug is None or len(self.parent_slug) == 0:
             return None
 
         with contextlib.suppress(Answer.DoesNotExist):
             return Answer.objects.get(slug=self.parent_slug)
 
     @cached_property
     def question(self) -> Question:
-        return Question.objects.get(slug=self.question_slug)
+        try:
+            return Question.objects.for_user(
+                self.author,
+            ).get(
+                slug=self.question_slug,
+            )
+
+        except Question.DoesNotExist:
+            raise NotFound()
 
     @cached_property
     def study(self) -> Study | None:
@@ -74,3 +92,24 @@ def is_answer_to_crosscheck(self, instance: Answer) -> bool:
 
     def complete_crosscheck(self, instance: Answer) -> None:
         instance.parent.answercrosscheck_set.filter(checker=self.author).update(checked=timezone.now())
+
+    def validate_json_or_text(self) -> None:
+        """Remove it after frontend migration"""
+        if self.text is None or len(self.text) == 0:  # validating json
+            if not isinstance(self.content, dict) or not len(self.content.keys()):
+                raise ValidationError("Please provide text or content field")
+
+    def validate_question_slug(self) -> None:
+        """Validate only format, database validation is performed later"""
+        if not is_valid_uuid(self.question_slug):
+            raise ValidationError("Question should be a valid uuid")
+
+    def validate_parent_slug(self) -> None:
+        if self.parent_slug is None or not len(self.parent_slug):  # adding a root answer
+            return
+
+        if not is_valid_uuid(self.parent_slug):
+            raise ValidationError("Question should be a valid uuid")
+
+        if not Answer.objects.filter(slug=self.parent_slug).exists():
+            raise ValidationError("Answer does not exist")

src/apps/homework/tests/homework/api/answers/list/tests_answer_list.py

@@ -22,8 +22,7 @@ def test_ok(api, question, answer):
     assert got[0]["modified"] == "2022-10-09T10:30:12+12:00"
     assert got[0]["slug"] == str(answer.slug)
     assert got[0]["question"] == str(answer.question.slug)
-    assert "<em>test</em>" in got[0]["text"]
-    assert got[0]["src"] == "*test*"
+    assert got[0]["content"]["type"] == "doc"
     assert got[0]["author"]["uuid"] == str(api.user.uuid)
     assert got[0]["author"]["first_name"] == api.user.first_name
     assert got[0]["author"]["last_name"] == api.user.last_name
@@ -33,6 +32,26 @@ def test_ok(api, question, answer):
     assert got[0]["reactions"] == []
 
 
+def test_text_content(api, question, answer):
+    answer.update(content={}, text="*legacy*")
+
+    got = api.get(f"/api/v2/homework/answers/?question={question.slug}")["results"]
+
+    assert got[0]["content"] == {}
+    assert "legacy" in got[0]["text"]
+    assert "legacy" in got[0]["legacy_text"]
+    assert "<em>" in got[0]["legacy_text"]
+
+
+def test_json_content(api, question, answer):
+    answer.update(content={"type": "doc"}, text="")
+
+    got = api.get(f"/api/v2/homework/answers/?question={question.slug}")["results"]
+
+    assert got[0]["content"]["type"] == "doc"
+    assert got[0]["text"] == ""
+
+
 def test_has_reaction_fields_if_there_is_reaction(api, question, reaction):
     got = api.get(f"/api/v2/homework/answers/?question={question.slug}")["results"]
 

src/apps/homework/tests/homework/api/answers/retrieve/tests_answer_retrieve.py

@@ -25,8 +25,28 @@ def test_ok(api, answer, question):
     assert got["descendants"] == []
     assert got["is_editable"] is True
     assert got["reactions"] == []
-    assert "text" in got
-    assert "src" in got
+    assert got["content"]["type"] == "doc"
+
+
+def test_text_content(api, answer):
+    answer.update(content={}, text="*legacy*")
+
+    got = api.get(f"/api/v2/homework/answers/{answer.slug}/")
+
+    assert got["content"] == {}
+    assert "legacy" in got["text"]
+    assert "legacy" in got["legacy_text"]
+    assert "<em>" in got["legacy_text"]
+
+
+def test_json_content(api, answer):
+    answer.update(content={"type": "doc"}, text="")
+
+    got = api.get(f"/api/v2/homework/answers/{answer.slug}/")
+
+    assert got["content"]["type"] == "doc"
+    assert got["text"] == ""
+    assert got["legacy_text"] == ""
 
 
 def test_has_descendants_is_true_if_answer_has_children(api, answer, another_answer, another_user):
@@ -93,15 +113,6 @@ def test_query_count_for_answer_without_descendants(api, answer, django_assert_n
         api.get(f"/api/v2/homework/answers/{answer.slug}/")
 
 
-def test_markdown(api, answer):
-    answer.update(text="*should be rendered*")
-
-    got = api.get(f"/api/v2/homework/answers/{answer.slug}/")
-
-    assert got["text"].startswith("<p><em>should be rendered"), f'"{got["text"]}" should start with "<p><em>should be rendered"'
-    assert got["src"] == "*should be rendered*"
-
-
 def test_non_root_answers_are_ok(api, answer, another_answer):
     answer.update(parent=another_answer)