Refactor package rating API changes

- Remove form usage entirely as it was complicating things for no
  benefit
- Create a classmethod in the PackageRating model for performing the
  rating action (and validation of it)
- Update the v1 rating API view to use the new classmethod for
  performing the action
- Move experimental API package rating list to it's own dedicated
  endpoint to avoid slowing down the main current-user endpoint if there
  are lots of ratings
- Cap the rated package count returned by the experimental API to
  improve performance for users with hundreds of rated packages. This
  should be updated to a paginated + local cache solution later on, good
  enough for now.

Author: MythicManiac

django/thunderstore/api/cyberstorm/tests/test_package_rating.py

@@ -10,13 +10,13 @@
 @pytest.mark.django_db
 def test_package_rating_api_view__succeeds(
     api_client: APIClient,
-    package: Package,
+    active_package: Package,
     user: UserType,
 ) -> None:
     api_client.force_authenticate(user)
 
     response = api_client.post(
-        f"/api/cyberstorm/package/{package.namespace}/{package.name}/rate/",
+        f"/api/cyberstorm/package/{active_package.namespace}/{active_package.name}/rate/",
         json.dumps({"target_state": "rated"}),
         content_type="application/json",
     )
@@ -26,7 +26,7 @@ def test_package_rating_api_view__succeeds(
     assert actual["score"] == 1
 
     response = api_client.post(
-        f"/api/cyberstorm/package/{package.namespace}/{package.name}/rate/",
+        f"/api/cyberstorm/package/{active_package.namespace}/{active_package.name}/rate/",
         json.dumps({"target_state": "unrated"}),
         content_type="application/json",
     )
@@ -55,10 +55,10 @@ def test_package_rating_api_view__returns_error_for_non_existent_package(
 @pytest.mark.django_db
 def test_package_rating_api_view__returns_error_for_no_user(
     api_client: APIClient,
-    package: Package,
+    active_package: Package,
 ) -> None:
     response = api_client.post(
-        f"/api/cyberstorm/package/{package.namespace}/{package.name}/rate/",
+        f"/api/cyberstorm/package/{active_package.namespace}/{active_package.name}/rate/",
         json.dumps({"target_state": "rated"}),
         content_type="application/json",
     )
@@ -70,15 +70,13 @@ def test_package_rating_api_view__returns_error_for_no_user(
 @pytest.mark.django_db
 def test_package_rating_api_view__returns_error_for_bad_data(
     api_client: APIClient,
-    package: Package,
+    active_package: Package,
     user: UserType,
 ) -> None:
     api_client.force_authenticate(user)
-    package.is_active = False
-    package.save()
 
     response = api_client.post(
-        f"/api/cyberstorm/package/{package.namespace}/{package.name}/rate/",
+        f"/api/cyberstorm/package/{active_package.namespace}/{active_package.name}/rate/",
         json.dumps({"bad_data": "rated"}),
         content_type="application/json",
     )
@@ -87,10 +85,10 @@ def test_package_rating_api_view__returns_error_for_bad_data(
     assert actual["target_state"] == ["This field is required."]
 
     response = api_client.post(
-        f"/api/cyberstorm/package/{package.namespace}/{package.name}/rate/",
+        f"/api/cyberstorm/package/{active_package.namespace}/{active_package.name}/rate/",
         json.dumps({"target_state": "bad"}),
         content_type="application/json",
     )
     actual = response.json()
 
-    assert actual["__all__"] == ["Given target_state is invalid"]
+    assert actual["non_field_errors"] == ["Invalid target_state"]

django/thunderstore/api/cyberstorm/views/__init__.py

@@ -8,7 +8,7 @@
     PackageListingByDependencyListAPIView,
     PackageListingByNamespaceListAPIView,
 )
-from .package_rating import PackageRatingRateAPIView
+from .package_rating import RatePackageAPIView
 from .package_version_list import PackageVersionListAPIView
 from .team import (
     TeamAPIView,
@@ -32,5 +32,5 @@
     "TeamMemberAddAPIView",
     "TeamMemberListAPIView",
     "TeamServiceAccountListAPIView",
-    "PackageRatingRateAPIView",
+    "RatePackageAPIView",
 ]

django/thunderstore/api/cyberstorm/views/package_rating.py

@@ -1,53 +1,51 @@
 from django.http import HttpRequest
 from rest_framework import serializers
-from rest_framework.exceptions import ValidationError
 from rest_framework.generics import get_object_or_404
 from rest_framework.permissions import IsAuthenticated
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from thunderstore.api.utils import conditional_swagger_auto_schema
-from thunderstore.repository.forms import RateForm
-from thunderstore.repository.models import Package
+from thunderstore.repository.models import Package, PackageRating
 
 
-class CyberstormPackageRatingRateRequestSerialiazer(serializers.Serializer):
+class CyberstormRatePackageRequestSerialiazer(serializers.Serializer):
     target_state = serializers.CharField()
 
 
-class CyberstormPackageRatingRateResponseSerialiazer(serializers.Serializer):
+class CyberstormRatePackageResponseSerialiazer(serializers.Serializer):
     state = serializers.CharField()
     score = serializers.IntegerField()
 
 
-class PackageRatingRateAPIView(APIView):
+class RatePackageAPIView(APIView):
     permission_classes = [IsAuthenticated]
 
     @conditional_swagger_auto_schema(
-        request_body=CyberstormPackageRatingRateRequestSerialiazer,
-        responses={200: CyberstormPackageRatingRateResponseSerialiazer},
-        operation_id="cyberstorm.package_rating.rate",
+        request_body=CyberstormRatePackageRequestSerialiazer,
+        responses={200: CyberstormRatePackageResponseSerialiazer},
+        operation_id="cyberstorm.package.rate",
         tags=["cyberstorm"],
     )
     def post(self, request: HttpRequest, namespace_id: str, package_name: str):
-        serializer = CyberstormPackageRatingRateRequestSerialiazer(data=request.data)
+        serializer = CyberstormRatePackageRequestSerialiazer(data=request.data)
         serializer.is_valid(raise_exception=True)
         package = get_object_or_404(
-            Package,
+            Package.objects.active(),
             namespace__name=namespace_id,
-            name__iexact=package_name,
+            name=package_name,
         )
-        form = RateForm(
-            user=request.user,
+        result_state = PackageRating.rate_package(
+            agent=request.user,
             package=package,
-            data=serializer.validated_data,
+            target_state=serializer.validated_data["target_state"],
+        )
+        package = Package.objects.get(pk=package.pk)
+        return Response(
+            CyberstormRatePackageResponseSerialiazer(
+                {
+                    "state": result_state,
+                    "score": package.rating_score,
+                }
+            ).data
         )
-        if form.is_valid():
-            (result_state, score) = form.execute()
-            return Response(
-                CyberstormPackageRatingRateResponseSerialiazer(
-                    {"state": result_state, "score": score}
-                ).data
-            )
-        else:
-            raise ValidationError(form.errors)

django/thunderstore/api/urls.py

@@ -8,10 +8,10 @@
     PackageListingByCommunityListAPIView,
     PackageListingByDependencyListAPIView,
     PackageListingByNamespaceListAPIView,
-    PackageRatingRateAPIView,
     PackageVersionChangelogAPIView,
     PackageVersionListAPIView,
     PackageVersionReadmeAPIView,
+    RatePackageAPIView,
     TeamAPIView,
     TeamMemberAddAPIView,
     TeamMemberListAPIView,
@@ -81,8 +81,8 @@
     ),
     path(
         "package/<str:namespace_id>/<str:package_name>/rate/",
-        PackageRatingRateAPIView.as_view(),
-        name="cyberstorm.package_rating.rate",
+        RatePackageAPIView.as_view(),
+        name="cyberstorm.package.rate",
     ),
     path(
         "team/<str:team_id>/",

django/thunderstore/core/types.py

@@ -8,11 +8,12 @@
 
     from thunderstore.account.models import UserSettings
     from thunderstore.community.models import Community
-    from thunderstore.repository.models import Team
+    from thunderstore.repository.models import PackageRating, Team
 
     class UserType(User):
         teams: "Manager[Team]"
         settings: Optional[UserSettings]
+        package_ratings: "Manager[PackageRating]"
 
     class HttpRequestType(HttpRequest):
         community: "Optional[Community]"

django/thunderstore/repository/api/experimental/urls.py

@@ -26,11 +26,19 @@
     PackageWikiListAPIView,
 )
 from thunderstore.social.api.experimental.views import CurrentUserExperimentalApiView
+from thunderstore.social.api.experimental.views.current_user import (
+    CurrentUserRatedPackagesExperimentalApiView,
+)
 
 urls = [
     path(
         "current-user/", CurrentUserExperimentalApiView.as_view(), name="current-user"
     ),
+    path(
+        "current-user/rated-packages/",
+        CurrentUserRatedPackagesExperimentalApiView.as_view(),
+        name="current-user.rated-packages",
+    ),
     path("package-index/", PackageIndexApiView.as_view(), name="package-index"),
     path("package/", PackageListApiView.as_view(), name="package-list"),
     path("package/wikis/", PackageWikiListAPIView.as_view(), name="package-wiki-list"),

django/thunderstore/repository/api/v1/viewsets.py

@@ -24,7 +24,6 @@
 from thunderstore.repository.mixins import CommunityMixin
 from thunderstore.repository.models import Package, PackageRating
 from thunderstore.repository.models.cache import APIV1PackageCache
-from thunderstore.repository.permissions import ensure_can_rate_package
 from thunderstore.utils.batch import batch
 
 PACKAGE_SERIALIZER = PackageListingSerializer
@@ -134,15 +133,10 @@ def rate(
         community_identifier: Optional[str] = None,
     ) -> Response:
         package = get_object_or_404(Package.objects.active(), uuid4=uuid4)
-        user = request.user
-        ensure_can_rate_package(user, package)
-        target_state = request.data.get("target_state")
-        if target_state == "rated":
-            PackageRating.objects.get_or_create(rater=user, package=package)
-            result_state = "rated"
-        else:
-            PackageRating.objects.filter(rater=user, package=package).delete()
-            result_state = "unrated"
+        result_state = PackageRating.rate_package(
+            request.user, package, request.data.get("target_state")
+        )
+        package = Package.objects.get(pk=package.pk)
         return Response(
             {
                 "state": result_state,

django/thunderstore/repository/forms/__init__.py

@@ -1,2 +1 @@
-from .package_rating import *
 from .team import *

django/thunderstore/repository/forms/package_rating.py

@@ -1,6 +1,15 @@
+from typing import TYPE_CHECKING, Literal, Optional, Union
+
 from django.conf import settings
+from django.core.exceptions import ValidationError
 from django.db import models
 
+from thunderstore.core.types import UserType
+from thunderstore.repository.permissions import ensure_can_rate_package
+
+if TYPE_CHECKING:
+    from thunderstore.repository.models import Package
+
 
 class PackageRating(models.Model):
     rater = models.ForeignKey(
@@ -26,3 +35,22 @@ class Meta:
 
     def __str__(self):
         return f"{self.rater.username} rating on {self.package.full_package_name}"
+
+    @classmethod
+    def rate_package(
+        cls,
+        agent: Optional[UserType],
+        package: "Package",
+        target_state: Union[Literal["rated"], Literal["unrated"]],
+    ) -> Union[Literal["rated"], Literal["unrated"]]:
+        if target_state not in ("rated", "unrated"):
+            raise ValidationError("Invalid target_state")
+
+        ensure_can_rate_package(agent, package)
+
+        if target_state == "rated":
+            PackageRating.objects.get_or_create(rater=agent, package=package)
+            return "rated"
+        else:
+            PackageRating.objects.filter(rater=agent, package=package).delete()
+            return "unrated"