Feedback V2 (#926)

* started on V2 of feedback * Made more tests for retrieveing feedback details * Started working on the filtering for status and status for feedback * started on fix for filter * fixed filtering * format * format * trigger --------- Co-authored-by: Tam Le <[email protected]>
TIHLDE · Nov 13, 2024 · c8669eb · c8669eb
1 parent 94e5635
commit c8669eb
Show file tree

Hide file tree

Showing 15 changed files with 362 additions and 75 deletions.
diff --git a/app/feedback/factories/bug_factory.py b/app/feedback/factories/bug_factory.py
@@ -11,3 +11,7 @@ class Meta:
 
     title = factory.Sequence(lambda n: f"Bug{n}")
     author = factory.SubFactory(UserFactory)
+    description = factory.Faker("text")
+    url = factory.Faker("url")
+    platform = factory.Faker("word")
+    browser = factory.Faker("word")
diff --git a/app/feedback/factories/idea_factory.py b/app/feedback/factories/idea_factory.py
@@ -11,3 +11,4 @@ class Meta:
 
     title = factory.Sequence(lambda n: f"Idea{n}")
     author = factory.SubFactory(UserFactory)
+    description = factory.Faker("text")
diff --git a/app/feedback/filters/feedback.py b/app/feedback/filters/feedback.py
@@ -0,0 +1,46 @@
+from django.db.models import Q
+from django_filters import rest_framework as filters
+from django_filters.rest_framework import OrderingFilter
+
+from app.feedback.models import Feedback
+from app.feedback.models.bug import Bug
+from app.feedback.models.idea import Idea
+
+
+class FeedbackFilter(filters.FilterSet):
+    feedback_type = filters.CharFilter(
+        method="filter_feedback_type", label="List of feedback type"
+    )
+
+    status = filters.CharFilter(
+        method="filter_status",
+        label="List of feedback status",
+    )
+
+    ordering = OrderingFilter(
+        fields=(
+            "created_at",
+            "updated_at",
+        )
+    )
+
+    def filter_feedback_type(self, queryset, _name, feedback_type):
+        if feedback_type == "Idea":
+            return queryset.filter(Q(instance_of=Idea))
+        elif feedback_type == "Bug":
+            return queryset.filter(Q(instance_of=Bug))
+        else:
+            return queryset
+
+    def filter_status(self, queryset, _name, value):
+        return queryset.filter(status=value)
+
+    class Meta:
+        model = Feedback
+        fields = [
+            "title",
+            "author",
+            "status",
+            "created_at",
+            "updated_at",
+        ]
diff --git a/app/feedback/migrations/0002_alter_feedback_options_bug_browser_bug_platform_and_more.py b/app/feedback/migrations/0002_alter_feedback_options_bug_browser_bug_platform_and_more.py
@@ -0,0 +1,32 @@
+# Generated by Django 4.2.5 on 2024-10-21 18:04
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="feedback",
+            options={"ordering": ("-created_at",)},
+        ),
+        migrations.AddField(
+            model_name="bug",
+            name="Browser",
+            field=models.CharField(default="", max_length=200),
+        ),
+        migrations.AddField(
+            model_name="bug",
+            name="Platform",
+            field=models.CharField(default="", max_length=200),
+        ),
+        migrations.AddField(
+            model_name="bug",
+            name="Url",
+            field=models.URLField(blank=True, null=True),
+        ),
+    ]
diff --git a/app/feedback/migrations/0003_rename_browser_bug_browser_and_more.py b/app/feedback/migrations/0003_rename_browser_bug_browser_and_more.py
@@ -0,0 +1,28 @@
+# Generated by Django 4.2.5 on 2024-10-21 22:18
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("feedback", "0002_alter_feedback_options_bug_browser_bug_platform_and_more"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="bug",
+            old_name="Browser",
+            new_name="browser",
+        ),
+        migrations.RenameField(
+            model_name="bug",
+            old_name="Platform",
+            new_name="platform",
+        ),
+        migrations.RenameField(
+            model_name="bug",
+            old_name="Url",
+            new_name="url",
+        ),
+    ]
diff --git a/app/feedback/models/bug.py b/app/feedback/models/bug.py
@@ -1,5 +1,9 @@
+from django.db import models
+
 from app.feedback.models.feedback import Feedback
 
 
 class Bug(Feedback):
