Merge branch 'main' into fest/menu-endpoint

Author: fsbraun

.github/workflows/test.yml

@@ -32,7 +32,7 @@ jobs:
         pip install .
 
     - name: Run coverage
-      run: coverage run runtests.py
+      run: coverage run -m pytest
 
     - name: Upload Coverage to Codecov
       uses: codecov/[email protected]

djangocms_rest/middleware.py

@@ -0,0 +1,45 @@
+from typing import Callable
+
+from django.contrib.sites.shortcuts import get_current_site
+from django.contrib.sites.models import Site
+from django.http import (
+    HttpRequest,
+    HttpResponse,
+    HttpResponseBadRequest,
+    HttpResponseNotFound,
+)
+
+
+class SiteContextMiddleware:
+    def __init__(self, get_response: Callable[[HttpRequest], HttpResponse]):
+        self.get_response = get_response
+
+    def __call__(self, request: HttpRequest) -> HttpResponse:
+        """
+        Process the request to determine the site context.
+        Sets the site object on the request based on the site ID provided in
+        the request headers or falls back to the current site.
+
+        Args:
+            request: The HTTP request object
+
+        Returns:
+            Optional[HttpResponse]: Either an HTTP error response if site identification
+                           fails, or None to continue down the middleware chain
+        """
+        site_id = request.headers.get("X-Site-ID")
+
+        if site_id:
+            try:
+                site_id = int(site_id)
+                # Using _get_site_by_id directly as it leverages Django's internal site caching
+                site = Site.objects._get_site_by_id(site_id)
+                request.site = site
+            except ValueError:
+                return HttpResponseBadRequest("Invalid site ID format.")
+            except Site.DoesNotExist:
+                return HttpResponseNotFound("The requested site could not be found.")
+
+        else:
+            request.site = get_current_site(request)
+        return self.get_response(request)

djangocms_rest/views_base.py

@@ -1,6 +1,5 @@
 from django.contrib.sites.shortcuts import get_current_site
 from django.utils.functional import cached_property
-
 from rest_framework.generics import ListAPIView
 from rest_framework.permissions import IsAdminUser
 from rest_framework.views import APIView
@@ -18,7 +17,8 @@ def site(self):
         """
         Fetch and cache the current site and make it available to all views.
         """
-        return get_current_site(self.request)
+        site = getattr(self.request, "site", None)
+        return site if site is not None else get_current_site(self.request)
 
     @property
     def content_getter(self):
@@ -46,5 +46,4 @@ class BaseListAPIView(BaseAPIMixin, ListAPIView):
     """
     This is a base class for all list API views. It supports default pagination and sets the allowed methods to GET and OPTIONS.
     """
-
     pass

tests/middleware/test_site_context_middleware.py

@@ -0,0 +1,117 @@
+from django.urls import reverse
+
+from tests.base import BaseCMSRestTestCase
+
+from django.contrib.sites.models import Site
+from cms.api import create_page, publish_page
+
+
+class SiteContextMiddlewareTestCase(BaseCMSRestTestCase):
+    @classmethod
+    def setUpClass(cls):
+        """
+        Sets up a test environment with multiple sites.
+        """
+        super().setUpClass()
+
+        cls.site1 = Site.objects.get(id=1)
+        cls.site1.domain = "site1.example.com"
+        cls.site1.name = "Site 1"
+        cls.site1.save()
+
+        cls.site2 = Site.objects.create(domain="site2.example.com", name="Site 2")
+
+    @classmethod
+    def tearDownClass(cls):
+        """
+        Clean up the test environment and reset site 1.
+        """
+        try:
+            cls.site2.delete()
+        except Site.DoesNotExist:
+            pass
+
+        try:
+            cls.site1.domain = "example.com"
+            cls.site1.name = "example.com"
+            cls.site1.save()
+        except Site.DoesNotExist:
+            pass
+
+        super().tearDownClass()
+
+    def test_site_middleware_with_header(self):
+        """
+        Test the SiteContextMiddleware correctly handles X-Site-ID header
+        and returns different pages based on the site id.
+
+        Verifies:
+        - Middleware uses the site ID from X-Site-ID header
+        - the Same path returns different content based on site ID
+        - Invalid site ID returns appropriate error
+        - Missing site ID uses default site
+        """
+        # Create specific test pages with unique titles for each site
+        site1_test_page = create_page(
+            title="Site 1 Test Page",
+            template="page.html",
+            language="en",
+            slug="test-page",
+            site=self.site1,
+        )
+        publish_page(site1_test_page, "en", True)
+
+        site2_test_page = create_page(
+            title="Site 2 Test Page",
+            template="page.html",
+            language="en",
+            slug="test-page",
+            site=self.site2,
+        )
+        publish_page(site2_test_page, "en", True)
+
+        # Test with site 1 header
+        response = self.client.get(
+            reverse("page-detail", kwargs={"language": "en", "path": "test-page"}),
+            HTTP_X_SITE_ID="1",
+        )
+        self.assertEqual(response.status_code, 200)
+        site1_data = response.json()
+
+        # Test with site 2 header
+        response = self.client.get(
+            reverse("page-detail", kwargs={"language": "en", "path": "test-page"}),
+            HTTP_X_SITE_ID="2",
+        )
+        self.assertEqual(response.status_code, 200)
+        site2_data = response.json()
+
+        # Compare titles - these should be different
+        self.assertEqual(site1_data.get("title"), "Site 1 Test Page")
+        self.assertEqual(site2_data.get("title"), "Site 2 Test Page")
+        self.assertNotEqual(site1_data.get("title"), site2_data.get("title"))
+
+        # Test invalid site ID
+        response = self.client.get(
+            reverse("page-detail", kwargs={"language": "en", "path": "test-page"}),
+            HTTP_X_SITE_ID="999",
+        )
+        self.assertEqual(response.status_code, 404)
+
+        # Test invalid site ID format
+        response = self.client.get(
+            reverse("page-detail", kwargs={"language": "en", "path": "test-page"}),
+            HTTP_X_SITE_ID="invalid",
+        )
+        self.assertEqual(response.status_code, 400)
+
+        # Test without a site ID header (should default to site 1)
+        response = self.client.get(
+            reverse("page-detail", kwargs={"language": "en", "path": "test-page"})
+        )
+        self.assertEqual(response.status_code, 200)
+        default_data = response.json()
+
+        # Verify default site returns the same content as site 1
+        self.assertEqual(default_data.get("title"), site1_data.get("title"))
+        self.assertEqual(default_data.get("title"), "Site 1 Test Page")

tests/settings.py

@@ -19,9 +19,9 @@ def __getitem__(self, item):
 SECRET_KEY = "djangocms-text-test-suite"
 
 INSTALLED_APPS = [
+    "django.contrib.sites",
     "django.contrib.contenttypes",
     "django.contrib.auth",
-    "django.contrib.sites",
     "django.contrib.sessions",
     "django.contrib.admin",
     "django.contrib.messages",
@@ -40,6 +40,7 @@ def __getitem__(self, item):
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
+    "djangocms_rest.middleware.SiteContextMiddleware",
     "cms.middleware.user.CurrentUserMiddleware",
     "cms.middleware.page.CurrentPageMiddleware",
     "cms.middleware.toolbar.ToolbarMiddleware",

tox.ini

@@ -21,7 +21,7 @@ deps =
 commands =
     {envpython} --version
     {env:COMMAND:coverage} erase
-    {env:COMMAND:coverage} run runtests.py
+    {env:COMMAND:coverage} run -m pytest
     {env:COMMAND:coverage} report
 
 [testenv:ruff]