add a healthcheck endpoint

Author: jo-0

compose.override.LOCAL_COPY.yml

@@ -24,7 +24,7 @@ services:
       - 8010:8010
     command: ["python", "manage.py", "run", "-h", "0.0.0.0", "-p", "8010"]
     healthcheck:
-      test: ["CMD-SHELL", "curl --fail http://0.0.0.0:8010 || exit 1"]
+      test: ["CMD-SHELL", "curl --fail http://0.0.0.0:8010/healthcheck || exit 1"]
       interval: 1m30s
       start_period: 15s
       retries: 3

services/backend/project/__init__.py

@@ -1,9 +1,24 @@
 from flask import Flask, jsonify
+# from flask.views import View
 
 
 app = Flask(__name__)
 
 
-@app.route("/generate/")
+@app.route("/api/")
 def hello_world():
-    return jsonify(hi="Sopi")
+    return jsonify(hello="World")
+
+
+# class Health(View):
+#     def get(self):
+#         data = {"success": True, "message": "healthy"}
+#         return jsonify(**data, status=200, mimetype='application/json')
+
+# app.add_url_rule("/healthcheck", view_func=Health.as_view("health_check"))
+
+
+@app.route("/healthcheck", strict_slashes=False)
+def health_check():
+    data = {"success": True, "message": "healthy"}
+    return jsonify(**data, status=200, mimetype='application/json')

services/nginx/dev/nginx.conf

@@ -20,12 +20,21 @@ http {
         listen 80;
         client_max_body_size 500M;
 
-        location ~ ^/generate/(.*)$ {
+        location ~ ^/api/(.*)$ {
             # If we set the upstream host as a variable here it causes nginx to NOT crash during bootup.
             # This allows us to start nginx without needing all the upstream services started (we only need to start what we want)
             set $upstream http://backend:8010;
             # $1 is the path from regex and $is_args$args are the query params which we pass to the upstream.
-            proxy_pass          $upstream/generate/$1$is_args$args;
+            proxy_pass          $upstream/api/$1$is_args$args;
+            proxy_redirect      off;
+        }
+
+        location ~ ^/healthcheck {
+            # If we set the upstream host as a variable here it causes nginx to NOT crash during bootup.
+            # This allows us to start nginx without needing all the upstream services started (we only need to start what we want)
+            set $upstream http://backend:8010;
+            # $1 is the path from regex and $is_args$args are the query params which we pass to the upstream.
+            proxy_pass          $upstream/healthcheck/$1$is_args$args;
             proxy_redirect      off;
         }