Fix search cache

drf_kit/cache.py

@@ -25,6 +25,18 @@ class CacheKeyConstructor(KeyConstructor):
 cache_key_constructor = CacheKeyConstructor()
 
 
+class BodyKeyBit(bits.AllArgsMixin, bits.KeyBitDictBase):
+    def get_source_dict(self, params, view_instance, view_method, request, args, kwargs):
+        return request.POST
+
+
+class BodyCacheKeyConstructor(CacheKeyConstructor):
+    body = BodyKeyBit()
+
+
+body_cache_key_constructor = BodyCacheKeyConstructor()
+
+
 class CacheResponse(decorators.CacheResponse):
     def process_cache_response(
         self,

drf_kit/views/viewsets.py

@@ -10,7 +10,7 @@
 from rest_framework_extensions.cache.mixins import BaseCacheResponseMixin
 
 from drf_kit import exceptions, filters
-from drf_kit.cache import cache_response
+from drf_kit.cache import body_cache_key_constructor, cache_response
 from drf_kit.exceptions import ConflictException, DuplicatedRecord, ExclusionDuplicatedRecord
 
 logger = logging.getLogger(__name__)
@@ -149,14 +149,25 @@ def get_exception_handler(self):
         return exceptions.custom_exception_handler
 
 
+search_action = action(
+    detail=False,
+    methods=["post"],
+    filter_backends=[filters.FilterInBodyBackend, *api_settings.DEFAULT_FILTER_BACKENDS],
+)
+
+
 class SearchMixin:
-    @action(
-        detail=False,
-        methods=["post"],
-        filter_backends=[filters.FilterInBodyBackend, *api_settings.DEFAULT_FILTER_BACKENDS],
-    )
+    @search_action
     def search(self, request):
-        return self.list(request)
+        queryset = self.filter_queryset(self.get_queryset())
+
+        page = self.paginate_queryset(queryset)
+        if page is not None:
+            serializer = self.get_serializer(page, many=True)
+            return self.get_paginated_response(serializer.data)
+
+        serializer = self.get_serializer(queryset, many=True)
+        return Response(serializer.data)
 
 
 class ModelViewSet(MultiSerializerMixin, viewsets.ModelViewSet):
@@ -185,14 +196,33 @@ class CachedModelViewSet(CacheResponseMixin, ModelViewSet):
     pass
 
 
+class CachedSearchableMixin(SearchMixin, CacheResponseMixin):
+    @search_action
+    @cache_response(key_func=body_cache_key_constructor)
+    def search(self, request, *args, **kwargs):
+        return super().search(request, *args, **kwargs)
+
+
+class CachedSearchableModelViewSet(CachedSearchableMixin, ModelViewSet):
+    pass
+
+
 class CachedReadOnlyModelViewSet(CacheResponseMixin, ReadOnlyModelViewSet):
     pass
 
 
+class CachedSearchableReadOnlyModelViewSet(CachedSearchableMixin, ReadOnlyModelViewSet):
+    pass
+
+
 class CachedNonDestructiveModelViewSet(CacheResponseMixin, NonDestructiveModelViewSet):
     pass
 
 
+class CachedSearchableNonDestructiveModelViewSet(CachedSearchableMixin, NonDestructiveModelViewSet):
+    pass
+
+
 class WriteOnlyModelViewSet(MultiSerializerMixin, viewsets.ModelViewSet):
     http_method_names = ["post", "patch", "delete"]
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "drf-kit"
-version = "1.42.0"
+version = "1.42.1"
 description = "DRF Toolkit"
 authors = ["Nilo Saude <[email protected]>"]
 packages = [

test_app/tests/tests_views/tests_filter_views.py

@@ -70,6 +70,32 @@ def test_search_body_ordered(self):
 
         self.assertResponseList(expected_items=expected_teachers, response=response)
 
+    def test_search_miss_with_different_body(self):
+        url = f"{self.url}/search?name=Hermione"
+        data = {"age": 20, "is_half_blood": False}
+
+        response_json_miss = self.client.post(url, data=data)
+        self.assertEqual(status.HTTP_200_OK, response_json_miss.status_code)
+        self.assertEqual("MISS", response_json_miss["X-Cache"])
+
+        data = {"age": 25, "is_half_blood": True}
+
+        response_json_miss = self.client.post(url, data=data)
+        self.assertEqual(status.HTTP_200_OK, response_json_miss.status_code)
+        self.assertEqual("MISS", response_json_miss["X-Cache"])
+
+    def test_search_hit_with_same_body(self):
+        url = f"{self.url}/search?name=Hermione"
+        data = {"age": 20, "is_half_blood": False}
+
+        response_json_miss = self.client.post(url, data=data)
+        self.assertEqual(status.HTTP_200_OK, response_json_miss.status_code)
+        self.assertEqual("MISS", response_json_miss["X-Cache"])
+
+        response_json_hit = self.client.post(url, data=data)
+        self.assertEqual(status.HTTP_200_OK, response_json_hit.status_code)
+        self.assertEqual("HIT", response_json_hit["X-Cache"])
+
 
 class TestAnyOfFilter(BaseApiTest):
     def test_with_initial_value(self):

test_app/views.py

@@ -4,7 +4,6 @@
 
 from drf_kit.views import (
     BulkMixin,
-    CachedModelViewSet,
     ModelViewSet,
     NestedModelViewSet,
     NonDestructiveModelViewSet,
@@ -15,7 +14,7 @@
     WriteOnlyModelViewSet,
     WriteOnlyNestedModelViewSet,
 )
-from drf_kit.views.viewsets import SearchMixin
+from drf_kit.views.viewsets import CachedSearchableModelViewSet
 from test_app import filters, models, serializers
 
 
@@ -32,7 +31,7 @@ def add_stats_to_queryset(self, queryset):
         )
 
 
-class TeacherViewSet(SearchMixin, CachedModelViewSet):
+class TeacherViewSet(CachedSearchableModelViewSet):
     queryset = models.Teacher.objects.all()
     serializer_class = serializers.TeacherSerializer
     filterset_class = filters.TeacherFilterSet