Make community_list endpoint support required functionality

django/thunderstore/api/cyberstorm/serializers/community.py

@@ -4,8 +4,10 @@
 class CyberstormCommunitySerializer(serializers.Serializer):
     name = serializers.CharField()
     identifier = serializers.CharField()
+    description = serializers.CharField(required=False)
+    discord_url = serializers.CharField(required=False)
+    datetime_created = serializers.DateTimeField()
+    background_image_url = serializers.CharField(required=False)
+    icon_url = serializers.CharField(required=False)
     total_download_count = serializers.IntegerField()
     total_package_count = serializers.IntegerField()
-    background_image_url = serializers.CharField(required=False)
-    description = serializers.CharField()
-    discord_url = serializers.CharField(required=False)

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

@@ -1,3 +1,4 @@
+from rest_framework.filters import SearchFilter
 from rest_framework.generics import ListAPIView
 from rest_framework.pagination import PageNumberPagination
 
@@ -7,14 +8,15 @@
 
 
 class CommunityPaginator(PageNumberPagination):
-    page_size = 100
+    page_size = 150
 
 
 class CommunityListAPIView(ListAPIView):
     permission_classes = []
     serializer_class = CyberstormCommunitySerializer
     pagination_class = CommunityPaginator
     queryset = Community.objects.listed()
-    filter_backends = [StrictOrderingFilter]
-    ordering_fields = ["identifier"]
+    filter_backends = [SearchFilter, StrictOrderingFilter]
+    search_fields = ["description", "name"]
+    ordering_fields = ["datetime_created", "identifier", "name"]
     ordering = ["identifier"]

django/thunderstore/community/models/community.py

@@ -1,5 +1,6 @@
 from typing import TYPE_CHECKING, Optional
 
+from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models import Manager, QuerySet
@@ -66,12 +67,29 @@
     @property
     def total_package_count(self) -> int:
         # TODO: Implement as a cached value with background updates
-        return -1
+        if not settings.DEBUG:
+            return -1
+
+        listings = self.package_listings.active()
+
+        if self.require_package_listing_approval:
+            listings = listings.approved()
+
+        return listings.count()
 
     @property
     def total_download_count(self) -> int:
         # TODO: Implement as a cached value with background updates
-        return -1
+        # TODO: also figure out more efficient way to handle this
+        if not settings.DEBUG:
+            return -1
+
+        listings = self.package_listings.active()
+
+        if self.require_package_listing_approval:
+            listings = listings.approved()
+
+        return sum([l.total_downloads for l in listings])
 
     def save(self, *args, **kwargs):
         if self.pk:
@@ -123,6 +141,13 @@
         """
         return None if not bool(self.background_image) else self.background_image.url
 
+    @cached_property
+    def icon_url(self) -> Optional[str]:
+        """
+        Return URL to the community's icon image if one exists.
+        """
+        return None if not bool(self.icon) else self.icon.url
+
     def ensure_user_can_manage_packages(self, user: Optional[UserType]) -> None:
         if not user or not user.is_authenticated:
             raise ValidationError("Must be authenticated")

django/thunderstore/community/tests/test_community.py

@@ -1,9 +1,14 @@
 import pytest
 from django.core.exceptions import ValidationError
+from django.test import override_settings
 
 from conftest import TestUserTypes
 from thunderstore.community.consts import PackageListingReviewStatus
-from thunderstore.community.factories import CommunityFactory, CommunitySiteFactory
+from thunderstore.community.factories import (
+    CommunityFactory,
+    CommunitySiteFactory,
+    PackageListingFactory,
+)
 from thunderstore.community.models import (
     Community,
     CommunityMemberRole,
@@ -82,6 +87,21 @@ def test_background_image_url_when_community_has_image(dummy_image):
     assert len(url) > 0
 
 
+@pytest.mark.django_db
+def test_icon_url_when_community_has_no_image():
+    community = CommunityFactory()
+    url = community.icon_url
+    assert url is None
+
+
+@pytest.mark.django_db
+def test_icon_url_when_community_has_image(dummy_image):
+    community = CommunityFactory(icon=dummy_image)
+    url = community.icon_url
+    assert isinstance(url, str)
+    assert len(url) > 0
+
+
 @pytest.mark.django_db
 def test_community_site_get_absolute_url(community_site: CommunitySite) -> None:
     assert community_site.get_absolute_url == "/c/test/"
@@ -141,3 +161,87 @@ def test_community_should_use_old_urls(
 
 def test_community_should_use_old_urls_no_community() -> None:
     assert Community.should_use_old_urls(None) is True
+
+
+@pytest.mark.django_db
+def test_total_package_count():
+    # Method is not implemented yet and always returns -1.
+    community = CommunityFactory()
+    assert community.total_package_count == -1
+
+    PackageListingFactory(community_=community)
+    PackageListingFactory(
+        community_=community, review_status=PackageListingReviewStatus.approved
+    )
+    PackageListingFactory()
+    assert community.total_package_count == -1
+
+    community.require_package_listing_approval = True
+    community.save()
+    assert community.total_package_count == -1
+
+
+@override_settings(DEBUG=True)
+@pytest.mark.django_db
+def test_experimental_total_package_count():
+    community = CommunityFactory()
+    assert community.total_package_count == 0
+
+    PackageListingFactory(community_=community)
+    PackageListingFactory(
+        community_=community, review_status=PackageListingReviewStatus.approved
+    )
+    PackageListingFactory()
+    assert community.total_package_count == 2
+
+    community.require_package_listing_approval = True
+    community.save()
+    assert community.total_package_count == 1
+
+
+@pytest.mark.django_db
+def test_total_download_count():
+    # Method is not implemented yet and always returns -1.
+    community = CommunityFactory()
+    assert community.total_download_count == -1
+
+    PackageListingFactory(community_=community, package_version_kwargs={"downloads": 0})
+    assert community.total_download_count == -1
+
+    PackageListingFactory(
+        community_=community, package_version_kwargs={"downloads": 23}
+    )
+    PackageListingFactory(
+        community_=community,
+        package_version_kwargs={"downloads": 11},
+        review_status=PackageListingReviewStatus.approved,
+    )
+    assert community.total_download_count == -1
+
+    community.require_package_listing_approval = True
+    community.save()
+    assert community.total_download_count == -1
+
+
+@override_settings(DEBUG=True)
+@pytest.mark.django_db
+def test_experimental_total_download_count():
+    community = CommunityFactory()
+    assert community.total_download_count == 0
+
+    PackageListingFactory(community_=community, package_version_kwargs={"downloads": 0})
+    assert community.total_download_count == 0
+
+    PackageListingFactory(
+        community_=community, package_version_kwargs={"downloads": 23}
+    )
+    PackageListingFactory(
+        community_=community,
+        package_version_kwargs={"downloads": 11},
+        review_status=PackageListingReviewStatus.approved,
+    )
+    assert community.total_download_count == 23 + 11
+
+    community.require_package_listing_approval = True
+    community.save()
+    assert community.total_download_count == 11