feat: environment title prefix (#1081)

lukasvinclav · web-flow · commit 63164271485d · 2025-02-18T17:05:13.000+01:00
diff --git a/docs/configuration/settings.md b/docs/configuration/settings.md
@@ -50,7 +50,8 @@ UNFOLD = {
     "SHOW_HISTORY": True, # show/hide "History" button, default: True
     "SHOW_VIEW_ON_SITE": True, # show/hide "View on site" button, default: True
     "SHOW_BACK_BUTTON": False, # show/hide "Back" button on changeform in header, default: False
-    "ENVIRONMENT": "sample_app.environment_callback",
+    "ENVIRONMENT": "sample_app.environment_callback", # environment name in header
+    "ENVIRONMENT_TITLE_PREFIX": "sample_app.environment_title_prefix_callback", # environment name prefix in title tag
     "DASHBOARD_CALLBACK": "sample_app.dashboard_callback",
     "THEME": "dark", # Force theme: "dark" or "light". Will disable theme switcher
     "LOGIN": {
diff --git a/src/unfold/settings.py b/src/unfold/settings.py
@@ -54,6 +54,7 @@
     },
     "DASHBOARD_CALLBACK": None,
     "ENVIRONMENT": None,
+    "ENVIRONMENT_TITLE_PREFIX": None,
     "STYLES": [],
     "SCRIPTS": [],
     "SIDEBAR": {
diff --git a/src/unfold/sites.py b/src/unfold/sites.py
@@ -88,6 +88,9 @@ def each_context(self, request: HttpRequest) -> dict[str, Any]:
             "border_radius": self._get_config("BORDER_RADIUS", request),
             "colors": self._get_colors("COLORS", request),
             "environment": self._get_config("ENVIRONMENT", request),
+            "environment_title_prefix": self._get_config(
+                "ENVIRONMENT_TITLE_PREFIX", request
+            ),
             "tab_list": self.get_tabs_list(request),
             "styles": self._get_list("STYLES", request),
             "scripts": self._get_list("SCRIPTS", request),
diff --git a/src/unfold/templates/unfold/layouts/skeleton.html b/src/unfold/templates/unfold/layouts/skeleton.html
@@ -14,9 +14,8 @@
 
 <!DOCTYPE html>
 <html lang="{{ LANGUAGE_CODE|default:"en-us" }}" dir="{{ LANGUAGE_BIDI|yesno:"rtl,ltr,auto" }}" {% if theme %}class="{{ theme }}"{% endif %} x-data="{ adminTheme: {% if theme %}'{{ theme }}'{% else %}$persist('auto').as('adminTheme'){% endif %} }" x-bind:class="{'dark': adminTheme === 'dark' || (adminTheme === 'auto' && window.matchMedia('(prefers-color-scheme: dark)').matches)}" x-cloak>
-
     <head>
-        <title>{% block title %}{% endblock %}</title>
+        <title>{{ environment_title_prefix|default:"" }} {% block title %}{% endblock %}</title>
 
         <link href="{% static "unfold/fonts/inter/styles.css" %}" rel="stylesheet">
         <link href="{% static "unfold/fonts/material-symbols/styles.css" %}" rel="stylesheet">
diff --git a/tests/test_environment.py b/tests/test_environment.py
@@ -10,6 +10,10 @@ def environment_callback(request):
     return ["Testing Environment", "warning"]
 
 
+def environment_title_prefix_callback(request):
+    return "[TEST]"
+
+
 @override_settings(UNFOLD={**CONFIG_DEFAULTS})
 def test_environment_empty_environment_callback():
     admin_site = UnfoldAdminSite()
@@ -55,3 +59,20 @@ def test_environment_correct_environment_callback():
     context = admin_site.each_context(request)
     assert "environment" in context
     assert context["environment"] == ["Testing Environment", "warning"]
+
+
+@override_settings(
+    UNFOLD={
+        **CONFIG_DEFAULTS,
+        **{
+            "ENVIRONMENT_TITLE_PREFIX": "tests.test_environment.environment_title_prefix_callback",
+        },
+    }
+)
+def test_environment_title_prefix_correct_environment_callback():
+    admin_site = UnfoldAdminSite()
+    request = RequestFactory().get("/rand")
+    request.user = AnonymousUser()
+    context = admin_site.each_context(request)
+    assert "environment_title_prefix" in context
+    assert context["environment_title_prefix"] == "[TEST]"
