Upgrade django-health-check from pinned git commit to PyPI 3.24.0 (#3556)

* Upgrade django-health-check from pinned git commit to PyPI 3.24.0

Replaces the stale codingjoe/django-health-check@53f9bdc3 (dev build of
3.20.1) git dependency with the newest PyPI release compatible with
Django==4.2.30: 3.24.0. 4.0.0+ requires Django>=5.2 so isn't available
here yet. Verified the settings.py integration (bare check class names
in HEALTH_CHECK["SUBSETS"], contrib.migrations/celery_ping/redis/db_heartbeat
apps, health_check.urls include) is unaffected other than new
deprecation warnings for APIs slated for removal in v4.

* Fix silently-broken health check SUBSETS matching after 3.24.0 bump

The previous commit upgraded django-health-check from a stale git pin to
PyPI 3.24.0, which (unbeknownst at the time) silently broke this repo's
HEALTH_CHECK["SUBSETS"] configuration: 3.24.0's health_check/__init__.py
now does `Cache.__qualname__ = "Cache"` (and similarly for Database) as
a global, process-wide mutation of the shared CacheBackend/
DatabaseHeartBeatCheck classes, so their dataclass-generated __repr__ no
longer matches the bare class names ("CacheBackend", "DatabaseHeartBeatCheck")
used in SUBSETS. Confirmed empirically: only "MigrationsHealthCheck" (the
one check with no reprable fields and no top-level alias) still matched;
Cache, Database, Redis, and CeleryPing were silently excluded from every
subset, meaning /health/liveness/, /health/readiness/, and most of
/health/startup/ and /health/full/ were vacuously always-200 regardless of
actual DB/cache/redis/celery status. This was a regression introduced by
the dependency bump, not a pre-existing issue: the old pinned commit's
health_check/__init__.py did no such aliasing.

Also, every one of the old INSTALLED_APPS contrib sub-apps
(health_check.contrib.{redis,db_heartbeat,celery_ping,migrations}) emits
its own DeprecationWarning at app-ready time pointing at this exact fix:
'checks are now configured via HealthCheckView... add the appropriate
check to your HealthCheckView.checks.'

Replaces the whole SUBSETS + INSTALLED_APPS-registration mechanism with
the explicit, non-fragile HealthCheckView(checks=[...]) API (already
available in 3.24.0, not just v4), matching the pattern already used in
mitxonline/micromasters/ocw-studio/mitxpro. Also fixes the CacheBackend
check to target the "redis" cache alias instead of the always-available
in-memory "default" alias, which made it a no-op regardless of the
SUBSETS bug.

Verified live via Django's test client: /health/liveness/ returns
200 {"Database(alias='default')": "OK"} against sqlite, and
/health/readiness/ correctly returns a 500 ServiceUnavailable when
pointed at an unreachable Redis instead of silently passing.

* Add bare /health/ route and URL-resolution tests

Addresses Copilot review feedback: the rewritten urls_healthcheck.py
only defined /health/{startup,liveness,readiness,full}/ subset routes,
dropping the bare /health/ index that include("health_check.urls")
previously provided. Added it back, mapped to the full check list.

Also adds main/urls_healthcheck_test.py asserting all five paths
resolve to HealthCheckView. Resolves directly against the
main.urls_healthcheck sub-urlconf (via get_resolver) rather than
django.urls.resolve() against the full project urlconf, since the
latter transitively imports the tika client (via learning_resources'
ETL utils) for the first time in a fresh test process, which triggers
a pkg_resources.declare_namespace() DeprecationWarning that this repo's
autouse warnings-as-errors fixture turns into a failure -- a
pre-existing, unrelated issue in the tika dependency, not something to
paper over by scoping down what this test actually needs to exercise.

Author: blarghmatey

main/settings.py

@@ -140,48 +140,10 @@
     "ol_hubspot",
     "mitol.scim.apps.ScimApp",
     "health_check",
-    "health_check.cache",
-    "health_check.contrib.migrations",
-    "health_check.contrib.celery_ping",
-    "health_check.contrib.redis",
-    "health_check.contrib.db_heartbeat",
 )
 
 WEBHOOK_SECRET = get_string("WEBHOOK_SECRET", "please-change-this")
 
