feat(registrations): add ordering for registrations view

Refs: LINK-2173

Author: danipran

registrations/api.py

@@ -175,6 +175,17 @@ class RegistrationViewSet(
     serializer_class = RegistrationSerializer
     queryset = Registration.objects.all()
 
+    filter_backends = [
+        filters.OrderingFilter,
+    ]
+    ordering_fields = [
+        "id",
+        "event__start_time",
+    ]
+    ordering = [
+        "id",
+    ]
+
     permission_classes = [CanAccessRegistration]
 
     def get_serializer_context(self):
@@ -338,7 +349,7 @@ def filter_queryset(self, queryset):
 
         # Copy query_params to get mutable version of it
         query_params = self.request.query_params.copy()
-        # By default _filter_event_queryset only returns events with GENERAL type.
+        # By default, _filter_event_queryset only returns events with GENERAL type.
         # This causes problem when getting a registration details, so filter registrations  # noqa: E501
         # by event_type only when explicitly set
         if not query_params.get("event_type"):
@@ -353,9 +364,9 @@ def filter_queryset(self, queryset):
                 events = Event.objects.none()
             else:
                 events = self.request.user.get_editable_events_for_registration(events)
-        registrations = Registration.objects.filter(event__in=events)
 
-        return registrations
+        queryset = super().filter_queryset(queryset)
+        return queryset.filter(event__in=events)
 
     def get_serializer_class(self):
         if self.action == "send_message":

registrations/tests/test_registration_get.py

@@ -1,10 +1,13 @@
 from collections import Counter
+from datetime import datetime
 from decimal import Decimal
 from unittest.mock import PropertyMock, patch
 
+import freezegun
 import pytest
 from django.conf import settings
 from django.test import TestCase
+from django.utils.timezone import make_aware
 from rest_framework import status
 
 from audit_log.models import AuditLogEntry
@@ -34,13 +37,13 @@
 # === util methods ===
 
 
-def get_list(api_client: APIClient, query_string: str = None):
+def get_list(api_client: APIClient, query_string: str = None, *args, **kwargs):
     url = reverse("registration-list")
 
     if query_string:
         url = "%s?%s" % (url, query_string)
 
-    return api_client.get(url)
+    return api_client.get(url, *args, **kwargs)
 
 
 def assert_registrations_in_response(
@@ -668,6 +671,42 @@ def test_registration_id_is_audit_logged_on_get_detail(user_api_client, registra
     ]
 
 
+@pytest.mark.django_db
+def test_list_should_order_by_id_by_default(user_api_client):
+    registration1 = RegistrationFactory()
+    registration2 = RegistrationFactory()
+    registration3 = RegistrationFactory()
+    expected_order = [registration1, registration2, registration3]
+
+    response = get_list(user_api_client)
+    assert response.status_code == status.HTTP_200_OK, response.json()
+
+    data = response.data["data"]
+    assert [item["id"] for item in data] == [item.pk for item in expected_order]
+
+
+@freezegun.freeze_time("2024-01-01")
+@pytest.mark.django_db
+def test_list_should_order_by_event_start_time(user_api_client):
+    registration_jun = RegistrationFactory(
+        event=EventFactory(start_time=make_aware(datetime(2024, 6, 1)))
+    )
+    registration_jan = RegistrationFactory(
+        event=EventFactory(start_time=make_aware(datetime(2024, 1, 1)))
+    )
+    registration_dec = RegistrationFactory(
+        event=EventFactory(start_time=make_aware(datetime(2024, 12, 1)))
+    )
+    expected_order = [registration_dec, registration_jun, registration_jan]
+
+    response = get_list(user_api_client, data={"sort": "-event__start_time"})
+
+    assert response.status_code == status.HTTP_200_OK, response.json()
+
+    data = response.data["data"]
+    assert [item["id"] for item in data] == [item.pk for item in expected_order]
+
+
 @pytest.mark.django_db
 def test_registration_id_is_audit_logged_on_get_list(
     user_api_client, registration, registration2