feat: ready check

This healthcheck tells if we had at least one valid build.

Author: kpetremann

internal/api/router/endpoints.go

@@ -16,11 +16,6 @@ const applicationJSON = "application/json"
 const hostnameKey = "hostname"
 const wildcard = "*"
 
-func healthCheck(w http.ResponseWriter, _ *http.Request) {
-	w.Header().Set(contentType, applicationJSON)
-	_, _ = fmt.Fprintf(w, `{"status": "ok"}`)
-}
-
 func getVersion(w http.ResponseWriter, _ *http.Request) {
 	w.Header().Set(contentType, applicationJSON)
 	_, _ = fmt.Fprintf(w, `{"version": "%s", "build_time": "%s", "build_user": "%s"}`, app.Info.Version, app.Info.BuildTime, app.Info.BuildUser)
@@ -32,6 +27,21 @@ func prometheusMetrics(h http.Handler) http.HandlerFunc {
 	}
 }
 
+func (m *Manager) healthCheck(w http.ResponseWriter, _ *http.Request) {
+	w.Header().Set(contentType, applicationJSON)
+	_, _ = fmt.Fprintf(w, `{"status": "ok"}`)
+}
+
+func (m *Manager) readyCheck(w http.ResponseWriter, _ *http.Request) {
+	w.Header().Set(contentType, applicationJSON)
+	if m.reports.HasValidBuild() {
+		_, _ = fmt.Fprintf(w, `{"status": "ok"}`)
+	} else {
+		w.WriteHeader(http.StatusServiceUnavailable)
+		_, _ = fmt.Fprintf(w, `{"status": "not ready"}`)
+	}
+}
+
 // getAFKEnabled endpoint returns all AFK enabled devices.
 // They are supposed to be managed by AFK, meaning the configuration should be applied periodically.
 func (m *Manager) getAFKEnabled(w http.ResponseWriter, r *http.Request) {

internal/api/router/manager.go

@@ -64,7 +64,8 @@ func (m *Manager) ListenAndServe(ctx context.Context, address string, port int,
 	// internal endpoints
 	mux.HandleFunc("GET /metrics", prometheusMetrics(promhttp.Handler()))
 	mux.HandleFunc("GET /api/version", getVersion)
-	mux.HandleFunc("GET /api/health", healthCheck)
+	mux.HandleFunc("GET /api/health", m.healthCheck)
+	mux.HandleFunc("GET /api/ready", m.readyCheck)
 
 	api.Get("/metrics").
 		HasResponseModel(http.StatusOK, rest.ModelOf[string]()).

internal/report/repository.go

@@ -42,6 +42,13 @@ func (r *Repository) GetLastSuccessfulJSON() ([]byte, error) {
 	return r.lastSuccessful.ToJSON()
 }
 
+func (r *Repository) HasValidBuild() bool {
+	r.mutex.Lock()
+	defer r.mutex.Unlock()
+
+	return r.lastSuccessful != nil
+}
+
 func (r *Repository) UpdateStatus(status jobStatus) {
 	r.mutex.Lock()
 	defer r.mutex.Unlock()