Update dependency django-health-check to v4 (#1598)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Olivér Kecskeméty <kecskemety.oliver@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

Dockerfile

@@ -173,7 +173,7 @@ ENTRYPOINT ["/app/entrypoint.sh"]
 
 # Set health check
 HEALTHCHECK --start-period=20s --interval=30s --retries=5 --timeout=30s \
-    CMD python manage.py health_check
+    CMD python manage.py health_check health_check --no-http
 
 # Start the server
 CMD ["gunicorn", "--bind=0.0.0.0:8000", "--workers=5", "--threads=2", "core.wsgi"]

backend/.env.sample

@@ -9,7 +9,6 @@ CORS_ALLOWED_ORIGINS = http://localhost:8000  # Optional. Empty as default. List
 CSRF_TRUSTED_ORIGINS = https://website.example.com  # Optional. Empty as default. A list of trusted origins for unsafe requests. Required if you want to access Django Admin.
 DJANGO_ADMIN = True  # Optional. Default: True. If True Django's admin panel will be available under /django-admin/
 DJANGO_SETTINGS_MODULE = core.settings.production  # Optional. Default: core.settings.production. Options: core.settings.{production, staging, debug, test}
-HEALTH_CHECK_API = False  # Optional. Default: False. Enables /api/v1/health API endpoint for app health check.
 HEALTH_CHECK_URL_TOKEN = randomGeneratedToken  # Optional. Default: None. If set the health check endpoint will be available only under /api/v1/health/{token}.
     # You can use python -c "import secrets; print(secrets.token_urlsafe())" command to generate a token.
 LANGUAGE_CODE = hu-hu  # Optional. Default: en-us

backend/Dockerfile

@@ -80,7 +80,7 @@ EXPOSE 8000
 
 # Set health check
 HEALTHCHECK --start-period=30s --interval=5m \
-    CMD python manage.py health_check
+    CMD python manage.py health_check health_check --no-http
 
 # Do the migrations and start the server
 CMD ["sh", "-c", "python manage.py migrate; gunicorn --bind=0.0.0.0:8000 --workers=5 --threads=2 core.wsgi"]

backend/api/v1/urls.py

@@ -14,17 +14,6 @@
     path("misc/", include(("api.v1.misc.urls", "misc"), namespace="misc")),
 ]
 
-if settings.HEALTH_CHECK_API_ENABLED:
-    token = (
-        f"/{settings.HEALTH_CHECK_URL_TOKEN}"
-        if hasattr(settings, "HEALTH_CHECK_URL_TOKEN")
-        and settings.HEALTH_CHECK_URL_TOKEN is not None
-        else ""
-    )
-    urlpatterns += [
-        path(f"health{token}", include("health_check.urls")),
-    ]
-
 if settings.SPECTACULAR_SERVE_SCHEMA:
     from drf_spectacular.views import (
         SpectacularAPIView,

backend/common/tests.py

@@ -1,4 +1,5 @@
 import json
+import re
 from io import StringIO
 
 from django.conf import settings
@@ -64,24 +65,36 @@ def test_health_check_api_endpoint_works(self):
             and settings.HEALTH_CHECK_URL_TOKEN is not None
             else ""
         )
-        response = self.client.get(f"/api/v1/health{token}?format=json")
+        response = self.client.get(f"/health{token}?format=json")
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         response.data = json.loads(response.content)
-        self.assertIn("Cache backend: default", response.data)
-        self.assertIn("DatabaseBackend", response.data)
-        self.assertIn("DefaultFileStorageHealthCheck", response.data)
-        self.assertIn("MigrationsHealthCheck", response.data)
-        self.assertIn("RedisHealthCheck", response.data)
+        self.assertIn("Cache(alias='default')", response.data)
+        self.assertIn("Database(alias='default')", response.data)
+        self.assertIn(
+            "Mail(backend='django.core.mail.backends.dummy.EmailBackend')",
+            response.data,
+        )
+        self.assertIn("Storage(alias='default')", response.data)
+        self.assertTrue(
+            any(
+                re.search(r"Redis\(host='[^']+', port=6379\)", key)
+                for key in response.data
+            )
+        )
 
     def test_health_check_management_command_works(self):
         with StringIO() as out:
-            call_command("health_check", stdout=out)
-            self.assertEqual(out.getvalue().count("working"), 5)
-            self.assertIn("Cache backend: default", out.getvalue())
-            self.assertIn("DatabaseBackend", out.getvalue())
-            self.assertIn("DefaultFileStorageHealthCheck", out.getvalue())
-            self.assertIn("MigrationsHealthCheck", out.getvalue())
-            self.assertIn("RedisHealthCheck", out.getvalue())
+            with self.assertRaises(SystemExit) as cm:
+                call_command("health_check", "health_check", "--no-http", stdout=out)
+            self.assertEqual(cm.exception.code, 0)
+            self.assertIn("Cache(alias='default')", out.getvalue())
+            self.assertIn("Database(alias='default')", out.getvalue())
+            self.assertIn(
+                "Mail(backend='django.core.mail.backends.dummy.EmailBackend')",
+                out.getvalue(),
+            )
+            self.assertIn("Storage(alias='default')", out.getvalue())
+            self.assertRegex(out.getvalue(), r"Redis\(host='[^']+', port=6379\)")
 
     def test_user_profile_avatar_json_validation(self):
         self.user.refresh_from_db()

backend/core/settings/base.py

@@ -19,6 +19,7 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.core.management.utils import get_random_secret_key
 from django.utils.translation import gettext_lazy as _
