Merge pull request #94 from CristopherH95/post-pagination

Fix issues with POST pagination

Author: izimobil

rest_framework_datatables/pagination.py

@@ -43,22 +43,43 @@ def get_count_and_total_count(self, queryset, view):
 
 
 class DatatablesPageNumberPagination(DatatablesMixin, PageNumberPagination):
+    def get_page_size(self, request):
+        if self.page_size_query_param:
+            try:
+                size = int(get_param(request, self.page_size_query_param))
+                if size <= 0:
+                    raise ValueError()
+                if self.max_page_size is not None:
+                    return min(size, self.max_page_size)
+                return size
+            except (ValueError, TypeError):
+                pass
+        return self.page_size
+
+    def get_page(self, request, page_size):
+        try:
+            start = int(get_param(request, self.page_query_param, 0))
+            return int(start / page_size) + 1
+        except ValueError:
+            return None
+
     def paginate_queryset(self, queryset, request, view=None):
         if request.accepted_renderer.format != 'datatables':
             self.is_datatable_request = False
             return super(
                 DatatablesPageNumberPagination, self
             ).paginate_queryset(queryset, request, view)
 
-        length = get_param(request, 'length')
+        self.page_query_param = 'start'
+        self.page_size_query_param = 'length'
+        length = get_param(request, self.page_size_query_param)
 
         if length is None or length == '-1':
             return None
         self.count, self.total_count = self.get_count_and_total_count(
             queryset, view
         )
         self.is_datatable_request = True
-        self.page_size_query_param = 'length'
         page_size = self.get_page_size(request)
         if not page_size:  # pragma: no cover
             return None
@@ -73,8 +94,7 @@ def count(self):
                 return self.value
 
         paginator = CachedCountPaginator(self.count, queryset, page_size)
-        start = int(get_param(request, 'start', 0))
-        page_number = int(start / page_size) + 1
+        page_number = self.get_page(request, page_size)
 
         try:
             self.page = paginator.page(page_number)
@@ -97,7 +117,7 @@ def get_limit(self, request):
             if self.max_limit is not None:
                 return min(limit_value, self.max_limit)
             return limit_value
-        except ValueError:
+        except (ValueError, TypeError):
             return self.default_limit
 
     def get_offset(self, request):
@@ -107,16 +127,16 @@ def get_offset(self, request):
                 raise ValueError
 
             return offset_value
-        except ValueError:
+        except (ValueError, TypeError):
             return 0
 
     def paginate_queryset(self, queryset, request, view=None):
         if request.accepted_renderer.format == 'datatables':
             self.is_datatable_request = True
-            if get_param(request, 'length') is None:
-                return None
             self.limit_query_param = 'length'
             self.offset_query_param = 'start'
+            if get_param(request, self.limit_query_param) is None:
+                return None
             self.count, self.total_count = self.get_count_and_total_count(
                 queryset, view
             )

tests/test_api.py

@@ -23,6 +23,14 @@ def post(self, request, *args, **kwargs):
         return self.list(request, *args, **kwargs)
 
 
+class DatatablesPageNumberPaginationCustomMax(DatatablesPageNumberPagination):
+    max_page_size = 15
+
+
+class DatatablesLimitOffsetPaginationCustomMax(DatatablesLimitOffsetPagination):
+    max_limit = 15
+
+
 class TestApiTestCase(TestCase):
     fixtures = ['test_data']
 
@@ -82,10 +90,36 @@ def test_pagenumber_pagination_show_all(self):
         result = response.json()
         self.assertEquals((result['recordsFiltered'], result['recordsTotal'], len(result['data']), result['data'][0]['artist_name']), expected)
 
