Merge pull request #111 from Siege-Software/change-date-parse

update ubuntu image

Author: EricOuma

.github/workflows/build.yml

@@ -9,18 +9,11 @@ on:  # yamllint disable-line rule:truthy
 jobs:
   build:
     name: Python ${{ matrix.python-version }} | Django ${{ matrix.django-version}} | Ubuntu
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
         include:
-          - python-version: 3.9
-            django-version: "3.2.*"
-          - python-version: 3.9
-            django-version: "4.0.*"
-          - python-version: 3.9
-            django-version: "4.1.*"
-
           - python-version: "3.10"
             django-version: "3.2.*"
           - python-version: "3.10"
@@ -52,6 +45,19 @@ jobs:
           typesense-version: '27.0'
           typesense-api-key: sample_key
 
+      - name: Wait for TypeSense to be ready
+        run: |
+          echo "Waiting for TypeSense..."
+          for i in {1..30}; do
+            if curl -s http://localhost:8108/health | grep '"ok"' > /dev/null; then
+              echo "TypeSense is ready!"
+              exit 0
+            fi
+            sleep 2
+          done
+          echo "TypeSense failed to start"
+          exit 1
+
       - name: Run tests
         run: |
           coverage run runtests.py

.github/workflows/lint.yml

@@ -15,10 +15,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Setup Python 3.9
+      - name: Setup Python 3.10
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Upgrade Setuptools
         run: pip install --upgrade setuptools wheel

.github/workflows/pypi.yml

@@ -20,10 +20,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Setup Python 3.9
+      - name: Setup Python 3.10
         uses: actions/setup-python@v1
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Upgrade Setuptools
         run: pip install --upgrade setuptools wheel

django_typesense/__init__.py

@@ -1 +1 @@
-__version__ = "0.1.3"
+__version__ = "0.1.4"

django_typesense/admin.py

@@ -11,6 +11,7 @@
 from django_typesense.paginator import TypesenseSearchPaginator
 
 logger = logging.getLogger(__name__)
+TYPESENSE_MAX_HITS_PER_PAGE = 250
 
 
 class TypesenseSearchAdminMixin(admin.ModelAdmin):
@@ -124,6 +125,7 @@ def get_typesense_search_results(
         """
         if list_per_page is None:
             list_per_page = self.list_per_page
+        list_per_page = min(list_per_page, TYPESENSE_MAX_HITS_PER_PAGE)
 
         results = typesense_search(
             collection_name=self.model.collection_class.schema_name,

django_typesense/changelist.py

@@ -37,6 +37,7 @@
 )
 
 logger = logging.getLogger(__name__)
+TYPESENSE_MAX_HITS_PER_PAGE = 250
 
 
 class ChangeListSearchForm(forms.Form):
@@ -85,10 +86,12 @@ def __init__(
         self.date_hierarchy = date_hierarchy
         self.search_fields = model_admin.get_typesense_search_fields(request)
         self.list_select_related = list_select_related
-        self.list_per_page = min(list_per_page, 250)  # Typesense Max hits per page
+        self.list_per_page = min(
+            list_per_page, TYPESENSE_MAX_HITS_PER_PAGE
+        )  # Typesense max hits per page
         self.list_max_show_all = min(
-            list_max_show_all, 250
-        )  # Typesense Max hits per page
+            list_max_show_all, TYPESENSE_MAX_HITS_PER_PAGE
+        )  # Typesense max hits per page
         self.model_admin = model_admin
         self.preserved_filters = model_admin.get_preserved_filters(request)
         self.sortable_by = sortable_by
@@ -104,6 +107,7 @@ def __init__(
             self.page_num = int(request.GET.get(PAGE_VAR, 1))
         except ValueError:
             self.page_num = 1
+        self.page_num = max(self.page_num, 1)
         self.show_all = ALL_VAR in request.GET
         self.is_popup = IS_POPUP_VAR in request.GET
         to_field = request.GET.get(TO_FIELD_VAR)
@@ -399,7 +403,7 @@ def get_typesense_results(self, request):
             self.page_num,
             filter_by=filter_by,
             sort_by=sort_by,
-            list_per_page=self.list_max_show_all  # so that if we have all the data if we need to show all
+            list_per_page=self.list_per_page,
         )
 
         # Set query string for clearing all filters.

django_typesense/paginator.py

@@ -50,11 +50,8 @@ def prepare_results(self):
     def page(self, number):
         """Return a Page object for the given 1-based page number."""
         number = self.validate_number(number)
-        bottom = (number - 1) * self.per_page
-        top = bottom + self.per_page
-        if top + self.orphans >= self.count:
-            top = self.count
-        return self._get_page(self.results[bottom:top], number, self)
+        # Typesense already returns a paginated response, so avoid slicing again.
+        return self._get_page(self.results, number, self)
 
     @cached_property
     def count(self):

tests/test_typesense_pagination.py

@@ -0,0 +1,71 @@
+from types import SimpleNamespace
+from unittest import mock
+
+from django.test import TestCase
+
+from django_typesense.admin import TypesenseSearchAdminMixin
+from django_typesense.paginator import TypesenseSearchPaginator
+
+
+class DummyCollection:
+    fields = {"id": None}
+
+    def __init__(self, data):
+        self.validated_data = list(data)
+
+
+class DummyModel:
+    _meta = SimpleNamespace(local_fields=[SimpleNamespace(name="id")])
+
+    @classmethod
+    def get_collection_class(cls):
+        return DummyCollection
+
+    @classmethod
+    def get_collection(cls, data):
+        return DummyCollection(data)
+
+    def __init__(self, **kwargs):
+        self.__dict__.update(kwargs)
+
+
+class TestTypesenseSearchPaginator(TestCase):
+    def test_page_does_not_slice_pre_paginated_results(self):
+        object_list = {
+            "found": 500,
+            "hits": [{"document": {"id": index}} for index in range(250, 500)],
+        }
+        paginator = TypesenseSearchPaginator(object_list, per_page=250, model=DummyModel)
+
+        page = paginator.page(2)
+
+        self.assertEqual(len(page.object_list), 250)
+        self.assertEqual(page.object_list[0].id, 250)
+        self.assertEqual(page.object_list[-1].id, 499)
+
+
+class TestTypesenseSearchAdminPagination(TestCase):
+    @mock.patch("django_typesense.admin.typesense_search", return_value={"found": 0, "hits": []})
+    def test_get_typesense_search_results_caps_per_page(self, mocked_typesense_search):
+        fake_admin = SimpleNamespace(
+            model=SimpleNamespace(
+                collection_class=SimpleNamespace(
+                    schema_name="songs",
+                    query_by_fields="title",
+                )
+            ),
+            list_per_page=500,
+        )
+
+        TypesenseSearchAdminMixin.get_typesense_search_results(
+            fake_admin,
+            request=None,
+            search_term="song",
+            page_num=2,
+            list_per_page=500,
+        )
+
+        mocked_typesense_search.assert_called_once()
+        _, kwargs = mocked_typesense_search.call_args
+        self.assertEqual(kwargs["page"], 2)
+        self.assertEqual(kwargs["per_page"], 250)