+from redis.asyncio import Redis as RedisClient
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BACKEND_DIR = os.path.dirname(
@@ -60,6 +61,7 @@
     "drf_recaptcha",
     "drf_spectacular",
     "corsheaders",
+    "health_check",
     "rest_framework_simplejwt.token_blacklist",
     "phonenumber_field",
     "simple_history",
@@ -322,23 +324,24 @@
 
 # Health check
 # https://django-health-check.readthedocs.io/en/stable/
-
-HEALTH_CHECK_API_ENABLED = config("HEALTH_CHECK_API", default=False, cast=bool)
-HEALTH_CHECK_URL_TOKEN = config("HEALTH_CHECK_URL_TOKEN", default=None)
-INSTALLED_APPS += [
-    "health_check",
-    "health_check.db",
-    "health_check.cache",
-    "health_check.storage",
-    "health_check.contrib.migrations",
-    "health_check.contrib.celery_ping",
-    "health_check.contrib.redis",
-]
 try:
     REDIS_URL = match("^redis://[a-zA-Z0-9]+:[0-9]+", CACHEOPS_REDIS).group(0)
 except AttributeError:
     raise ImproperlyConfigured("Cannot extract proper Redis URL from CACHE_REDIS.")
 
+HEALTH_CHECK_URL_TOKEN = config("HEALTH_CHECK_URL_TOKEN", default=None)
+HEALTH_CHECK_ENABLED_CHECKS = [
+    "health_check.Cache",
+    "health_check.Database",
+    "health_check.Mail",
+    "health_check.Storage",
+    "health_check.contrib.celery.Ping",
+    (
+        "health_check.contrib.redis.Redis",
+        {"client_factory": lambda: RedisClient.from_url(REDIS_URL)},
+    ),
+]
+
 # Django REST reCAPTCHA
 # https://github.com/llybin/drf-recaptcha
 

backend/core/settings/test.py

@@ -6,10 +6,6 @@
 DATABASES["default"].update({"HOST": config("DATABASE_HOST", default="localhost")})
 CACHEOPS_REDIS = config("CACHE_REDIS", default="redis://localhost:6379/0")
 CELERY_BROKER_URL = config("CELERY_BROKER", default="redis://localhost:6379/1")
-try:
-    REDIS_URL = match("^redis://[a-zA-Z0-9]+:[0-9]+", CACHEOPS_REDIS).group(0)
-except AttributeError:
-    raise ImproperlyConfigured("Cannot extract proper Redis URL from CACHE_REDIS.")
 
 # Use the default Django authentication backend
 AUTHENTICATION_BACKENDS += ["django.contrib.auth.backends.ModelBackend"]
@@ -82,12 +78,23 @@
 # Random external token
 SCH_EVENTS_TOKEN = "123456789abcdef"  # nosec
 
-# Enable health check endpoint and remove celery from checks
-HEALTH_CHECK_API_ENABLED = True
+# Remove celery and update Redis health check to use the local REDIS_URL
 try:
-    INSTALLED_APPS.remove("health_check.contrib.celery_ping")
-except ValueError:
-    pass
+    REDIS_URL = match("^redis://[a-zA-Z0-9]+:[0-9]+", CACHEOPS_REDIS).group(0)
+except AttributeError:
+    raise ImproperlyConfigured("Cannot extract proper Redis URL from CACHE_REDIS.")
+
+HEALTH_CHECK_ENABLED_CHECKS = [
+    check
+    for check in HEALTH_CHECK_ENABLED_CHECKS
+    if check != "health_check.contrib.celery.Ping"
+    and not (isinstance(check, tuple) and "Redis" in check[0])
+] + [
+    (
+        "health_check.contrib.redis.Redis",
+        {"client_factory": lambda: RedisClient.from_url(REDIS_URL)},
+    ),
+]
 
 # Set DRF reCAPTCHA to test mode
 DRF_RECAPTCHA_TESTING = True

backend/core/urls.py

@@ -18,6 +18,7 @@
 from django.contrib import admin
 from django.urls import include, path, re_path
 from django.views.generic import TemplateView
+from health_check.views import HealthCheckView
 
 urlpatterns = [
     path("api/", include(("api.urls", "api"), namespace="api")),
@@ -27,6 +28,23 @@
     re_path(r"", TemplateView.as_view(template_name="index.html")),  # React frontend
 ]
 
+# Django HealthCheck endpoints
+token = (
+    f"/{settings.HEALTH_CHECK_URL_TOKEN}"
+    if hasattr(settings, "HEALTH_CHECK_URL_TOKEN")
+    and settings.HEALTH_CHECK_URL_TOKEN is not None
+    else ""
+)
+
+urlpatterns.insert(
+    0,
+    path(
+        f"health{token}",
+        HealthCheckView.as_view(checks=settings.HEALTH_CHECK_ENABLED_CHECKS),
+        name="health_check",
+    ),
+)
+
 # Enable Django Admin when requested
 if settings.DJANGO_ADMIN and "django.contrib.admin" in settings.INSTALLED_APPS:
     urlpatterns.insert(0, path("django-admin/", admin.site.urls))

backend/poetry.lock

@@ -18,7 +18,7 @@ dependencies = [
     "django-celery-results==2.6.0",
     "django-cors-headers==4.9.0",
     "django-filter==25.2",
-    "django-health-check==3.20.8",
+    "django-health-check[celery,redis]==4.1.2",
     "django-phonenumber-field[phonenumbers]==8.4.0",
     "django-simple-history==3.11.0",
     "drf-recaptcha==4.0.3",
@@ -46,7 +46,6 @@ omit = [
     "*/migrations/*",
     "*/admin.py",
     "*/tests.py",
-    "common/health_checks.py",
     "manage.py",
 ]
 exclude_lines = [