-    def test_pagenumber_pagination_invalid_page(self):
+    def test_pagenumber_pagination_invalid_page1(self):
         response = self.client.get('/api/albums/?format=datatables&length=10&start=20&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
         self.assertEquals(response.status_code, 404)
 
+    def test_pagenumber_pagination_invalid_page2(self):
+        response = self.client.get('/api/albums/?format=datatables&length=10&start=abc&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        self.assertEquals(response.status_code, 404)
+
+    def test_pagenumber_pagination_invalid_page_size1(self):
+        response = self.client.get('/api/albums/?format=datatables&length=abc&start=10&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 5, 'Elvis Presley')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], len(result['data']), result['data'][0]['artist_name']), expected)
+
+    def test_pagenumber_pagination_invalid_page_size2(self):
+        response = self.client.get('/api/albums/?format=datatables&length=-999&start=10&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 5, 'Elvis Presley')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], len(result['data']), result['data'][0]['artist_name']), expected)
+
+    @override_settings(REST_FRAMEWORK={
+        'DEFAULT_PAGINATION_CLASS': __name__ + '.DatatablesPageNumberPaginationCustomMax',
+    })
+    def test_pagenumber_pagination_invalid_max(self):
+        AlbumViewSet.pagination_class = DatatablesPageNumberPaginationCustomMax
+        response = self.client.get('/api/albums/?format=datatables&length=20&start=10&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 15, 'The Beatles')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], len(result['data']), result['data'][0]['artist_name']), expected)
+
     @override_settings(REST_FRAMEWORK={
         'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesLimitOffsetPagination',
     })
@@ -108,6 +142,66 @@ def test_limitoffset_pagination_no_length(self):
         result = response.json()
         self.assertEquals((result['recordsFiltered'], result['recordsTotal'], result['data'][0]['artist_name']), expected)
 
+    @override_settings(REST_FRAMEWORK={
+        'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesLimitOffsetPagination',
+    })
+    def test_limitoffset_pagination_invalid_length1(self):
+        AlbumViewSet.pagination_class = DatatablesLimitOffsetPagination
+        client = APIClient()
+        response = client.get(
+            '/api/albums/?format=datatables&length=abc&start=10&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 'Elvis Presley')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], result['data'][0]['artist_name']), expected)
+
+    @override_settings(REST_FRAMEWORK={
+        'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesLimitOffsetPagination',
+    })
+    def test_limitoffset_pagination_invalid_length2(self):
+        AlbumViewSet.pagination_class = DatatablesLimitOffsetPagination
+        client = APIClient()
+        response = client.get(
+            '/api/albums/?format=datatables&length=-999&start=10&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 'Elvis Presley')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], result['data'][0]['artist_name']), expected)
+
+    @override_settings(REST_FRAMEWORK={
+        'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesLimitOffsetPagination',
+    })
+    def test_limitoffset_pagination_invalid_start1(self):
+        AlbumViewSet.pagination_class = DatatablesLimitOffsetPagination
+        client = APIClient()
+        response = client.get(
+            '/api/albums/?format=datatables&length=10&start=abc&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 'The Beatles')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], result['data'][0]['artist_name']), expected)
+
+    @override_settings(REST_FRAMEWORK={
+        'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesLimitOffsetPagination',
+    })
+    def test_limitoffset_pagination_invalid_start2(self):
+        AlbumViewSet.pagination_class = DatatablesLimitOffsetPagination
+        client = APIClient()
+        response = client.get(
+            '/api/albums/?format=datatables&length=10&start=-999&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 'The Beatles')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], result['data'][0]['artist_name']), expected)
+
+    @override_settings(REST_FRAMEWORK={
+        'DEFAULT_PAGINATION_CLASS': __name__ + '.DatatablesLimitOffsetPaginationCustomMax',
+    })
+    def test_limitoffset_pagination_invalid_max(self):
+        AlbumViewSet.pagination_class = DatatablesLimitOffsetPaginationCustomMax
+        client = APIClient()
+        response = client.get(
+            '/api/albums/?format=datatables&length=20&start=10&columns[0][data]=name&columns[1][data]=artist_name&draw=1')
+        expected = (15, 15, 'Elvis Presley')
+        result = response.json()
+        self.assertEquals((result['recordsFiltered'], result['recordsTotal'], result['data'][0]['artist_name']), expected)
+
     @override_settings(REST_FRAMEWORK={
         'DEFAULT_PAGINATION_CLASS': 'rest_framework_datatables.pagination.DatatablesLimitOffsetPagination',
     })