fix: Add tests to verify caching behavior (#85)

* fix: Add tests to verify caching behavior

* remove leftover, unused code

* Apply suggestions from code review

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* add @preview_schema to MenuView

* remove empty file

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

Author: fsbraun

djangocms_rest/cms_config.py

@@ -65,6 +65,8 @@ def patch_page_menu(menu: type[CMSMenu]):
 class NavigationNodeMixin:
     """Mixin to add API endpoint and selection logic to NavigationNode."""
 
+    api_endpoint = None
+
     def get_api_endpoint(self):
         """Get the API endpoint for the navigation node."""
         return self.api_endpoint

djangocms_rest/serializers/placeholders.py

@@ -63,7 +63,7 @@ def to_representation(self, instance):
                     instance,
                     context=Context({"request": self.request}),
                     language=self.language,
-                    use_cache=True,
+                    use_cache=not getattr(self.request, "_preview_mode", False),
                 )
             if self.request.GET.get("html", False):
                 html = render_html(self.request, instance, self.language)

djangocms_rest/serializers/utils/cache.py

@@ -22,15 +22,11 @@ def _get_placeholder_cache_version(placeholder, lang, site_id):
     else:
         version = int(time.time() * 1000000)
         vary_on_list = []
-        _set_placeholder_cache_version(
-            placeholder, lang, site_id, version, vary_on_list
-        )
+        _set_placeholder_cache_version(placeholder, lang, site_id, version, vary_on_list)
     return version, vary_on_list
 
 
-def _set_placeholder_cache_version(
-    placeholder, lang, site_id, version, vary_on_list=None, duration=None
-):
+def _set_placeholder_cache_version(placeholder, lang, site_id, version, vary_on_list=None, duration=None):
     """
     Sets the (placeholder x lang)'s version and vary-on header-names list.
     """
@@ -63,9 +59,7 @@ def set_placeholder_rest_cache(placeholder, lang, site_id, content, request):
 
     # "touch" the cache-version, so that it stays as fresh as this content.
     version, vary_on_list = _get_placeholder_cache_version(placeholder, lang, site_id)
-    _set_placeholder_cache_version(
-        placeholder, lang, site_id, version, vary_on_list, duration=duration
-    )
+    _set_placeholder_cache_version(placeholder, lang, site_id, version, vary_on_list, duration=duration)
 
 
 def get_placeholder_rest_cache(placeholder, lang, site_id, request):
@@ -75,9 +69,5 @@ def get_placeholder_rest_cache(placeholder, lang, site_id, request):
     """
     from django.core.cache import cache
 
-    key = (
-        _get_placeholder_cache_key(placeholder, lang, site_id, request, soft=True)
-        + ":rest"
-    )
-    content = cache.get(key)
-    return content
+    key = f"{_get_placeholder_cache_key(placeholder, lang, site_id, request, soft=True)}:rest"
+    return cache.get(key)

djangocms_rest/views.py

@@ -31,7 +31,7 @@
     get_object,
     get_site_filtered_queryset,
 )
-from djangocms_rest.views_base import BaseAPIView, BaseListAPIView
+from djangocms_rest.views_base import BaseAPIView, BaseListAPIView, preview_schema
 from djangocms_rest.schemas import extend_placeholder_schema, extend_page_search_schema, menu_schema_class
 
 # Generate the plugin definitions once at module load time
@@ -220,6 +220,7 @@ def get(self, request: Request) -> Response:
         return Response(definitions)
 
 
+@preview_schema
 @menu_schema_class
 class MenuView(BaseAPIView):
     permission_classes = [IsAllowedPublicLanguage]
@@ -298,7 +299,6 @@ def get_menu_structure(
         return result
 
 
-@menu_schema_class
 class SubMenuView(MenuView):
     tag = ShowSubMenu
 
@@ -308,7 +308,6 @@ def populate_defaults(self, kwargs: dict[str, Any]) -> None:
         kwargs.setdefault("nephews", 100)
 
 
-@menu_schema_class
 class BreadcrumbView(MenuView):
     tag = ShowBreadcrumb
     return_key = "ancestors"