-HEALTH_CHECK = {
-    "SUBSETS": {
-        # The 'startup' subset includes checks that must pass before the application can
-        # start.
-        "startup": [
-            "MigrationsHealthCheck",  # Ensures database migrations are applied.
-            "CacheBackend",  # Verifies the cache backend is operational.
-            "RedisHealthCheck",  # Confirms Redis is reachable and functional.
-            "DatabaseHeartBeatCheck",  # Checks the database connection is alive.
-        ],
-        # The 'liveness' subset includes checks to determine if the application is
-        # running.
-        "liveness": ["DatabaseHeartBeatCheck"],  # Minimal check to ensure the app is
-        # alive.
-        # The 'readiness' subset includes checks to determine if the application is
-        # ready to serve requests.
-        "readiness": [
-            "CacheBackend",  # Ensures the cache is ready for use.
-            "RedisHealthCheck",  # Confirms Redis is ready for use.
-            "DatabaseHeartBeatCheck",  # Verifies the database is ready for queries.
-        ],
-        # The 'full' subset includes all available health checks for a comprehensive
-        # status report.
-        "full": [
-            "MigrationsHealthCheck",  # Ensures database migrations are applied.
-            "CacheBackend",  # Verifies the cache backend is operational.
-            "RedisHealthCheck",  # Confirms Redis is reachable and functional.
-            "DatabaseHeartBeatCheck",  # Checks the database connection is alive.
-            "CeleryPingHealthCheck",  # Verifies Celery workers are responsive.
-        ],
-    }
-}
-
 if not get_bool("RUN_DATA_MIGRATIONS", default=False):
     MIGRATION_MODULES = {"data_fixtures": None}
 

main/urls.py

@@ -17,7 +17,7 @@
 from django.conf import settings
 from django.conf.urls.static import static
 from django.contrib import admin
-from django.urls import include, re_path
+from django.urls import include, path, re_path
 from django.views.generic.base import RedirectView
 from rest_framework.routers import DefaultRouter
 
@@ -60,7 +60,7 @@
         re_path(r"", include("webhooks.urls", namespace="webhooks")),
         re_path(r"", include(features_router.urls)),
         re_path(r"^app", RedirectView.as_view(url=settings.APP_BASE_URL)),
-        re_path(r"^health/", include("health_check.urls")),
+        path("", include("main.urls_healthcheck")),
     ]
     + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
     + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

main/urls_healthcheck.py

@@ -0,0 +1,55 @@
+"""Healthcheck urls"""
+
+from django.urls import include, path
+from health_check.views import HealthCheckView
+
+MIGRATIONS_CHECK = "health_check.contrib.migrations.backends.MigrationsHealthCheck"
+
+BASE_CHECKS = [
+    # "default" is in-memory and always available; "redis" is the real backing cache.
+    ("health_check.Cache", {"alias": "redis"}),
+    "health_check.Database",
+    "health_check.contrib.redis.Redis",
+]
+
+urlpatterns = [
+    path(
+        "health/",
+        include(
+            [
+                path(
+                    "",
+                    HealthCheckView.as_view(
+                        checks=[
+                            *BASE_CHECKS,
+                            MIGRATIONS_CHECK,
+                            "health_check.contrib.celery.Ping",
+                        ]
+                    ),
+                ),
+                path(
+                    "startup/",
+                    HealthCheckView.as_view(checks=[*BASE_CHECKS, MIGRATIONS_CHECK]),
+                ),
+                path(
+                    "liveness/",
+                    HealthCheckView.as_view(checks=["health_check.Database"]),
+                ),
+                path(
+                    "readiness/",
+                    HealthCheckView.as_view(checks=[*BASE_CHECKS]),
+                ),
+                path(
+                    "full/",
+                    HealthCheckView.as_view(
+                        checks=[
+                            *BASE_CHECKS,
+                            MIGRATIONS_CHECK,
+                            "health_check.contrib.celery.Ping",
+                        ]
+                    ),
+                ),
+            ]
+        ),
+    ),
+]

main/urls_healthcheck_test.py

@@ -0,0 +1,23 @@
+"""Tests for the healthcheck urls"""
+
+import pytest
+from django.urls import get_resolver
+from health_check.views import HealthCheckView
+
+
+@pytest.mark.parametrize(
+    "path",
+    [
+        "/health/",
+        "/health/startup/",
+        "/health/liveness/",
+        "/health/readiness/",
+        "/health/full/",
+    ],
+)
+def test_healthcheck_urls_resolve(path):
+    """All healthcheck endpoints should resolve to HealthCheckView"""
+    # Resolve directly against this urlconf module rather than django.urls.resolve()
+    # (which walks the full project urlconf) to avoid pulling in unrelated apps.
+    match = get_resolver("main.urls_healthcheck").resolve(path)
+    assert match.func.view_class is HealthCheckView

pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
     "django-cors-headers>=4.0.0,<5",
     "django-filter>=2.4.0,<3",
     "django-guardian>=3.0.0,<4",
-    "django-health-check",
+    "django-health-check>=3.24.0,<4",
     "django-imagekit>=6.0.0,<7",
     "django-ipware>=7.0.0,<8",
     "django-json-widget>=2.0.0,<3",
@@ -154,9 +154,6 @@ package = false
 default-groups = "all"
 override-dependencies = ["setuptools<80"]
 
-[tool.uv.sources]
-django-health-check = { git = "https://github.com/revsys/django-health-check", rev = "53f9bdc3a7acc8a577319987fef0bd3040eef4b4" } # pragma: allowlist secret
-
 [tool.uv.build-backend]
 module-root = ""