feat: Remove PlaceholderRelationSerializer and add Placeholder content instead (#73)

* feat: Remove distinction between PlaceholderRelationSerializer and PlaceholderSerializer

* fix: Preview placeholders not shown

* fix: Typde definitions

* fix: Placeholder serializer copied admin GET params

* fix: Add schema for placeholder content and tests that the open api schema is correct

* Update coverage base for test setup

Author: fsbraun

djangocms_rest/serializers/pages.py

@@ -5,7 +5,7 @@
 
 from rest_framework import serializers
 
-from djangocms_rest.serializers.placeholders import PlaceholderRelationSerializer
+from djangocms_rest.serializers.placeholders import PlaceholderSerializer
 from djangocms_rest.utils import get_absolute_frontend_url
 
 
@@ -131,7 +131,7 @@ def to_representation(self, page_content: PageContent) -> dict:
 
 
 class PageContentSerializer(BasePageSerializer, BasePageContentMixin):
-    placeholders = PlaceholderRelationSerializer(many=True, required=False)
+    placeholders = PlaceholderSerializer(many=True, required=False)
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -142,19 +142,9 @@ def to_representation(self, page_content: PageContent) -> dict:
         placeholders = [
             placeholder for placeholder in page_content.placeholders.all() if placeholder.slot in declared_slots
         ]
-
-        placeholders_data = [
-            {
-                "content_type_id": placeholder.content_type_id,
-                "object_id": placeholder.object_id,
-                "slot": placeholder.slot,
-            }
-            for placeholder in placeholders
-        ]
-
         data = self.get_base_representation(page_content)
-        data["placeholders"] = PlaceholderRelationSerializer(
-            placeholders_data,
+        data["placeholders"] = PlaceholderSerializer(
+            placeholders,
             language=page_content.language,
             many=True,
             context={"request": self.request},

djangocms_rest/serializers/placeholders.py

@@ -1,3 +1,5 @@
+from urllib.parse import urlencode
+
 from django.template import Context
 from django.urls import reverse
 
@@ -6,77 +8,85 @@
 from djangocms_rest.serializers.utils.render import render_html
 from djangocms_rest.utils import get_absolute_frontend_url
 
+try:
+    from drf_spectacular.utils import extend_schema_field
+
+    HAS_SPECTACULAR = True
+except ImportError:  # pragma: no cover
+    HAS_SPECTACULAR = False
+
+    def extend_schema_field(field_schema):
+        def decorator(field):
+            return field
+
+        return decorator
+
 
 class PlaceholderSerializer(serializers.Serializer):
     slot = serializers.CharField()
     label = serializers.CharField()
     language = serializers.CharField()
-    content = serializers.ListSerializer(child=serializers.JSONField(), allow_empty=True, required=False)
+
+    # Annotate the content field for OpenAPI schema generation
+    @extend_schema_field(
+        {
+            "type": "array",
+            "items": {"type": "object"},
+            "description": "List of serialized plugin data for this placeholder",
+        }
+    )
+    class ContentField(serializers.ListSerializer):
+        child = serializers.JSONField()
+
+    content = ContentField(allow_empty=True, required=False)
+    details = serializers.URLField()
     html = serializers.CharField(default="", required=False)
 
     def __init__(self, *args, **kwargs):
-        request = kwargs.pop("request", None)
-        placeholder = kwargs.pop("instance", None)
-        language = kwargs.pop("language", None)
-        render_plugins = kwargs.pop("render_plugins", True)
+        self.request = kwargs.pop("request", None)
+        self.language = kwargs.pop("language", None)
+        self.render_plugins = kwargs.pop("render_plugins", True)
         super().__init__(*args, **kwargs)
-        if request is None:
-            request = self.context.get("request")
+        if self.request is None:
+            self.request = self.context.get("request")
 
-        if placeholder and request and language:
-            if render_plugins:
+    def to_representation(self, instance):
+        instance.label = instance.get_label()
+        instance.language = self.language
+        instance.details = self.get_details(instance)
+        if instance and self.request and self.language:
+            if self.render_plugins:
                 from djangocms_rest.plugin_rendering import RESTRenderer
 
-                renderer = RESTRenderer(request)
-                placeholder.content = renderer.serialize_placeholder(
-                    placeholder,
-                    context=Context({"request": request}),
-                    language=language,
+                renderer = RESTRenderer(self.request)
+                instance.content = renderer.serialize_placeholder(
+                    instance,
+                    context=Context({"request": self.request}),
+                    language=self.language,
                     use_cache=True,
                 )
-            if request.GET.get("html", False):
-                html = render_html(request, placeholder, language)
+            if self.request.GET.get("html", False):
+                html = render_html(self.request, instance, self.language)
                 for key, value in html.items():
-                    if not hasattr(placeholder, key):
-                        setattr(placeholder, key, value)
-                        self.fields[key] = serializers.CharField()
-            placeholder.label = placeholder.get_label()
-            placeholder.language = language
-            self.instance = placeholder
+                    if not hasattr(instance, key):
+                        setattr(instance, key, value)
 
-
-class PlaceholderRelationSerializer(serializers.Serializer):
-    content_type_id = serializers.IntegerField()
-    object_id = serializers.IntegerField()
-    slot = serializers.CharField()
-    details = serializers.URLField()
-
-    def __init__(self, *args, **kwargs):
-        language = kwargs.pop("language", None)
-        super().__init__(*args, **kwargs)
-        self.request = self.context.get("request")
-        self.language = language
-
-    def to_representation(self, instance):
-        instance["details"] = self.get_details(instance)
         return super().to_representation(instance)
 
     def get_details(self, instance):
-        api_endpoint = get_absolute_frontend_url(
+        url = get_absolute_frontend_url(
             self.request,
             reverse(
                 "placeholder-detail",
                 args=[
                     self.language,
-                    instance.get("content_type_id"),
-                    instance.get("object_id"),
-                    instance.get("slot"),
+                    instance.content_type_id,
+                    instance.object_id,
+                    instance.slot,
                 ],
             ),
         )
-        if self.request._preview_mode:
-            if "?" in api_endpoint:
-                api_endpoint += "&preview=1"
-            else:
-                api_endpoint += "?preview=1"
-        return api_endpoint
+        get_params = {key: self.request.GET[key] for key in ("html", "preview") if key in self.request.GET}
+        if get_params:
+            url += "?" + urlencode(get_params)
+        return url

tests/settings.py

@@ -181,6 +181,7 @@ def __getitem__(self, item):
 REST_FRAMEWORK = {
     "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
     "PAGE_SIZE": 10,
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
 
 USE_TZ = True