Merge pull request #7948 from readthedocs/proxito-health-check

Add proxito healthcheck

Author: ericholscher

readthedocs/core/views/__init__.py

@@ -10,7 +10,7 @@
 from django.conf import settings
 from django.http import Http404, JsonResponse
 from django.shortcuts import render, get_object_or_404, redirect
-from django.views.generic import TemplateView
+from django.views.generic import View, TemplateView
 
 from readthedocs.builds.models import Version
 from readthedocs.core.utils.general import wipe_version_via_slugs
@@ -23,6 +23,11 @@ class NoProjectException(Exception):
     pass
 
 
+class HealthCheckView(View):
+    def get(self, request, *args, **kwargs):
+        return JsonResponse({'status': 200}, status=200)
+
+
 class HomepageView(TemplateView):
 
     template_name = 'homepage.html'

readthedocs/proxito/middleware.py

@@ -11,6 +11,7 @@
 from django.conf import settings
 from django.shortcuts import render
 from django.utils.deprecation import MiddlewareMixin
+from django.urls import reverse
 
 from readthedocs.projects.models import Domain, Project
 
@@ -157,8 +158,12 @@ def add_proxito_headers(self, request, response):
             response['X-RTD-Version-Method'] = 'path'
 
     def process_request(self, request):  # noqa
-        if any([not settings.USE_SUBDOMAIN, 'localhost' in request.get_host(),
-                'testserver' in request.get_host()]):
+        if any([
+            not settings.USE_SUBDOMAIN,
+            'localhost' in request.get_host(),
+            'testserver' in request.get_host(),
+            request.path.startswith(reverse('health_check')),
+        ]):
             log.debug('Not processing Proxito middleware')
             return None
 

readthedocs/proxito/tests/test_full.py

@@ -35,6 +35,20 @@
 class TestFullDocServing(BaseDocServing):
     # Test the full range of possible doc URL's
 
+    def test_health_check(self):
+        url = reverse('health_check')
+        host = 'project.dev.readthedocs.io'
+        resp = self.client.get(url, HTTP_HOST=host)
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.json(), {'status': 200})
+
+        # Test with IP address, which should still work
+        # since we're skipping middleware
+        host = '127.0.0.1'
+        resp = self.client.get(url, HTTP_HOST=host)
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.json(), {'status': 200})
+
     def test_subproject_serving(self):
         url = '/projects/subproject/en/latest/awesome.html'
         host = 'project.dev.readthedocs.io'

readthedocs/proxito/urls.py

@@ -38,6 +38,7 @@
 from django.views import defaults
 
 from readthedocs.constants import pattern_opts
+from readthedocs.core.views import HealthCheckView
 from readthedocs.projects.views.public import ProjectDownloadMedia
 from readthedocs.proxito.views.serve import (
     ServeDocs,
@@ -50,6 +51,13 @@
 
 DOC_PATH_PREFIX = getattr(settings, 'DOC_PATH_PREFIX', '')
 
+health_check_urls = [
+    url('^{DOC_PATH_PREFIX}health_check/$'.format(DOC_PATH_PREFIX=DOC_PATH_PREFIX),
+        HealthCheckView.as_view(),
+        name='health_check',
+        ),
+]
+
 proxied_urls = [
     # Serve project downloads
     # /_/downloads/<lang>/<ver>/<type>/
@@ -163,7 +171,7 @@
     ),
 ]
 
-urlpatterns = proxied_urls + core_urls + docs_urls
+urlpatterns = health_check_urls + proxied_urls + core_urls + docs_urls
 
 # Use Django default error handlers to make things simpler
 handler404 = proxito_404_page_handler