feat: format healthcheck responses (#7723)

coadler · ammario · commit e9ef4755c1d8 · 2023-06-01T05:14:46.000Z
diff --git a/coderd/debug.go b/coderd/debug.go
@@ -37,7 +37,7 @@ func (api *API) debugDeploymentHealth(rw http.ResponseWriter, r *http.Request) {
 	// Get cached report if it exists.
 	if report := api.healthCheckCache.Load(); report != nil {
 		if time.Since(report.Time) < api.HealthcheckRefresh {
-			httpapi.Write(ctx, rw, http.StatusOK, report)
+			httpapi.WriteIndent(ctx, rw, http.StatusOK, report)
 			return
 		}
 	}
@@ -61,7 +61,7 @@ func (api *API) debugDeploymentHealth(rw http.ResponseWriter, r *http.Request) {
 		})
 		return
 	case res := <-resChan:
-		httpapi.Write(ctx, rw, http.StatusOK, res.Val)
+		httpapi.WriteIndent(ctx, rw, http.StatusOK, res.Val)
 		return
 	}
 }
diff --git a/coderd/httpapi/httpapi.go b/coderd/httpapi/httpapi.go
@@ -136,24 +136,40 @@ func RouteNotFound(rw http.ResponseWriter) {
 // marshaling, such as the number of elements in an array, which could help us
 // spot routes that need to be paginated.
 func Write(ctx context.Context, rw http.ResponseWriter, status int, response interface{}) {
+	// Pretty up JSON when testing.
+	if flag.Lookup("test.v") != nil {
+		WriteIndent(ctx, rw, status, response)
+		return
+	}
+
 	_, span := tracing.StartSpan(ctx)
 	defer span.End()
 
-	buf := &bytes.Buffer{}
-	enc := json.NewEncoder(buf)
+	rw.Header().Set("Content-Type", "application/json; charset=utf-8")
+	rw.WriteHeader(status)
+
+	enc := json.NewEncoder(rw)
 	enc.SetEscapeHTML(true)
-	// Pretty up JSON when testing.
-	if flag.Lookup("test.v") != nil {
-		enc.SetIndent("", "\t")
-	}
+
 	err := enc.Encode(response)
 	if err != nil {
 		http.Error(rw, err.Error(), http.StatusInternalServerError)
 		return
 	}
+}
+
+func WriteIndent(ctx context.Context, rw http.ResponseWriter, status int, response interface{}) {
+	_, span := tracing.StartSpan(ctx)
+	defer span.End()
+
 	rw.Header().Set("Content-Type", "application/json; charset=utf-8")
 	rw.WriteHeader(status)
-	_, err = rw.Write(buf.Bytes())
+
+	enc := json.NewEncoder(rw)
+	enc.SetEscapeHTML(true)
+	enc.SetIndent("", "\t")
+
+	err := enc.Encode(response)
 	if err != nil {
 		http.Error(rw, err.Error(), http.StatusInternalServerError)
 		return

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func (api API) debugDeploymentHealth(rw http.ResponseWriter, r http.Request) {`
`37`	`37`	`// Get cached report if it exists.`
`38`	`38`	`if report := api.healthCheckCache.Load(); report != nil {`
`39`	`39`	`if time.Since(report.Time) < api.HealthcheckRefresh {`
`40`		`- httpapi.Write(ctx, rw, http.StatusOK, report)`
	`40`	`+ httpapi.WriteIndent(ctx, rw, http.StatusOK, report)`
`41`	`41`	`return`
`42`	`42`	`}`
`43`	`43`	`}`
`@@ -61,7 +61,7 @@ func (api API) debugDeploymentHealth(rw http.ResponseWriter, r http.Request) {`
`61`	`61`	`})`
`62`	`62`	`return`
`63`	`63`	`case res := <-resChan:`
`64`		`- httpapi.Write(ctx, rw, http.StatusOK, res.Val)`
	`64`	`+ httpapi.WriteIndent(ctx, rw, http.StatusOK, res.Val)`
`65`	`65`	`return`
`66`	`66`	`}`
`67`	`67`	`}`