Update heath check

deep/settings.py

@@ -218,6 +218,14 @@
     'drf_yasg',  # API Documentation
     'graphene_django',
     'graphene_graphiql_explorer',
+    # heath check
+    'health_check',
+    'health_check.db',                          # stock Django health checkers
+    'health_check.cache',
+    'health_check.storage',
+    'health_check.contrib.migrations',
+    'health_check.contrib.celery',              # requires celery
+    'health_check.contrib.celery_ping',         # requires celery
 ] + [
     '{}.{}.apps.{}Config'.format(
         APPS_DIR.split('/')[-1],

deep/tests/test_case.py

@@ -7,13 +7,10 @@
 )
 
 import datetime
-from django.urls import reverse
 from django.test import override_settings
 from django.utils import timezone
 from django.conf import settings
 
-from unittest.mock import patch
-
 
 from deep.middleware import _set_current_request as _set_middleware_current_request
 from user.models import User
@@ -358,21 +355,3 @@ def get_aware_datetime(self, *args, **kwargs):
 
     def get_aware_datetime_str(self, *args, **kwargs):
         return self.get_datetime_str(self.get_aware_datetime(*args, **kwargs))
-
-
-class HealthCheckViewTests(test.APITestCase):
-    @patch('deep.views.current_app.control.ping')
-    def test_health_check_healthy(self, mock_ping):
-        mock_ping.return_value = [{'celery@worker1': {'ok': 'pong'}}]
-
-        response = self.client.get(reverse('celery_health_check'))
-        self.assertEqual(response.status_code, status.HTTP_200_OK)
-        self.assertEqual(response.data, {"status": "healthy"})
-
-    @patch('deep.views.current_app.control.ping')
-    def test_health_check_unhealthy(self, mock_ping):
-        mock_ping.return_value = []
-
-        response = self.client.get(reverse('celery_health_check'))
-        self.assertEqual(response.status_code, status.HTTP_503_SERVICE_UNAVAILABLE)
-        self.assertEqual(response.data, {"status": "unhealthy"})

deep/urls.py

@@ -174,7 +174,6 @@
     PasswordChanged,
     get_frontend_url,
     graphql_docs,
-    HealthCheckView,
 )
 from organization.views import (
     OrganizationViewSet,
@@ -620,6 +619,8 @@ def get_api_path(path):
             name="favicon"),
 
     re_path('ses-bounce/?$', ses_bounce_handler_view, name='ses_bounce'),
+    re_path(r'ht/', include('health_check.urls')),
+
 ] + [
     # graphql patterns
     re_path('^graphql/?$', csrf_exempt(CustomGraphQLView.as_view())),
@@ -648,7 +649,6 @@ def get_api_path(path):
         re_path(r'^ec-email/$', EntryCommentEmail.as_view()),
         re_path(r'^erc-email/$', EntryReviewCommentEmail.as_view()),
         re_path(r'^render-debug/$', RenderChart.as_view()),
-        re_path(r'celery-health/$', HealthCheckView.as_view(), name='celery_health_check'),
 
     ]
 

deep/views.py

@@ -6,7 +6,6 @@
     status,
     response,
 )
-from celery import current_app
 
 from django.core.exceptions import PermissionDenied as DjPermissionDenied
 from django.views.decorators.clickjacking import xframe_options_exempt
@@ -279,11 +278,3 @@ def format_error(error):
                 extensions['errorCode'] = str(status.HTTP_500_INTERNAL_SERVER_ERROR)
         formatted_error['extensions'] = extensions
         return formatted_error
-
-
-class HealthCheckView(views.APIView):
-    def get(self, request):
-        active_worker = current_app.control.ping()
-        if active_worker:
-            return response.Response({"status": "healthy"}, status=200)
-        return response.Response({"status": "unhealthy"}, status=503)

pyproject.toml

@@ -72,6 +72,7 @@ django-environ = "^0.8.1"
 uwsgi = "*"
 django-admin-autocomplete-filter = "^0.7.1"
 aws-sns-message-validator = "0.0.5 "
+django-health-check = "^3.18.3"
 
 # Thumbnail
 # Shapely = "==1.7.1"