-    pass
+    url = models.URLField(max_length=200, blank=True, null=True)
+    browser = models.CharField(max_length=200, default="")
+    platform = models.CharField(max_length=200, default="")
diff --git a/app/feedback/models/feedback.py b/app/feedback/models/feedback.py
@@ -26,7 +26,7 @@ def __str__(self):
         return f"{self.title} - {self.status}"
 
     class Meta:
-        ordering = ("created_at",)
+        ordering = ("-created_at",)
 
     @classmethod
     def has_read_permission(cls, request):

diff --git a/app/feedback/serializers/__init__.py b/app/feedback/serializers/__init__.py
@@ -1,3 +1,11 @@
-from app.feedback.serializers.bug import BugListSerializer
-from app.feedback.serializers.idea import IdeaListSerializer
+from app.feedback.serializers.bug import (
+    BugDetailSerializer,
+    BugCreateSerializer,
+    BugUpdateSerializer,
+)
+from app.feedback.serializers.idea import (
+    IdeaDetailSerializer,
+    IdeaCreateSerializer,
+    IdeaUpdateSerializer,
+)
 from app.feedback.serializers.feedback import FeedbackListPolymorphicSerializer
diff --git a/app/feedback/serializers/bug.py b/app/feedback/serializers/bug.py
@@ -3,7 +3,7 @@
 from app.feedback.models.bug import Bug
 
 
-class BugListSerializer(BaseModelSerializer):
+class BugSerializer(BaseModelSerializer):
     author = SimpleUserSerializer(read_only=True)
 
     class Meta:
@@ -16,3 +16,49 @@ class Meta:
             "author",
             "description",
         )
+
+
+class BugCreateSerializer(BaseModelSerializer):
+    class Meta:
+        model = Bug
+        fields = (
+            "title",
+            "description",
+        )
+
+    def create(self, validated_data):
+        user = self.context["request"].user
+        validated_data["author"] = user
+
+        return super().create(validated_data)
+
+
+class BugUpdateSerializer(BaseModelSerializer):
+    class Meta:
+        model = Bug
+        fields = (
+            "title",
+            "description",
+            "status",
+        )
+
+        def update(self, instance, validated_data):
+            return super().update(instance, validated_data)
+
+
+class BugDetailSerializer(BaseModelSerializer):
+    author = SimpleUserSerializer(read_only=True)
+
+    class Meta:
+        model = Bug
+        fields = (
+            "id",
+            "title",
+            "description",
+            "status",
+            "created_at",
+            "author",
+            "url",
+            "platform",
+            "browser",
+        )
diff --git a/app/feedback/serializers/feedback.py b/app/feedback/serializers/feedback.py
@@ -2,15 +2,15 @@
 
 from app.common.serializers import BaseModelSerializer
 from app.feedback.models import Bug, Feedback, Idea
-from app.feedback.serializers import BugListSerializer, IdeaListSerializer
+from app.feedback.serializers import BugDetailSerializer, IdeaDetailSerializer
 
 
 class FeedbackListPolymorphicSerializer(PolymorphicSerializer, BaseModelSerializer):
     resource_type_field_name = "feedback_type"
 
     model_serializer_mapping = {
-        Bug: BugListSerializer,
-        Idea: IdeaListSerializer,
+        Bug: BugDetailSerializer,
+        Idea: IdeaDetailSerializer,
     }
 
     class Meta:
@@ -23,59 +23,3 @@ class Meta:
             "author",
             "description",
         )
