api: Add Note view and serializer

Added NoteList api. It allows the user to fetch all notes from a specific test or create a new one Added NoteDetail api. It allows the user to fetch, update and delete notes Signed-off-by: andrepapoti <andrepapoti@gmail.com>
getpatchwork · andrepapoti · Mar 7, 2024 · Mar 7, 2024 · Mar 7, 2024 · Mar 7, 2024
commit a9541d67f9d51f2b206f3ed9e8c9dec4c06084cd
diff --git a/patchwork/api/note.py b/patchwork/api/note.py
@@ -0,0 +1,151 @@
+# Patchwork - automated patch tracking system
+# Copyright (C) 2024 Meta Platforms, Inc. and affiliates.
+#
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+
+from rest_framework import permissions
+from rest_framework.generics import get_object_or_404
+from rest_framework.generics import CreateAPIView
+from rest_framework.generics import RetrieveUpdateDestroyAPIView
+from rest_framework.generics import ListAPIView
+from patchwork.api.patch import PatchSerializer
+from patchwork.api.user import UserDetailSerializer
+from patchwork.api.base import BaseHyperlinkedModelSerializer
+from patchwork.models import Note
+from patchwork.models import Patch
+
+
+class NoteSerializer(BaseHyperlinkedModelSerializer):
+    submitter = UserDetailSerializer(read_only=True)
+    patch = PatchSerializer(read_only=True)
+
+    class Meta:
+        model = Note
+        fields = [
+            'id',
+            'patch',
+            'submitter',
+            'content',
+            'created_at',
+            'updated_at',
+            'maintainer_only',
+        ]
+        read_only_fields = [
+            'id',
+            'patch',
+            'submitter',
+            'created_at',
+            'updated_at',
+            'maintainer_only',
+        ]
+
+
+class NoteDetailPermission(permissions.BasePermission):
+    def has_permission(self, request, view):
+        if request.user.is_superuser:
+            return True
+
+        if request.method == 'POST':
+            if not request.user.is_authenticated:
+                return False
+
+            patch = Patch.objects.get(id=view.kwargs['patch_id'])
+            return (
+                patch.project in request.user.profile.maintainer_projects.all()
+            )
+
+        note = Note.objects.get(id=view.kwargs['note_id'])
+        if not note.maintainer_only:
+            return True
+        elif not request.user.is_authenticated:
+            return False
+
+        return (
+            note.patch.project
+            in request.user.profile.maintainer_projects.all()
+        )
+
+    def has_object_permission(self, request, view, obj):
+        if request.user.is_superuser:
+            return True
+
+        if (
+            not obj.maintainer_only
+            and request.method in permissions.SAFE_METHODS
+        ):
+            return True
+
+        if request.method == 'POST':
+            return (
+                obj.patch.project in request.user.profile.maintainer_projects.all()
+            )
+
+        return (
+            obj.patch.project
+            in request.user.profile.maintainer_projects.all()
+        )
+
+
+class NoteListPermission(permissions.BasePermission):
+    def has_permission(self, request, view):
+        if request.method in permissions.SAFE_METHODS:
+            return True
+        if not request.user.is_authenticated:
+            return False
+        patch = Patch.objects.get(id=view.kwargs['patch_id'])
+        return patch.project in request.user.profile.maintainer_projects.all()
+
+    def has_object_permission(self, request, view, obj):
+        if request.method in permissions.SAFE_METHODS:
+            return True
+
+
+class NoteMixin(object):
+    queryset = Note.objects.all()
+    serializer_class = NoteSerializer
+
+    def get_queryset(self):
+        patch_id = self.kwargs['patch_id']
+        patch = get_object_or_404(Patch, id=patch_id)
+
+        return patch.notes
+
+
+class NoteDetail(NoteMixin, RetrieveUpdateDestroyAPIView):
+    permission_classes = [NoteDetailPermission]
+
+    def get_object(self):
+        queryset = self.filter_queryset(self.get_queryset())
+        note_id = self.kwargs.get('note_id')
+        instance = get_object_or_404(queryset, id=note_id)
+        self.check_object_permissions(self.request, instance)
+        return instance
+
+
+class NoteList(NoteMixin, CreateAPIView, ListAPIView):
+    ordering = 'id'
+    permission_classes = [NoteListPermission]
+
+    def get_queryset(self):
+        user = self.request.user
+        patch_id = self.kwargs['patch_id']
+
+        queryset = super().get_queryset()
+        public_notes = queryset.filter(maintainer_only=False)
+        is_maintainer = user.is_authenticated and \
+            get_object_or_404(Patch, id=patch_id).project \
+            in user.profile.maintainer_projects.all()
+
+        maintainer_notes = queryset.none()
+        if user.is_superuser or (user.is_authenticated and is_maintainer):
+            maintainer_notes = queryset.filter(maintainer_only=True)
+
+        return public_notes | maintainer_notes
+
+    def perform_create(self, serializer):
+        serializer.save(
+            submitter=self.request.user,
+            patch=Patch.objects.get(id=self.kwargs['patch_id']),
+        )
+        return super().perform_create(serializer)