mirror of
https://github.com/goauthentik/authentik
synced 2026-05-12 09:57:14 +02:00
cf05037761
* api: make ordering null-aware Signed-off-by: Jens Langhammer <jens@goauthentik.io> * add types Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Jens Langhammer <jens@goauthentik.io>
37 lines
1.4 KiB
Python
37 lines
1.4 KiB
Python
from django.db.models import F, QuerySet
|
|
from rest_framework.filters import OrderingFilter
|
|
from rest_framework.request import Request
|
|
from rest_framework.views import APIView
|
|
|
|
|
|
class NullsAwareOrderingFilter(OrderingFilter):
|
|
"""OrderingFilter that sorts NULL values consistently.
|
|
|
|
For any nullable field, NULLs are treated as the smallest possible value:
|
|
- ascending → NULLs appear first (nulls_first=True)
|
|
- descending → NULLs appear last (nulls_last=True)
|
|
"""
|
|
|
|
def _nullable_field_names(self, queryset: QuerySet) -> set[str]:
|
|
return {f.name for f in queryset.model._meta.get_fields() if hasattr(f, "null") and f.null}
|
|
|
|
def filter_queryset(self, request: Request, queryset: QuerySet, view: APIView):
|
|
queryset = super().filter_queryset(request, queryset, view)
|
|
ordering = queryset.query.order_by
|
|
if not ordering:
|
|
return queryset
|
|
nullable = self._nullable_field_names(queryset)
|
|
new_ordering = []
|
|
changed = False
|
|
for term in ordering:
|
|
name = term.lstrip("-")
|
|
if name in nullable:
|
|
changed = True
|
|
if term.startswith("-"):
|
|
new_ordering.append(F(name).desc(nulls_last=True))
|
|
else:
|
|
new_ordering.append(F(name).asc(nulls_first=True))
|
|
else:
|
|
new_ordering.append(term)
|
|
return queryset.order_by(*new_ordering) if changed else queryset
|