feat: manage health settings using Coder API (#10861)

coderd/debug.go

@@ -1,14 +1,24 @@
 package coderd
 
 import (
+	"bytes"
 	"context"
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"time"
 
+	"golang.org/x/exp/slices"
+	"golang.org/x/xerrors"
+
+	"github.com/google/uuid"
+
+	"github.com/coder/coder/v2/coderd/audit"
+	"github.com/coder/coder/v2/coderd/database"
 	"github.com/coder/coder/v2/coderd/healthcheck"
 	"github.com/coder/coder/v2/coderd/httpapi"
 	"github.com/coder/coder/v2/coderd/httpmw"
+	"github.com/coder/coder/v2/coderd/rbac"
 	"github.com/coder/coder/v2/codersdk"
 )
 
@@ -107,6 +117,131 @@ func formatHealthcheck(ctx context.Context, rw http.ResponseWriter, r *http.Requ
 	}
 }
 
+// @Summary Get health settings
+// @ID get-health-settings
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Debug
+// @Success 200 {object} codersdk.HealthSettings
+// @Router /debug/health/settings [get]
+func (api *API) deploymentHealthSettings(rw http.ResponseWriter, r *http.Request) {
+	settingsJSON, err := api.Database.GetHealthSettings(r.Context())
+	if err != nil {
+		httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to fetch health settings.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	var settings codersdk.HealthSettings
+	err = json.Unmarshal([]byte(settingsJSON), &settings)
+	if err != nil {
+		httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to unmarshal health settings.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	if len(settings.DismissedHealthchecks) == 0 {
+		settings.DismissedHealthchecks = []string{}
+	}
+
+	httpapi.Write(r.Context(), rw, http.StatusOK, settings)
+}
+
+// @Summary Update health settings
+// @ID update-health-settings
+// @Security CoderSessionToken
+// @Accept json
+// @Produce json
+// @Tags Debug
+// @Param request body codersdk.UpdateHealthSettings true "Update health settings"
+// @Success 200 {object} codersdk.UpdateHealthSettings
+// @Router /debug/health/settings [put]
+func (api *API) putDeploymentHealthSettings(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+
+	if !api.Authorize(r, rbac.ActionUpdate, rbac.ResourceDeploymentValues) {
+		httpapi.Write(ctx, rw, http.StatusForbidden, codersdk.Response{
+			Message: "Insufficient permissions to update health settings.",
+		})
+		return
+	}
+
+	var settings codersdk.HealthSettings
+	if !httpapi.Read(ctx, rw, r, &settings) {
+		return
+	}
+
+	err := validateHealthSettings(settings)
+	if err != nil {
+		httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to validate health settings.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	settingsJSON, err := json.Marshal(&settings)
+	if err != nil {
+		httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to marshal health settings.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	currentSettingsJSON, err := api.Database.GetHealthSettings(r.Context())
+	if err != nil {
+		httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to fetch current health settings.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	if bytes.Equal(settingsJSON, []byte(currentSettingsJSON)) {
+		httpapi.Write(r.Context(), rw, http.StatusNotModified, nil)
+		return
+	}
+
+	auditor := api.Auditor.Load()
+	aReq, commitAudit := audit.InitRequest[database.HealthSettings](rw, &audit.RequestParams{
+		Audit:   *auditor,
+		Log:     api.Logger,
+		Request: r,
+		Action:  database.AuditActionWrite,
+	})
+	defer commitAudit()
+	aReq.New = database.HealthSettings{
+		ID:                    uuid.New(),
+		DismissedHealthchecks: settings.DismissedHealthchecks,
+	}
+
+	err = api.Database.UpsertHealthSettings(ctx, string(settingsJSON))
+	if err != nil {
+		httpapi.Write(r.Context(), rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to update health settings.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(r.Context(), rw, http.StatusOK, settings)
+}
+
+func validateHealthSettings(settings codersdk.HealthSettings) error {
+	for _, dismissed := range settings.DismissedHealthchecks {
+		ok := slices.Contains(healthcheck.Sections, dismissed)
+		if !ok {
+			return xerrors.Errorf("unknown healthcheck section: %s", dismissed)
+		}
+	}
+	return nil
+}
+
 // For some reason the swagger docs need to be attached to a function.
 //
 // @Summary Debug Info Websocket Test