Use http.Error instead of separately writing error code and message (#1564)

Author: Dan Laine

api/server/server.go

@@ -377,9 +377,7 @@ func lockMiddleware(
 func rejectMiddleware(handler http.Handler, ctx *snow.ConsensusContext) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // If chain isn't done bootstrapping, ignore API calls
 		if ctx.State.Get().State != snow.NormalOp {
-			w.WriteHeader(http.StatusServiceUnavailable)
-			// Doesn't matter if there's an error while writing. They'll get the StatusServiceUnavailable code.
-			_, _ = w.Write([]byte("API call rejected because chain is not done bootstrapping"))
+			http.Error(w, "API call rejected because chain is not done bootstrapping", http.StatusServiceUnavailable)
 		} else {
 			handler.ServeHTTP(w, r)
 		}

api/server/server_test.go

@@ -0,0 +1,72 @@
+// Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package server
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ava-labs/avalanchego/snow"
+)
+
+func TestRejectMiddleware(t *testing.T) {
+	type test struct {
+		name               string
+		handlerFunc        func(*require.Assertions) http.Handler
+		state              snow.State
+		expectedStatusCode int
+	}
+
+	tests := []test{
+		{
+			name: "chain is state syncing",
+			handlerFunc: func(require *require.Assertions) http.Handler {
+				return http.HandlerFunc(func(http.ResponseWriter, *http.Request) {
+					require.Fail("shouldn't have called handler")
+				})
+			},
+			state:              snow.StateSyncing,
+			expectedStatusCode: http.StatusServiceUnavailable,
+		},
+		{
+			name: "chain is bootstrapping",
+			handlerFunc: func(require *require.Assertions) http.Handler {
+				return http.HandlerFunc(func(http.ResponseWriter, *http.Request) {
+					require.Fail("shouldn't have called handler")
+				})
+			},
+			state:              snow.Bootstrapping,
+			expectedStatusCode: http.StatusServiceUnavailable,
+		},
+		{
+			name: "chain is done bootstrapping",
+			handlerFunc: func(*require.Assertions) http.Handler {
+				return http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+					w.WriteHeader(http.StatusTeapot)
+				})
+			},
+			state:              snow.NormalOp,
+			expectedStatusCode: http.StatusTeapot,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			require := require.New(t)
+
+			ctx := &snow.ConsensusContext{}
+			ctx.State.Set(snow.EngineState{
+				State: tt.state,
+			})
+
+			middleware := rejectMiddleware(tt.handlerFunc(require), ctx)
+			w := httptest.NewRecorder()
+			middleware.ServeHTTP(w, nil)
+			require.Equal(tt.expectedStatusCode, w.Code)
+		})
+	}
+}