fix: DRF issue #6886 with StableOrderingFilter

setup.py

@@ -28,7 +28,7 @@ def get_requirements(fname='requirements.txt'):
 
 setup(
     name="unicms",
-    version='0.26.4',
+    version='0.26.5',
     description="uniCMS is a Django Web Content Management System",
     long_description=README,
     long_description_content_type='text/markdown',

src/cms/api/ordering.py

@@ -0,0 +1,14 @@
+from django.core.exceptions import FieldError
+from rest_framework.filters import OrderingFilter
+
+
+# Work around DRF issue #6886 by always adding the primary key as last order field.
+class StableOrderingFilter(OrderingFilter):
+    def get_ordering(self, request, queryset, view):
+        ordering = super(StableOrderingFilter, self).get_ordering(request, queryset, view)
+        pk = queryset.model._meta.pk.name
+        if ordering is None: return [pk,]
+        for field in queryset.model._meta.fields:
+            if field.__dict__['name'] == 'order':
+                return list(ordering) + ['order', pk,]
+        return list(ordering) + [pk,]

src/cms/api/views/generics.py

@@ -18,6 +18,7 @@
                             # set_lock_to_cache,
                             LOCK_MESSAGE)
 from .. exceptions import LoggedPermissionDenied
+from .. ordering import StableOrderingFilter
 from .. pagination import UniCmsApiPagination, UniCmsSelectOptionsApiPagination
 
 
@@ -29,7 +30,7 @@ class UniCMSListCreateAPIView(generics.ListCreateAPIView):
     permission_classes = [IsAdminUser]
     filter_backends = [filters.SearchFilter,
                        DjangoFilterBackend,
-                       filters.OrderingFilter]
+                       StableOrderingFilter]
     filterset_fields = ['is_active', 'created', 'modified', 'created_by']
     pagination_class = UniCmsApiPagination
 
@@ -102,7 +103,7 @@ class UniCMSListSelectOptionsAPIView(generics.ListAPIView):
     permission_classes = [IsAdminUser]
     filter_backends = [filters.SearchFilter,
                        DjangoFilterBackend,
-                       filters.OrderingFilter]
+                       StableOrderingFilter]
     pagination_class = UniCmsSelectOptionsApiPagination
     ordering = ['id']
 

src/cms/api/views/logs.py

@@ -5,6 +5,7 @@
 from rest_framework import filters, generics
 from rest_framework.permissions import IsAdminUser
 
+from .. ordering import StableOrderingFilter
 from .. pagination import UniCmsApiPagination
 
 
@@ -14,7 +15,7 @@ class ObjectLogEntriesList(generics.ListAPIView):
     description = ""
     permission_classes = [IsAdminUser]
     filter_backends = [filters.SearchFilter,
-                       filters.OrderingFilter]
+                       StableOrderingFilter]
     search_fields = ['user__first_name','user__last_name',
                      'change_message']
     pagination_class = UniCmsApiPagination

src/cms/api/views/page.py

@@ -20,6 +20,7 @@
 from . generics import UniCMSCachedRetrieveUpdateDestroyAPIView, UniCMSListCreateAPIView, check_locks
 from . logs import ObjectLogEntriesList
 from .. exceptions import LoggedPermissionDenied
+from .. ordering import StableOrderingFilter
 from .. pagination import UniCmsApiPagination
 from .. serializers import UniCMSFormSerializer
 

src/cms/api/views/template_block.py

@@ -9,6 +9,7 @@
 from rest_framework.permissions import IsAdminUser
 from rest_framework.schemas.openapi import AutoSchema
 
+from .. ordering import StableOrderingFilter
 from .. pagination import UniCmsApiPagination
 
 
@@ -19,7 +20,7 @@ class TemplatesBlockList(generics.ListAPIView):
     permission_classes = [IsAdminUser]
     filter_backends = [filters.SearchFilter,
                        DjangoFilterBackend,
-                       filters.OrderingFilter]
+                       StableOrderingFilter]
     filterset_fields = ['is_active', 'created', 'modified']
     pagination_class = UniCmsApiPagination
     search_fields = ['name', 'description', 'type']
@@ -48,7 +49,7 @@ class TemplateBlockList(generics.ListAPIView):
     permission_classes = [IsAdminUser]
     filter_backends = [filters.SearchFilter,
                        DjangoFilterBackend,
-                       filters.OrderingFilter]
+                       StableOrderingFilter]
     filterset_fields = ['is_active', 'created', 'modified']
     pagination_class = None
     schema = SingleTemplateBlockListSchema()

src/cms/api/views/webpath.py

@@ -24,6 +24,7 @@
 from . generics import UniCMSCachedRetrieveUpdateDestroyAPIView, UniCMSListCreateAPIView, UniCMSListSelectOptionsAPIView
 from . logs import ObjectLogEntriesList
 from .. exceptions import LoggedPermissionDenied, LoggedValidationException
+from .. ordering import StableOrderingFilter
 from .. pagination import UniCmsApiPagination
 from .. serializers import UniCMSFormSerializer
 
@@ -281,7 +282,7 @@ class WebpathAllList(generics.ListAPIView):
     permission_classes = [IsAdminUser]
     filter_backends = [filters.SearchFilter,
                        DjangoFilterBackend,
-                       filters.OrderingFilter]
+                       StableOrderingFilter]
     filterset_fields = ['is_active', 'created', 'modified', 'created_by']
     pagination_class = UniCmsApiPagination