diff mbox series

[layerindex-web,2/4] layerindex/querysethelper.py: apply the API "orderby" parameter

Message ID 20261116230401.42917-3-tim.orling@konsulko.com
State New
Headers show
Series Return 400 or 404 instead of server errors for bad URLs | expand

Commit Message

Tim Orling Nov. 16, 2026, 11:03 p.m. UTC
params_to_queryset() worked out the column and direction from
"orderby" but never ordered the queryset by them, so the parameter had
no effect. Order by it, with a 400 for a field path that doesn't exist.
It no longer evaluates the whole queryset just to check whether it is
empty first.

[YOCTO #16518]

AI-Generated: Claude Opus 5.5
Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 layerindex/querysethelper.py | 27 +++++++++++++++++++++++----
 tests/test_restapi.py        | 30 ++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/layerindex/querysethelper.py b/layerindex/querysethelper.py
index 2ca466a..26f687a 100644
--- a/layerindex/querysethelper.py
+++ b/layerindex/querysethelper.py
@@ -8,7 +8,7 @@ 
 
 import operator
 import functools
-from django.core.exceptions import FieldError, ValidationError
+from django.core.exceptions import FieldDoesNotExist, FieldError, ValidationError
 from django.db.models import Q, CharField
 from rest_framework.exceptions import ParseError
 
@@ -124,6 +124,18 @@  def get_search_tuple(request, model):
     return (filter_string, search_term, ordering_string)
 
 
+def _check_field_path(model, path):
+    """Raise ParseError unless path (e.g. "layerbranch__layer__name") names a field"""
+    for name in path.split('__'):
+        if model is None:
+            raise ParseError("Invalid orderby: " + path)
+        try:
+            field = model._meta.get_field(name)
+        except FieldDoesNotExist:
+            raise ParseError("Invalid orderby: " + path)
+        model = field.related_model
+
+
 # returns a lazy-evaluated queryset for a filter/search/order combination
 def params_to_queryset(model, queryset, filter_string, search_term, ordering_string):
     if filter_string:
@@ -139,12 +151,19 @@  def params_to_queryset(model, queryset, filter_string, search_term, ordering_str
     if search_term:
         queryset = _get_search_results(search_term, queryset, model)
 
-    if ordering_string and queryset:
+    # insure only distinct records (e.g. from multiple search hits) are returned
+    queryset = queryset.distinct()
+
+    if ordering_string:
         column, order = ordering_string.split(':')
         if order.lower() == DESCENDING:
             column = '-' + column
+        # The ordering was worked out but never applied. A bad field path
+        # only fails when the query runs, so check it here (AI-generated,
+        # Claude Opus 5.5)
+        _check_field_path(model, column.lstrip('-'))
+        queryset = queryset.order_by(column)
 
-    # insure only distinct records (e.g. from multiple search hits) are returned
-    return queryset.distinct()
+    return queryset
 
 
diff --git a/tests/test_restapi.py b/tests/test_restapi.py
index a1f733e..fde1aec 100644
--- a/tests/test_restapi.py
+++ b/tests/test_restapi.py
@@ -60,3 +60,33 @@  class TestRestApiInvalidParameters(TestCase):
                                    {'filter': 'name:meta-test', 'format': 'json'})
         self.assertEqual(response.status_code, 200)
         self.assertEqual([i['name'] for i in response.json()], ['meta-test'])
+
+
+@pytest.mark.django_db
+class TestRestApiOrderby(TestCase):
+    """orderby sorts the results ([YOCTO #16518])"""
+
+    def setUp(self):
+        for name in ('meta-b', 'meta-a', 'meta-c'):
+            LayerItem.objects.create(name=name, status='P', layer_type='A',
+                                     summary='test', description='test',
+                                     vcs_url='git://example.com/%s.git' % name)
+
+    def names(self, orderby):
+        response = self.client.get('/layerindex/api/layerItems/',
+                                   {'orderby': orderby, 'format': 'json'})
+        self.assertEqual(response.status_code, 200)
+        return [i['name'] for i in response.json()]
+
+    def test_ascending(self):
+        self.assertEqual(self.names('name:+'), ['meta-a', 'meta-b', 'meta-c'])
+
+    def test_descending(self):
+        # DESCENDING in querysethelper.py
+        self.assertEqual(self.names('name:-'), ['meta-c', 'meta-b', 'meta-a'])
+
+    def test_unknown_related_field(self):
+        # "layerbranch" passes the field-name check; the rest of the path is wrong
+        response = self.client.get('/layerindex/api/layerItems/',
+                                   {'orderby': 'layerbranch__nosuchfield:+', 'format': 'json'})
+        self.assertEqual(response.status_code, 400)