Add HTTP timeouts (ava-labs#2705)

Co-authored-by: Joshua Kim <[email protected]>

api/server/server.go

@@ -33,10 +33,7 @@ import (
 	"github.com/ava-labs/avalanchego/utils/logging"
 )
 
-const (
-	baseURL           = "/ext"
-	readHeaderTimeout = 10 * time.Second
-)
+const baseURL = "/ext"
 
 var (
 	errUnknownLockOption = errors.New("invalid lock options")
@@ -79,6 +76,13 @@ type Server interface {
 	Shutdown() error
 }
 
+type HTTPConfig struct {
+	ReadTimeout       time.Duration `json:"readTimeout"`
+	ReadHeaderTimeout time.Duration `json:"readHeaderTimeout"`
+	WriteTimeout      time.Duration `json:"writeHeaderTimeout"`
+	IdleTimeout       time.Duration `json:"idleTimeout"`
+}
+
 type server struct {
 	// log this server writes to
 	log logging.Logger
@@ -114,6 +118,7 @@ func New(
 	tracer trace.Tracer,
 	namespace string,
 	registerer prometheus.Registerer,
+	httpConfig HTTPConfig,
 	wrappers ...Wrapper,
 ) (Server, error) {
 	m, err := newMetrics(namespace, registerer)
@@ -155,7 +160,10 @@ func New(
 		router:          router,
 		srv: &http.Server{
 			Handler:           handler,
-			ReadHeaderTimeout: readHeaderTimeout,
+			ReadTimeout:       httpConfig.ReadTimeout,
+			ReadHeaderTimeout: httpConfig.ReadHeaderTimeout,
+			WriteTimeout:      httpConfig.WriteTimeout,
+			IdleTimeout:       httpConfig.IdleTimeout,
 		},
 	}, nil
 }

config/config.go

@@ -19,6 +19,7 @@ import (
 
 	"github.com/spf13/viper"
 
+	"github.com/ava-labs/avalanchego/api/server"
 	"github.com/ava-labs/avalanchego/chains"
 	"github.com/ava-labs/avalanchego/genesis"
 	"github.com/ava-labs/avalanchego/ids"
@@ -200,6 +201,12 @@ func getHTTPConfig(v *viper.Viper) (node.HTTPConfig, error) {
 	}
 
 	config := node.HTTPConfig{
+		HTTPConfig: server.HTTPConfig{
+			ReadTimeout:       v.GetDuration(HTTPReadTimeoutKey),
+			ReadHeaderTimeout: v.GetDuration(HTTPReadHeaderTimeoutKey),
+			WriteTimeout:      v.GetDuration(HTTPWriteTimeoutKey),
+			IdleTimeout:       v.GetDuration(HTTPIdleTimeoutKey),
+		},
 		APIConfig: node.APIConfig{
 			APIIndexerConfig: node.APIIndexerConfig{
 				IndexAPIEnabled:      v.GetBool(IndexEnabledKey),
@@ -217,9 +224,8 @@ func getHTTPConfig(v *viper.Viper) (node.HTTPConfig, error) {
 		HTTPSKey:          httpsKey,
 		HTTPSCert:         httpsCert,
 		APIAllowedOrigins: v.GetStringSlice(HTTPAllowedOrigins),
-
-		ShutdownTimeout: v.GetDuration(HTTPShutdownTimeoutKey),
-		ShutdownWait:    v.GetDuration(HTTPShutdownWaitKey),
+		ShutdownTimeout:   v.GetDuration(HTTPShutdownTimeoutKey),
+		ShutdownWait:      v.GetDuration(HTTPShutdownWaitKey),
 	}
 
 	config.APIAuthConfig, err = getAPIAuthConfig(v)

config/flags.go

@@ -203,6 +203,10 @@ func addNodeFlags(fs *flag.FlagSet) {
 	fs.String(HTTPAllowedOrigins, "*", "Origins to allow on the HTTP port. Defaults to * which allows all origins. Example: https://*.avax.network https://*.avax-test.network")
 	fs.Duration(HTTPShutdownWaitKey, 0, "Duration to wait after receiving SIGTERM or SIGINT before initiating shutdown. The /health endpoint will return unhealthy during this duration")
 	fs.Duration(HTTPShutdownTimeoutKey, 10*time.Second, "Maximum duration to wait for existing connections to complete during node shutdown")
+	fs.Duration(HTTPReadTimeoutKey, 30*time.Second, "Maximum duration for reading the entire request, including the body. A zero or negative value means there will be no timeout")
+	fs.Duration(HTTPReadHeaderTimeoutKey, 30*time.Second, fmt.Sprintf("Maximum duration to read request headers. The connection's read deadline is reset after reading the headers. If %s is zero, the value of %s is used. If both are zero, there is no timeout.", HTTPReadHeaderTimeoutKey, HTTPReadTimeoutKey))
+	fs.Duration(HTTPWriteTimeoutKey, 30*time.Second, "Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read. A zero or negative value means there will be no timeout.")
+	fs.Duration(HTTPIdleTimeoutKey, 120*time.Second, fmt.Sprintf("Maximum duration to wait for the next request when keep-alives are enabled. If %s is zero, the value of %s is used. If both are zero, there is no timeout.", HTTPIdleTimeoutKey, HTTPReadTimeoutKey))
 	fs.Bool(APIAuthRequiredKey, false, "Require authorization token to call HTTP APIs")
 	fs.String(APIAuthPasswordFileKey, "",
 		fmt.Sprintf("Password file used to initially create/validate API authorization tokens. Ignored if %s is specified. Leading and trailing whitespace is removed from the password. Can be changed via API call",

config/keys.go

@@ -54,6 +54,10 @@ const (
 	HTTPAllowedOrigins                                 = "http-allowed-origins"
 	HTTPShutdownTimeoutKey                             = "http-shutdown-timeout"
 	HTTPShutdownWaitKey                                = "http-shutdown-wait"
+	HTTPReadTimeoutKey                                 = "http-read-timeout"
+	HTTPReadHeaderTimeoutKey                           = "http-read-header-timeout"
+	HTTPWriteTimeoutKey                                = "http-write-timeout"
+	HTTPIdleTimeoutKey                                 = "http-idle-timeout"
 	APIAuthRequiredKey                                 = "api-auth-required"
 	APIAuthPasswordKey                                 = "api-auth-password"
 	APIAuthPasswordFileKey                             = "api-auth-password-file"

node/config.go

@@ -7,6 +7,7 @@ import (
 	"crypto/tls"
 	"time"
 
+	"github.com/ava-labs/avalanchego/api/server"
 	"github.com/ava-labs/avalanchego/chains"
 	"github.com/ava-labs/avalanchego/genesis"
 	"github.com/ava-labs/avalanchego/ids"
@@ -43,6 +44,7 @@ type APIIndexerConfig struct {
 }
 
 type HTTPConfig struct {
+	server.HTTPConfig
 	APIConfig `json:"apiConfig"`
 	HTTPHost  string `json:"httpHost"`
 	HTTPPort  uint16 `json:"httpPort"`

node/node.go

@@ -595,6 +595,7 @@ func (n *Node) initAPIServer() error {
 			n.tracer,
 			"api",
 			n.MetricsRegisterer,
+			n.Config.HTTPConfig.HTTPConfig,
 		)
 		return err
 	}
@@ -616,6 +617,7 @@ func (n *Node) initAPIServer() error {
 		n.tracer,
 		"api",
 		n.MetricsRegisterer,
+		n.Config.HTTPConfig.HTTPConfig,
 		a,
 	)
 	if err != nil {