🎉 Add /readyz http endpoint for backend & exporter

backend/src/app/auth/oidc.clj

@@ -516,7 +516,7 @@
   [_ {:keys [executor session] :as cfg}]
   (let [cfg (update cfg :provider d/without-nils)]
     ["" {:middleware [[(:middleware session)]
-                      [hmw/with-promise-async executor]
+                      [hmw/with-dispatch executor]
                       [hmw/with-config cfg]
                       [provider-lookup]
                       ]}

backend/src/app/http.clj

@@ -10,7 +10,7 @@
    [app.common.logging :as l]
    [app.common.transit :as t]
    [app.http.errors :as errors]
-   [app.http.middleware :as middleware]
+   [app.http.middleware :as mw]
    [app.metrics :as mtx]
    [app.worker :as wrk]
    [clojure.spec.alpha :as s]
@@ -144,14 +144,16 @@
 (defmethod ig/init-key ::router
   [_ {:keys [ws session metrics assets feedback] :as cfg}]
   (rr/router
-   [["" {:middleware [[middleware/server-timing]
+   [["" {:middleware [[mw/server-timing]
-                      [middleware/format-response]
+                      [mw/format-response]
-                      [middleware/params]
+                      [mw/params]
-                      [middleware/parse-request]
+                      [mw/parse-request]
-                      [middleware/errors errors/handle]
+                      [mw/errors errors/handle]
-                      [middleware/restrict-methods]]}
+                      [mw/restrict-methods]]}
+
+     ["/metrics" {:handler (::mtx/handler metrics)
+                  :allowed-methods #{:get}}]
 
-     ["/metrics" {:handler (::mtx/handler metrics)}]
      ["/assets" {:middleware [(:middleware session)]}
       ["/by-id/:id" {:handler (:objects-handler assets)}]
       ["/by-file-media-id/:id" {:handler (:file-objects-handler assets)}]
@@ -167,7 +169,7 @@
                            :handler ws
                            :allowed-methods #{:get}}]
 
-     ["/api" {:middleware [[middleware/cors]
+     ["/api" {:middleware [[mw/cors]
                            [(:middleware session)]]}
       ["/audit/events" {:handler (:audit-handler cfg)
                         :allowed-methods #{:post}}]
@@ -176,4 +178,3 @@
       (:doc-routes cfg)
       (:oidc-routes cfg)
       (:rpc-routes cfg)]]]))
-

backend/src/app/http/debug.clj

@@ -378,9 +378,12 @@
 
 (defmethod ig/init-key ::routes
   [_ {:keys [session pool executor] :as cfg}]
+  [["/readyz" {:middleware [[mw/with-dispatch executor]
+                            [mw/with-config cfg]]
+               :handler health-handler}]
    ["/dbg" {:middleware [[(:middleware session)]
                          [with-authorization pool]
-                        [mw/with-promise-async executor]
+                         [mw/with-dispatch executor]
                          [mw/with-config cfg]]}
     ["" {:handler index-handler}]
     ["/health" {:handler health-handler}]
@@ -391,4 +394,4 @@
     ["/file/export" {:handler export-handler}]
     ["/file/import" {:handler import-handler}]
     ["/file/data" {:handler file-data-handler}]
-   ["/file/changes" {:handler file-changes-handler}]])
+    ["/file/changes" {:handler file-changes-handler}]]])

backend/src/app/http/middleware.clj

@@ -195,8 +195,9 @@
   {:name ::restrict-methods
    :compile compile-restrict-methods})
 
-(def with-promise-async
+(def with-dispatch
-  {:compile
+  {:name ::with-dispatch
+   :compile
    (fn [& _]
      (fn [handler executor]
        (fn [request respond raise]
@@ -206,7 +207,8 @@
              (p/catch raise)))))})
 
 (def with-config
-  {:compile
+  {:name ::with-config
+   :compile
    (fn [& _]
      (fn [handler config]
        (fn

backend/src/app/http/session.clj

@@ -236,7 +236,6 @@
                                                respond (cond-> respond
                                                          (renew-session? session)
                                                          (wrap-respond session))]
-
                                            (handler request respond raise))))))
 
                       (catch Throwable cause

exporter/src/app/http.cljs

@@ -124,6 +124,16 @@
     (let [token (.get ^js cookies cookie-name)]
       (handler (cond-> exchange token (assoc :request/auth-token token))))))
 
+(defn- wrap-health
+  "Add /healthz entry point intercept."
+  [handler]
+  (fn [{:keys [:request/path] :as exchange}]
+    (if (= path "/readyz")
+      (assoc exchange
+             :response/status 200
+             :response/body "OK")
+      (handler exchange))))
+
 (defn- create-adapter
   [handler]
   (fn [req res]
@@ -149,6 +159,7 @@
 (defn init
   []
   (let [handler (-> handlers/handler
+                    (wrap-health)
                     (wrap-auth "auth-token")
                     (wrap-response-format)
                     (wrap-params)