♻️(backend) Making custom-translations its own endpoint

1. We adapt the implementation to align more
with the existing footer config.
(Custom-translations gets its own cached endpoint)
This allows us to better refactor in the future.

2.Default .json configurations are moved to and served from the backend.
This allows more flexible development, by not needing to use the frontend
container to have the demo configurations available.

3. The debug utility is added to the backend, to allow shared debugging.
It can be used to e.g. turn off caching during development

Signed-off-by: Robin Weber <[email protected]>

Author: rvveber

docs/customization.md

@@ -42,10 +42,10 @@ Then, set the `FRONTEND_CSS_URL` environment variable to the URL of your custom
 
 ### How to Use
 
-To provide custom translations, set the `FRONTEND_CUSTOM_TRANSLATIONS_URL` environment variable to the URL of your custom translations JSON file:
+To provide custom translations, set the `FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS` environment variable to the URL of your custom translations JSON file:
 
 ```javascript
-FRONTEND_CUSTOM_TRANSLATIONS_URL=http://example.com/custom-translations.json
+FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS=http://example.com/custom-translations.json
 ```
 
 Once you've set this variable, our application will load your custom translations and apply them to the user interface.
@@ -64,16 +64,16 @@ Let's say you want to customize some key phrases in the application. Create a JS
   "en": {
     "translation": {
       "Docs": "MyApp",
-      "Create New Document": "+"
+      "New doc": "+"
     }
   },
   "de": {
     "translation": {
       "Docs": "MeineApp",
-      "Create New Document": "+"
+      "New doc": "+"
     }
   }
 }
 ```
 
-Then set the `FRONTEND_CUSTOM_TRANSLATIONS_URL` environment variable to the URL of this JSON file. The application will load these translations and override the default ones where specified.
+Then set the `FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS` environment variable to the URL of this JSON file. The application will load these translations and override the default ones where specified.

docs/env.md

@@ -7,7 +7,7 @@ Here we describe all environment variables that can be set for the docs applicat
 These are the environmental variables you can set for the impress-backend container.
 
 | Option                                          | Description                                                                                   | default                                                 |
-| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
+|-------------------------------------------------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------|
 | DJANGO_ALLOWED_HOSTS                            | allowed hosts                                                                                 | []                                                      |
 | DJANGO_SECRET_KEY                               | secret key                                                                                    |                                                         |
 | DJANGO_SERVER_TO_SERVER_API_TOKENS              |                                                                                               | []                                                      |
@@ -51,10 +51,10 @@ These are the environmental variables you can set for the impress-backend contai
 | FRONTEND_HOMEPAGE_FEATURE_ENABLED               | frontend feature flag to display the homepage                                                 | false                                                   |
 | FRONTEND_FOOTER_FEATURE_ENABLED                 | frontend feature flag to display the footer                                                   | false                                                   |
 | FRONTEND_FOOTER_VIEW_CACHE_TIMEOUT              | Cache duration of the json footer                                                             | 86400                                                   |
-| FRONTEND_URL_JSON_FOOTER                        | Url with a json to configure the footer                                                       |                                                         |
+| FRONTEND_CUSTOM_TRANSLATIONS_VIEW_CACHE_TIMEOUT | Cache duration of the json custom translations                                                | 86400                                                   |
+| FRONTEND_URL_JSON_FOOTER                        | Url to a JSON to configure the footer                                                         |                                                         |
+| FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS           | Url to a JSON to overwrite the translations                                                   |                                                         |
 | FRONTEND_THEME                                  | frontend theme to use                                                                         |                                                         |
-| FRONTEND_CSS_URL                                | URL to a custom CSS file for theming the application                                          |                                                         |
-| FRONTEND_CUSTOM_TRANSLATIONS_URL                | URL to a JSON file containing custom translations for the application                         |                                                         |
 | POSTHOG_KEY                                     | posthog key for analytics                                                                     |                                                         |
 | CRISP_WEBSITE_ID                                | crisp website id for support                                                                  |                                                         |
 | DJANGO_CELERY_BROKER_URL                        | celery broker url                                                                             | redis://redis:6379/0                                    |

env.d/development/common.dist

@@ -65,4 +65,5 @@ COLLABORATION_WS_URL=ws://localhost:4444/collaboration/ws/
 # Frontend
 FRONTEND_THEME=default
 FRONTEND_FOOTER_FEATURE_ENABLED=True
-FRONTEND_URL_JSON_FOOTER=http://frontend:3000/contents/footer-demo.json
+FRONTEND_URL_JSON_FOOTER=http://0.0.0.0:8000/static/contents/footer-demo.json
+FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS=http://0.0.0.0:8000/static/contents/custom-translations-demo.json

src/backend/core/api/viewsets.py

@@ -19,7 +19,7 @@
 from django.utils.decorators import method_decorator
 from django.utils.text import capfirst
 from django.utils.translation import gettext_lazy as _
-from django.views.decorators.cache import cache_page
+from django.views.decorators.cache import cache_page, never_cache
 
 import requests
 import rest_framework as drf
@@ -32,7 +32,7 @@
 from core import authentication, enums, models
 from core.services.ai_services import AIService
 from core.services.collaboration_services import CollaborationService
-from core.services.config_services import get_footer_json
+from core.services.config_services import debug_enabled, get_json_from_url
 from core.utils import extract_attachments, filter_descendants
 
 from . import permissions, serializers, utils
@@ -1715,7 +1715,6 @@ def get(self, request):
             "ENVIRONMENT",
             "FRONTEND_CSS_URL",
             "FRONTEND_HOMEPAGE_FEATURE_ENABLED",
-            "FRONTEND_CUSTOM_TRANSLATIONS_URL",
             "FRONTEND_FOOTER_FEATURE_ENABLED",
             "FRONTEND_THEME",
             "MEDIA_BASE_URL",
@@ -1737,15 +1736,42 @@ class FooterView(drf.views.APIView):
 
     permission_classes = [AllowAny]
 
-    @method_decorator(cache_page(settings.FRONTEND_FOOTER_VIEW_CACHE_TIMEOUT))
+    @method_decorator(
+        never_cache
+        if debug_enabled("no-cache")
+        else cache_page(settings.FRONTEND_FOOTER_VIEW_CACHE_TIMEOUT)
+    )
     def get(self, request):
         """
         GET /api/v1.0/footer/
             Return the footer JSON.
         """
         json_footer = (
-            get_footer_json(settings.FRONTEND_URL_JSON_FOOTER)
+            get_json_from_url(settings.FRONTEND_URL_JSON_FOOTER)
             if settings.FRONTEND_URL_JSON_FOOTER
             else {}
         )
         return drf.response.Response(json_footer)
+
+
+class CustomTranslationsView(drf.views.APIView):
+    """API ViewSet for sharing the custom-translations JSON."""
+
+    permission_classes = [AllowAny]
+
+    @method_decorator(
+        never_cache
+        if debug_enabled("no-cache")
+        else cache_page(settings.FRONTEND_CUSTOM_TRANSLATIONS_VIEW_CACHE_TIMEOUT)
+    )
+    def get(self, request):
+        """
+        GET /api/v1.0/custom-translations/
+            Return the custom-translations JSON.
+        """
+        json = (
+            get_json_from_url(settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS)
+            if settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS
+            else {}
+        )
+        return drf.response.Response(json)

src/backend/core/services/config_services.py

@@ -2,24 +2,38 @@
 
 import logging
 
+from django.conf import settings
+
 import requests
 
 logger = logging.getLogger(__name__)
 
 
-def get_footer_json(footer_json_url: str) -> dict:
+def debug_enabled(namespace: str | None) -> bool:
+    """
+    Quick way to check if debug is enabled for a specific namespace
+    If no namespace is passed it just returns the value of settings.DEBUG
+    """
+    if not namespace:
+        return getattr(settings, "DEBUG", False)
+
+    if False is getattr(settings, "DEBUG", False):
+        return False
+
+    return namespace in getattr(settings, "DEBUG_NAMESPACES", [])
+
+
+def get_json_from_url(json_url: str) -> dict:
     """
-    Fetches the footer JSON from the given URL."
+    Fetches JSON from the given URL."
     """
     try:
         response = requests.get(
-            footer_json_url, timeout=5, headers={"User-Agent": "Docs-Application"}
+            json_url, timeout=5, headers={"User-Agent": "Docs-Application"}
         )
         response.raise_for_status()
 
-        footer_json = response.json()
-
-        return footer_json
+        return response.json()
     except (requests.RequestException, ValueError) as e:
-        logger.error("Failed to fetch footer JSON: %s", e)
+        logger.error("Failed to fetch JSON: %s", e)
         return {}

src/backend/core/static/contents/custom-translations-demo.json

@@ -0,0 +1,8 @@
+{
+  "en": {
+    "translation": {
+      "Docs": "MyDocs",
+      "New doc": "+"
+    }
+  }
+}

src/frontend/apps/impress/public/contents/footer-demo.json renamed to src/backend/core/static/contents/footer-demo.json

@@ -19,7 +19,6 @@
     COLLABORATION_WS_URL="http://testcollab/",
     CRISP_WEBSITE_ID="123",
     FRONTEND_CSS_URL="http://testcss/",
-    FRONTEND_CUSTOM_TRANSLATIONS_URL="http://test-custom-translations/",
     FRONTEND_FOOTER_FEATURE_ENABLED=True,
     FRONTEND_THEME="test-theme",
     MEDIA_BASE_URL="http://testserver/",
@@ -43,7 +42,6 @@ def test_api_config(is_authenticated):
         "ENVIRONMENT": "test",
         "FRONTEND_CSS_URL": "http://testcss/",
         "FRONTEND_HOMEPAGE_FEATURE_ENABLED": True,
-        "FRONTEND_CUSTOM_TRANSLATIONS_URL": "http://test-custom-translations/",
         "FRONTEND_FOOTER_FEATURE_ENABLED": True,
         "FRONTEND_THEME": "test-theme",
         "LANGUAGES": [

src/frontend/apps/impress/public/contents/footer-dsfr.json renamed to src/backend/core/static/contents/footer-dsfr.json

@@ -0,0 +1,83 @@
+"""Test the custom-translations API."""
+
+import responses
+from rest_framework.test import APIClient
+
+
+def test_api_custom_translations_without_settings_configured(settings):
+    """Test the custom-translations API without settings configured."""
+    settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS = None
+    client = APIClient()
+    response = client.get("/api/v1.0/custom-translations/")
+    assert response.status_code == 200
+    assert response.json() == {}
+
+
+@responses.activate
+def test_api_custom_translations_with_invalid_request(settings):
+    """Test the custom-translations API with an invalid request."""
+    settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS = "https://invalid-request.com"
+
+    custom_translations_response = responses.get(
+        settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS, status=404
+    )
+
+    client = APIClient()
+    response = client.get("/api/v1.0/custom-translations/")
+    assert response.status_code == 200
+    assert response.json() == {}
+    assert custom_translations_response.call_count == 1
+
+
+@responses.activate
+def test_api_custom_translations_with_invalid_json(settings):
+    """Test the custom-translations API with an invalid JSON response."""
+    settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS = "https://valid-request.com"
+
+    custom_translations_response = responses.get(
+        settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS, status=200, body="invalid json"
+    )
+
+    client = APIClient()
+    response = client.get("/api/v1.0/custom-translations/")
+    assert response.status_code == 200
+    assert response.json() == {}
+    assert custom_translations_response.call_count == 1
+
+
+@responses.activate
+def test_api_custom_translations_with_valid_json(settings):
+    """Test the custom-translations API with an invalid JSON response."""
+    settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS = "https://valid-request.com"
+
+    custom_translations_response = responses.get(
+        settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS, status=200, json={"foo": "bar"}
+    )
+
+    client = APIClient()
+    response = client.get("/api/v1.0/custom-translations/")
+    assert response.status_code == 200
+    assert response.json() == {"foo": "bar"}
+    assert custom_translations_response.call_count == 1
+
+
+@responses.activate
+def test_api_custom_translations_with_valid_json_and_cache(settings):
+    """Test the custom-translations API with an invalid JSON response."""
+    settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS = "https://valid-request.com"
+
+    custom_translations_response = responses.get(
+        settings.FRONTEND_URL_JSON_CUSTOM_TRANSLATIONS, status=200, json={"foo": "bar"}
+    )
+
+    client = APIClient()
+    response = client.get("/api/v1.0/custom-translations/")
+    assert response.status_code == 200
+    assert response.json() == {"foo": "bar"}
+    assert custom_translations_response.call_count == 1
+
+    response = client.get("/api/v1.0/custom-translations/")
+    assert response.status_code == 200
+    assert response.json() == {"foo": "bar"}
+    # The cache should have been used
+    assert custom_translations_response.call_count == 1