♻️ refactor: review suggestions

Author: pyanderson

backend/.env.example

@@ -1,10 +1,11 @@
 DJANGO_SETTINGS_MODULE={{project_name}}.settings.local
-# Label shown in the Django admin header to make the active environment explicit.
-ADMIN_ENVIRONMENT_LABEL=Local
-ADMIN_ENVIRONMENT_COLOR=#111827
-ADMIN_ENVIRONMENT_BACKGROUND_COLOR=#f59e0b
 CELERY_BROKER_URL=amqp://broker:5672//
 REDIS_URL=redis://result:6379
 # Please choose postgres or sqlite as your DB:
 # DATABASE_URL=postgres://{{project_name}}:password@db:5432/{{project_name}}
 # DATABASE_URL=sqlite:///db.sqlite3
+
+## Label shown in the Django admin header to make the active environment explicit.
+ADMIN_ENVIRONMENT_LABEL=Local
+ADMIN_ENVIRONMENT_COLOR=#111827
+ADMIN_ENVIRONMENT_BACKGROUND_COLOR=#f59e0b

backend/common/context_processors.py

@@ -1,14 +1,30 @@
+import logging
 import os
 
 from django.conf import settings
 
 
+logger = logging.getLogger(__name__)
+
+
 def _default_admin_environment_label():
     settings_module = getattr(settings, "SETTINGS_MODULE", "") or os.getenv(
         "DJANGO_SETTINGS_MODULE", ""
     )
     if settings_module:
-        return settings_module.rsplit(".", maxsplit=1)[-1].replace("_", " ").title()
+        try:
+            environment_label = (
+                settings_module.rsplit(".", maxsplit=1)[-1].replace("_", " ").title()
+            )
+            if not environment_label:
+                raise IndexError
+            return environment_label
+        except IndexError:
+            logger.warning(
+                "Could not determine admin environment label from SETTINGS_MODULE: %s",
+                settings_module,
+            )
+            return "Unknown"
 
     return "Local"
 

backend/project_name/settings/base.py

@@ -182,11 +182,6 @@ def base_dir_join(*args):
 # Sentry
 SENTRY_DSN = config("SENTRY_DSN", default="")
 COMMIT_SHA = config("RENDER_GIT_COMMIT", default="")
-ADMIN_ENVIRONMENT_LABEL = config("ADMIN_ENVIRONMENT_LABEL", default="")
-ADMIN_ENVIRONMENT_COLOR = config("ADMIN_ENVIRONMENT_COLOR", default="#111827")
-ADMIN_ENVIRONMENT_BACKGROUND_COLOR = config(
-    "ADMIN_ENVIRONMENT_BACKGROUND_COLOR", default="#f59e0b"
-)
 
 # Fix for Safari 12 compatibility issues, please check:
 # https://github.com/vintasoftware/safari-samesite-cookie-issue
@@ -257,3 +252,8 @@ def base_dir_join(*args):
 DEFENDER_COOLOFF_TIME = 300  # 5 minutes
 DEFENDER_LOCKOUT_TEMPLATE = "defender/lockout.html"
 DEFENDER_REDIS_URL = config("REDIS_URL")
+
+# Admin Env Label"
+ADMIN_ENVIRONMENT_LABEL = config("ADMIN_ENVIRONMENT_LABEL", default="")
+ADMIN_ENVIRONMENT_COLOR = config("ADMIN_ENVIRONMENT_COLOR", default="#111827")
+ADMIN_ENVIRONMENT_BACKGROUND_COLOR = config("ADMIN_ENVIRONMENT_BACKGROUND_COLOR", default="#f59e0b")

backend/project_name/settings/production.py

@@ -135,6 +135,8 @@
 
 # Sentry
 sentry_sdk.init(dsn=SENTRY_DSN, integrations=[DjangoIntegration()], release=COMMIT_SHA)
+
+# Admin Env Label
 ADMIN_ENVIRONMENT_LABEL = config("ADMIN_ENVIRONMENT_LABEL", default="")
 ADMIN_ENVIRONMENT_COLOR = config("ADMIN_ENVIRONMENT_COLOR", default="white")
 ADMIN_ENVIRONMENT_BACKGROUND_COLOR = config("ADMIN_ENVIRONMENT_BACKGROUND_COLOR", default="red")