use model struct for base health summary

mtojek · mtojek · commit e1978f22c240 · 2023-11-21T15:16:29.000+01:00
diff --git a/coderd/healthcheck/accessurl.go b/coderd/healthcheck/accessurl.go
@@ -9,14 +9,13 @@ import (
 
 	"golang.org/x/xerrors"
 
+	"github.com/coder/coder/v2/coderd/healthcheck/model"
 	"github.com/coder/coder/v2/coderd/util/ptr"
 )
 
 // @typescript-generate AccessURLReport
 type AccessURLReport struct {
-	Healthy  bool     `json:"healthy"`
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
-	Warnings []string `json:"warnings"`
+	model.HealthSummary
 
 	AccessURL       string  `json:"access_url"`
 	Reachable       bool    `json:"reachable"`
diff --git a/coderd/healthcheck/database.go b/coderd/healthcheck/database.go
@@ -8,6 +8,7 @@ import (
 	"golang.org/x/xerrors"
 
 	"github.com/coder/coder/v2/coderd/database"
+	"github.com/coder/coder/v2/coderd/healthcheck/model"
 )
 
 const (
@@ -16,9 +17,7 @@ const (
 
 // @typescript-generate DatabaseReport
 type DatabaseReport struct {
-	Healthy  bool     `json:"healthy"`
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
-	Warnings []string `json:"warnings"`
+	model.HealthSummary
 
 	Reachable   bool    `json:"reachable"`
 	Latency     string  `json:"latency"`
diff --git a/coderd/healthcheck/derphealth/derp.go b/coderd/healthcheck/derphealth/derp.go
@@ -21,6 +21,7 @@ import (
 	"tailscale.com/types/key"
 	tslogger "tailscale.com/types/logger"
 
+	"github.com/coder/coder/v2/coderd/healthcheck/model"
 	"github.com/coder/coder/v2/coderd/util/ptr"
 )
 
@@ -29,20 +30,9 @@ const (
 	oneNodeUnhealthy         = "Region is operational, but performance might be degraded as one node is unhealthy."
 )
 
-const (
-	SeverityOK      Severity = "ok"
-	SeverityWarning Severity = "warning"
-	SeverityError   Severity = "error"
-)
-
-// @typescript-generate Severity
-type Severity string
-
 // @typescript-generate Report
 type Report struct {
-	Healthy  bool     `json:"healthy"`
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
-	Warnings []string `json:"warnings"`
+	model.HealthSummary
 
 	Regions map[int]*RegionReport `json:"regions"`
 
@@ -57,9 +47,7 @@ type Report struct {
 type RegionReport struct {
 	mu sync.Mutex
 
-	Healthy  bool     `json:"healthy"`
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
-	Warnings []string `json:"warnings"`
+	model.HealthSummary
 
 	Region      *tailcfg.DERPRegion `json:"region"`
 	NodeReports []*NodeReport       `json:"node_reports"`
@@ -71,9 +59,7 @@ type NodeReport struct {
 	mu            sync.Mutex
 	clientCounter int
 
-	Healthy  bool     `json:"healthy"`
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
-	Warnings []string `json:"warnings"`
+	model.HealthSummary
 
 	Node *tailcfg.DERPNode `json:"node"`
 
@@ -167,8 +153,10 @@ func (r *RegionReport) Run(ctx context.Context) {
 		var (
 			node       = node
 			nodeReport = NodeReport{
-				Node:    node,
-				Healthy: true,
+				Node: node,
+				HealthSummary: model.HealthSummary{
+					Healthy: true,
+				},
 			}
 		)
 
diff --git a/coderd/healthcheck/derphealth/doc.go b/coderd/healthcheck/derphealth/doc.go
@@ -0,0 +1,5 @@
+package derphealth
+
+// DERP healthcheck is kept in a separate package as it is used by `cli/netcheck.go`,
+// which is part of the slim binary. Slim binary can't have dependency on `database`,
+// which is used by the database healthcheck.
diff --git a/coderd/healthcheck/healthcheck.go b/coderd/healthcheck/healthcheck.go
@@ -8,6 +8,7 @@ import (
 
 	"github.com/coder/coder/v2/buildinfo"
 	"github.com/coder/coder/v2/coderd/healthcheck/derphealth"
+	"github.com/coder/coder/v2/coderd/healthcheck/model"
 	"github.com/coder/coder/v2/coderd/util/ptr"
 )
 
@@ -18,14 +19,6 @@ const (
 	SectionDatabase  string = "Database"
 )
 
-const (
-	SeverityOK      Severity = "ok"
-	SeverityWarning Severity = "warning"
-	SeverityError   Severity = "error"
-)
-
-type Severity string
-
 type Checker interface {
 	DERP(ctx context.Context, opts *derphealth.ReportOptions) derphealth.Report
 	AccessURL(ctx context.Context, opts *AccessURLReportOptions) AccessURLReport
@@ -40,7 +33,7 @@ type Report struct {
 	// Healthy is true if the report returns no errors.
 	Healthy bool `json:"healthy"`
 	// Severity indicates the status of Coder health.
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
+	Severity model.Severity `json:"severity" enums:"ok,warning,error"`
 	// FailingSections is a list of sections that have failed their healthcheck.
 	FailingSections []string `json:"failing_sections"`
 
diff --git a/coderd/healthcheck/model/base.go b/coderd/healthcheck/model/base.go
@@ -0,0 +1,16 @@
+package model
+
+const (
+	SeverityOK      Severity = "ok"
+	SeverityWarning Severity = "warning"
+	SeverityError   Severity = "error"
+)
+
+// @typescript-generate Severity
+type Severity string
+
+type HealthSummary struct {
+	Healthy  bool     `json:"healthy"`
+	Severity Severity `json:"severity" enums:"ok,warning,error"`
+	Warnings []string `json:"warnings"`
+}
diff --git a/coderd/healthcheck/websocket.go b/coderd/healthcheck/websocket.go
@@ -11,6 +11,8 @@ import (
 
 	"golang.org/x/xerrors"
 	"nhooyr.io/websocket"
+
+	"github.com/coder/coder/v2/coderd/healthcheck/model"
 )
 
 type WebsocketReportOptions struct {
@@ -21,9 +23,7 @@ type WebsocketReportOptions struct {
 
 // @typescript-generate WebsocketReport
 type WebsocketReport struct {
-	Healthy  bool     `json:"healthy"`
-	Severity Severity `json:"severity" enums:"ok,warning,error"`
-	Warnings []string `json:"warnings"`
+	model.HealthSummary
 
 	Body  string  `json:"body"`
 	Code  int     `json:"code"`
