dockerflow: Add dockerflow module (bug 1873243)

Author: ahochheiden

pyproject.toml

@@ -18,18 +18,22 @@ dependencies = [
 ]
 name = "lando"
 requires-python = ">=3.10"
-version = "0.1.0"
+dynamic = ["version"]
 
 [project.scripts]
 lando = "lando.manage:main"
 
 [build-system]
 requires = [
-    "setuptools>=45",
+    "setuptools>=64",
+    "setuptools_scm>=8",
     "wheel",
 ]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools_scm]
+version_file = "src/lando/version.py"
+
 [tool.setuptools.packages.find]
 where = ["src"]
 

requirements.txt

@@ -13,3 +13,4 @@ celery
 datadog
 rs-parsepatch
 networkx
+setuptools-scm

src/lando/dockerflow/__init__.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DockerflowConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'lando.dockerflow'

src/lando/dockerflow/apps.py

@@ -0,0 +1,13 @@
+class DisableCachingMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        response = self.get_response(request)
+
+        if request.path.startswith("__"):
+            response['Cache-Control'] = 'no-cache, no-store, must-revalidate'
+            response['Pragma'] = 'no-cache'
+            response['Expires'] = '0'
+
+        return response

src/lando/dockerflow/middleware.py

@@ -0,0 +1,34 @@
+from django.views import View
+from django.http import JsonResponse
+
+from lando.version import version
+
+class VersionView(View):
+    def get(self, request):
+        data = {
+            "version": version,
+        }
+
+        return JsonResponse(data, status=200, json_dumps_params={'indent': 2})
+
+
+class HeartbeatView(View):
+    def get(self, request):
+        healthy = True
+
+        data = {
+            "healthy": healthy,
+            "services": {
+                "lando": healthy,
+            },
+        }
+
+        status = 200 if healthy else 502
+
+        return JsonResponse(data, status=status, json_dumps_params={'indent': 2})
+
+
+class LoadBalancerHeartbeatView(View):
+    def get(self, request):
+        # Since this is for load balancer checks it should not check backing services.
+        return JsonResponse({}, status=200, json_dumps_params={'indent': 2})

src/lando/dockerflow/views.py

@@ -39,6 +39,7 @@
     "mozilla_django_oidc",
     "lando.main",
     "lando.utils",
+    "lando.dockerflow",
 ]
 
 MIDDLEWARE = [
@@ -49,6 +50,7 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "lando.dockerflow.middleware.DisableCachingMiddleware"
 ]
 
 ROOT_URLCONF = "lando.urls"

src/lando/settings.py

@@ -18,9 +18,16 @@
 from django.urls import include, path
 
 from lando.ui.legacy import revisions
+from lando.dockerflow import views as DockerflowViews
 
 urlpatterns = [
     path("admin/", admin.site.urls),
     path("oidc/", include("mozilla_django_oidc.urls")),
     path("/D<int:revision_id>/", revisions.Revision.as_view()),
 ]
+
+urlpatterns += [
+    path("__version__", DockerflowViews.VersionView.as_view(), name="version"),
+    path("__heartbeat__", DockerflowViews.HeartbeatView.as_view(), name="heartbeat"),
+    path("__lbheartbeat__", DockerflowViews.LoadBalancerHeartbeatView.as_view(), name="lbheartbeat"),
+]