-
-
-class IdeaCreateSerializer(BaseModelSerializer):
-    class Meta:
-        model = Idea
-        fields = (
-            "title",
-            "description",
-        )
-
-    def create(self, validated_data):
-        user = self.context["request"].user
-        validated_data["author"] = user
-
-        return super().create(validated_data)
-
-
-class BugCreateSerializer(BaseModelSerializer):
-    class Meta:
-        model = Bug
-        fields = (
-            "title",
-            "description",
-        )
-
-    def create(self, validated_data):
-        user = self.context["request"].user
-        validated_data["author"] = user
-
-        return super().create(validated_data)
-
-
-class IdeaUpdateSerializer(BaseModelSerializer):
-    class Meta:
-        model = Feedback
-        fields = (
-            "title",
-            "description",
-            "status",
-        )
-
-        def update(self, instance, validated_data):
-            return super().update(instance, validated_data)
-
-
-class BugUpdateSerializer(BaseModelSerializer):
-    class Meta:
-        model = Feedback
-        fields = (
-            "title",
-            "description",
-            "status",
-        )
-
-        def update(self, instance, validated_data):
-            return super().update(instance, validated_data)
diff --git a/app/feedback/serializers/idea.py b/app/feedback/serializers/idea.py
@@ -3,7 +3,7 @@
 from app.feedback.models.idea import Idea
 
 
-class IdeaListSerializer(BaseModelSerializer):
+class IdeaSerializer(BaseModelSerializer):
     author = SimpleUserSerializer(read_only=True)
 
     class Meta:
@@ -16,3 +16,46 @@ class Meta:
             "author",
             "description",
         )
+
+
+class IdeaCreateSerializer(BaseModelSerializer):
+    class Meta:
+        model = Idea
+        fields = (
+            "title",
+            "description",
+        )
+
+    def create(self, validated_data):
+        user = self.context["request"].user
+        validated_data["author"] = user
+
+        return super().create(validated_data)
+
+
+class IdeaUpdateSerializer(BaseModelSerializer):
+    class Meta:
+        model = Idea
+        fields = (
+            "title",
+            "description",
+            "status",
+        )
+
+        def update(self, instance, validated_data):
+            return super().update(instance, validated_data)
+
+
+class IdeaDetailSerializer(BaseModelSerializer):
+    author = SimpleUserSerializer(read_only=True)
+
+    class Meta:
+        model = Idea
+        fields = (
+            "id",
+            "title",
+            "description",
+            "status",
+            "created_at",
+            "author",
+        )
diff --git a/app/feedback/views/feedback.py b/app/feedback/views/feedback.py
@@ -1,11 +1,13 @@
-from rest_framework import status
+from django_filters.rest_framework import DjangoFilterBackend
+from rest_framework import filters, status
 from rest_framework.response import Response
 
 from app.common.pagination import BasePagination
 from app.common.permissions import BasicViewPermission
 from app.common.viewsets import BaseViewSet
+from app.feedback.filters.feedback import FeedbackFilter
 from app.feedback.models.feedback import Feedback
-from app.feedback.serializers.feedback import (
+from app.feedback.serializers import (
     BugCreateSerializer,
     BugUpdateSerializer,
     FeedbackListPolymorphicSerializer,
@@ -20,6 +22,14 @@ class FeedbackViewSet(BaseViewSet):
     pagination_class = BasePagination
     permission_classes = [BasicViewPermission]
 
+    filter_backends = [DjangoFilterBackend, filters.SearchFilter]
+    filterset_class = FeedbackFilter
+    search_fields = [
+        "title",
+        "author__first_name",
+        "author__last_name",
+    ]
+
     def create(self, request, *_args, **_kwargs):
         data = request.data
 

diff --git a/app/feedback/tests/__init__.py → app/tests/feedback/__init__.py b/app/feedback/tests/__init__.py → app/tests/feedback/__init__.py
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,3 +11,4 @@ class Meta:

		title = factory.Sequence(lambda n: f"Idea{n}")
		author = factory.SubFactory(UserFactory)
		description = factory.Faker("text")