feat(Redis): Add Redis to the health check endpoint

bc/core/utils.py → bc/core/utils/connections.py

@@ -1,5 +1,8 @@
+import redis
 from django.db import OperationalError, connections
 
+from .redis import make_redis_interface
+
 
 def check_postgresql() -> bool:
     """Just check if we can connect to postgresql"""
@@ -11,3 +14,12 @@ def check_postgresql() -> bool:
     except OperationalError:
         return False
     return True
+
+
+def check_redis() -> bool:
+    r = make_redis_interface("QUEUE")
+    try:
+        r.ping()
+    except (redis.exceptions.ConnectionError, ConnectionRefusedError):
+        return False
+    return True

bc/core/utils/redis.py

@@ -0,0 +1,26 @@
+from typing import Literal, cast
+
+from django.conf import settings
+from redis import Redis
+
+
+def make_redis_interface(
+    db_name: str,
+    decode_responses: bool = True,
+) -> Redis:
+    """Create a redis connection object
+
+    :param db_name: The name of the database to use, as defined in our settings
+    :param decode_responses: Whether to decode responses with utf-8. If you're
+    putting binary data (like a picked object) into redis, don't try to decode
+    it.
+    :return Redis interface using django settings
+    """
+
+    return Redis.from_url(
+        url=f"{settings.REDIS_HOST}:{settings.REDIS_PORT}",
+        db=int(settings.REDIS_DATABASES[db_name]),
+        decode_responses=cast(
+            Literal[True] | Literal[False], decode_responses
+        ),
+    )

bc/core/views.py

@@ -3,7 +3,7 @@
 from django.http import HttpRequest, HttpResponse, JsonResponse
 
 from .tasks import fail_task
-from .utils import check_postgresql
+from .utils.connections import check_postgresql, check_redis
 
 
 def sentry_fail(request: HttpRequest) -> HttpResponse:
@@ -13,15 +13,16 @@ def sentry_fail(request: HttpRequest) -> HttpResponse:
 
 def health_check(request: HttpRequest) -> JsonResponse:
     """Check if we can connect to various services."""
-
+    is_redis_up = check_redis()
     is_postgresql_up = check_postgresql()
 
     status = HTTPStatus.OK
-    if not is_postgresql_up:
+    if not all([is_postgresql_up, is_redis_up]):
         status = HTTPStatus.INTERNAL_SERVER_ERROR
 
     return JsonResponse(
         {
+            "is_redis_up": is_redis_up,
             "is_postgresql_up": is_postgresql_up,
         },
         status=status,

pyproject.toml

@@ -54,6 +54,7 @@ pre-commit = "^3.0.4"
 flynt = "^0.77"
 django-stubs = "^1.14.0"
 types-requests = "^2.28.11.8"
+types-redis = "^4.4.0.6"
 
 [tool.black]
 include = '''.*\.pyi?$'''