Add reservation deny reason rank and ordering filter

Author: matti-lamppu

api/graphql/types/reservation_deny_reason/filtersets.py

@@ -1,3 +1,4 @@
+from django.db import models
 from graphene_django_extensions import ModelFilterSet
 from graphene_django_extensions.filters import IntMultipleChoiceFilter
 
@@ -16,3 +17,10 @@ class Meta:
         fields = [
             "reason",
         ]
+        order_by = [
+            "rank",
+        ]
+
+    @staticmethod
+    def order_by_rank(qs: models.QuerySet, desc: bool) -> models.QuerySet:
+        return qs.order_by(models.OrderBy(models.F("rank"), descending=desc, nulls_last=True))

reservations/migrations/0078_alter_reservationdenyreason_options_and_more.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.0.6 on 2024-06-12 08:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("reservations", "0077_alter_reservationstatistic_reservee_type"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="reservationdenyreason",
+            options={"base_manager_name": "objects", "ordering": ["rank"]},
+        ),
+        migrations.AddField(
+            model_name="reservationdenyreason",
+            name="rank",
+            field=models.PositiveBigIntegerField(blank=True, db_index=True, null=True),
+        ),
+    ]

reservations/models/reservation_deny_reason.py

@@ -6,7 +6,8 @@
 
 
 class ReservationDenyReason(models.Model):
-    reason = models.CharField(max_length=255, null=False, blank=False)
+    rank: int | None = models.PositiveBigIntegerField(null=True, blank=True, db_index=True)
+    reason: str = models.CharField(max_length=255)
 
     # Translated field hints
     reason_fi: str | None
@@ -17,7 +18,7 @@ class Meta:
         db_table = "reservation_deny_reason"
         base_manager_name = "objects"
         ordering = [
-            "pk",
+            "rank",
         ]
 
     def __str__(self) -> str:

tests/test_graphql_api/test_reservation_deny_reason/test_query.py

@@ -1,27 +1,25 @@
+from functools import partial
+
 import pytest
 from graphene_django_extensions.testing import build_query
 
 from tests.factories import ReservationDenyReasonFactory
-from tests.helpers import UserType
 
 # Applied to all tests
 pytestmark = [
     pytest.mark.django_db,
 ]
 
 
+deny_query = partial(build_query, "reservationDenyReasons", connection=True)
+
+
 def test_reservation_deny_reasons__query(graphql):
     deny_reason = ReservationDenyReasonFactory.create()
 
-    graphql.login_user_based_on_type(UserType.SUPERUSER)
+    graphql.login_with_superuser()
 
-    fields = """
-        pk
-        reasonFi
-        reasonEn
-        reasonSv
-    """
-    query = build_query("reservationDenyReasons", fields=fields, connection=True)
+    query = deny_query(fields="pk reasonFi reasonEn reasonSv")
     response = graphql(query)
 
     assert response.has_errors is False
@@ -38,15 +36,35 @@ def test_reservation_deny_reasons__query(graphql):
 def test_reservation_deny_reasons__query__anonymous_user(graphql):
     ReservationDenyReasonFactory.create()
 
-    graphql.login_user_based_on_type(UserType.ANONYMOUS)
-
-    fields = """
-        pk
-        reasonFi
-        reasonEn
-        reasonSv
-    """
-    query = build_query("reservationDenyReasons", fields=fields, connection=True)
+    query = deny_query()
     response = graphql(query)
 
     assert response.error_message() == "No permission to access node."
+
+
+def test_reservation_deny_reasons__order__by_rank(graphql):
+    deny_reason_1 = ReservationDenyReasonFactory.create(rank=1)
+    deny_reason_2 = ReservationDenyReasonFactory.create(rank=3)
+    deny_reason_3 = ReservationDenyReasonFactory.create(rank=2)
+
+    graphql.login_with_superuser()
+
+    query = deny_query(order_by="rankAsc")
+    response = graphql(query)
+
+    assert response.has_errors is False
+
+    assert len(response.edges) == 3
+    assert response.node(0) == {"pk": deny_reason_1.pk}
+    assert response.node(1) == {"pk": deny_reason_3.pk}
+    assert response.node(2) == {"pk": deny_reason_2.pk}
+
+    query = deny_query(order_by="rankDesc")
+    response = graphql(query)
+
+    assert response.has_errors is False
+
+    assert len(response.edges) == 3
+    assert response.node(0) == {"pk": deny_reason_2.pk}
+    assert response.node(1) == {"pk": deny_reason_3.pk}
+    assert response.node(2) == {"pk": deny_reason_1.pk}