Disallow sorting by default on non-sortable columns

Author: boxed

iommi/table.py

@@ -23,7 +23,10 @@
 )
 from urllib.parse import quote_plus
 
-from django.core.exceptions import ImproperlyConfigured
+from django.core.exceptions import (
+    FieldDoesNotExist,
+    ImproperlyConfigured,
+)
 from django.db.models import (
     AutoField,
     BooleanField,
@@ -507,6 +510,14 @@ def on_bind(self) -> None:
         # Not strict evaluate on purpose
         self.model = evaluate(self.model, **self.iommi_evaluate_parameters())
 
+        if self.table.model and self.attr is not None and self.sortable:
+            if '__' not in self.attr:
+                # Only validate one level of the path for now
+                try:
+                    self.table.model._meta.get_field(self.attr)
+                except FieldDoesNotExist:
+                    self.sortable = False
+
         if self.auto_rowspan:
             assert 'rowspan' not in self.cell.attrs, (
                 f'Explicitly set rowspan html attribute collides with ' f'auto_rowspan on column {self.iommi_path}'

iommi/table__tests.py

@@ -2552,8 +2552,8 @@ class Meta:
             <table class="table" >
                 <thead>
                     <tr>
-                        <th class="first_column  iommi_sort_header subheader">
-                            <a href="?order=some_non_existent_property"> Some non existent property </a>
+                        <th class="first_column subheader">
+                            Some non existent property
                         </th>
                     </tr>
                 </thead>
@@ -2801,8 +2801,8 @@ class Meta:
             <table class="table" >
                 <thead>
                     <tr>
-                        <th class="first_column  iommi_sort_header subheader">
-                            <a href="?order=a"> A </a>
+                        <th class="first_column subheader">
+                            A
                         </th>
                     </tr>
                 </thead>
@@ -4712,3 +4712,24 @@ def test_auto_rowspan_two_columns():
         </tbody>
         '''
     )
+
+
+@pytest.mark.django_db
+def test_disallow_sorting_on_non_sortable_columns_that_have_valid_attr():
+    T1.objects.create(pk=1, foo='a', bar='b')
+
+    def preprocess_rows(rows, **_):
+        for row in rows:
+            row.synthetic = 1
+        return rows
+
+    t = Table(
+        auto__model=T1,
+        preprocess_rows=preprocess_rows,
+        columns__synthetic=Column(),
+    )
+
+    # This should not crash
+    t = t.bind(request=req('get', **{'order': 'synthetic'}))
+
+    assert not t.columns.synthetic.sortable