Merge pull request #7715 from bshramin/http-client-timeout

lntest: set ReadHeaderTimeout for http client
lightningnetwork · Oct 17, 2023 · 91d9108 · 91d9108
2 parents 82838e4 + 0c64a18
commit 91d9108
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 14 deletions.
diff --git a/config.go b/config.go
@@ -226,6 +226,9 @@ const (
 	// client should wait before sending a keepalive ping.
 	defaultGrpcClientPingMinWait = 5 * time.Second
 
+	// defaultHTTPHeaderTimeout is the default timeout for HTTP requests.
+	DefaultHTTPHeaderTimeout = 5 * time.Second
+
 	// BitcoinChainName is a string that represents the Bitcoin blockchain.
 	BitcoinChainName = "bitcoin"
 
@@ -492,6 +495,10 @@ type Config struct {
 	// Dev specifies configs used for integration tests, which is always
 	// empty if not built with `integration` flag.
 	Dev *lncfg.DevConfig `group:"dev" namespace:"dev"`
+
+	// HTTPHeaderTimeout is the maximum duration that the server will wait
+	// before timing out reading the headers of an HTTP request.
+	HTTPHeaderTimeout time.Duration `long:"http-header-timeout" description:"The maximum duration that the server will wait before timing out reading the headers of an HTTP request."`
 }
 
 // GRPCConfig holds the configuration options for the gRPC server.
@@ -694,7 +701,8 @@ func DefaultConfig() Config {
 			ServerPingTimeout: defaultGrpcServerPingTimeout,
 			ClientPingMinWait: defaultGrpcClientPingMinWait,
 		},
-		WtClient: lncfg.DefaultWtClientCfg(),
+		WtClient:          lncfg.DefaultWtClientCfg(),
+		HTTPHeaderTimeout: DefaultHTTPHeaderTimeout,
 	}
 }
 

diff --git a/docs/release-notes/release-notes-0.18.0.md b/docs/release-notes/release-notes-0.18.0.md
@@ -8,14 +8,16 @@
   - [Functional Updates](#functional-updates)
   - [RPC Updates](#rpc-updates)
   - [lncli Updates](#lncli-updates)
+  - [Code Health](#code-health)
   - [Breaking Changes](#breaking-changes)
   - [Performance Improvements](#performance-improvements)
- - [Technical and Architectural Updates](#technical-and-architectural-updates)
-   - [BOLT Spec Updates](#bolt-spec-updates)
-   - [Testing](#testing)
-   - [Database](#database)
-   - [Code Health](#code-health)
-   - [Tooling and Documentation](#tooling-and-documentation)
+- [Technical and Architectural Updates](#technical-and-architectural-updates)
+  - [BOLT Spec Updates](#bolt-spec-updates)
+  - [Testing](#testing)
+  - [Database](#database)
+  - [Code Health](#code-health-1)
+  - [Tooling and Documentation](#tooling-and-documentation)
+- [Contributors (Alphabetical Order)](#contributors-alphabetical-order)
 
 # Bug Fixes
 
@@ -40,6 +42,8 @@
   and payment to blinded paths has been added via the `QueryRoutes` (and 
   SendToRouteV2) APIs. This functionality is surfaced in `lncli queryroutes` 
   where the required flags are tagged with `(blinded paths)`.
+* A new config value,
+  [http-header-timeout](https://github.com/lightningnetwork/lnd/pull/7715), is added so users can specify the amount of time the http server will wait for a request to complete before closing the connection. The default value is 5 seconds.
 
 ## RPC Additions
 ## lncli Additions
@@ -83,6 +87,7 @@
 
 # Contributors (Alphabetical Order)
 
+* Amin Bashiri
 * Andras Banki-Horvath
 * Carla Kirk-Cohen
 * Elle Mouton

diff --git a/lnd.go b/lnd.go
@@ -214,7 +214,7 @@ func Main(cfg *Config, lisCfg ListenerCfg, implCfg *ImplementationCfg,
 		pprofServer := &http.Server{
 			Addr:              cfg.Profile,
 			Handler:           pprofMux,
-			ReadHeaderTimeout: 5 * time.Second,
+			ReadHeaderTimeout: cfg.HTTPHeaderTimeout,
 		}
 
 		// Shut the server down when lnd is shutting down.
@@ -271,6 +271,8 @@ func Main(cfg *Config, lisCfg ListenerCfg, implCfg *ImplementationCfg,
 		LetsEncryptListen: cfg.LetsEncryptListen,
 
 		DisableRestTLS: cfg.DisableRestTLS,
+
+		HTTPHeaderTimeout: cfg.HTTPHeaderTimeout,
 	}
 	tlsManager := NewTLSManager(tlsManagerCfg)
 	serverOpts, restDialOpts, restListen, cleanUp,

diff --git a/lntest/fee_service.go b/lntest/fee_service.go
@@ -9,6 +9,7 @@ import (
 	"sync"
 	"testing"
 
+	"github.com/lightningnetwork/lnd"
 	"github.com/lightningnetwork/lnd/lntest/node"
 	"github.com/lightningnetwork/lnd/lnwallet/chainfee"
 	"github.com/stretchr/testify/require"
@@ -81,8 +82,9 @@ func NewFeeService(t *testing.T) *FeeService {
 	mux.HandleFunc("/fee-estimates.json", f.handleRequest)
 
 	f.srv = &http.Server{
-		Addr:    listenAddr,
-		Handler: mux,
+		Addr:              listenAddr,
+		Handler:           mux,
+		ReadHeaderTimeout: lnd.DefaultHTTPHeaderTimeout,
 	}
 
 	return &f

diff --git a/sample-lnd.conf b/sample-lnd.conf
@@ -519,6 +519,9 @@
 ; intelligence services.
 ; color=#3399FF
 
+; The maximum duration that the server will wait before timing out reading
+; the headers of an HTTP request.
+; http-header-timeout=5s
 
 [prometheus]
 

diff --git a/tls_manager.go b/tls_manager.go
@@ -39,9 +39,6 @@ var (
 	// - `-----BEGIN PRIVATE KEY-----`    (PKCS8).
 	// - `-----BEGIN EC PRIVATE KEY-----` (SEC1/rfc5915, the legacy format).
 	privateKeyPrefix = []byte("-----BEGIN ")
-
-	// letsEncryptTimeout sets a timeout for the Lets Encrypt server.
-	letsEncryptTimeout = 5 * time.Second
 )
 
 // TLSManagerCfg houses a set of values and methods that is passed to the
@@ -61,6 +58,8 @@ type TLSManagerCfg struct {
 	LetsEncryptListen string
 
 	DisableRestTLS bool
+
+	HTTPHeaderTimeout time.Duration
 }
 
 // TLSManager generates/renews a TLS cert/key pair when needed. When required,
@@ -424,7 +423,7 @@ func (t *TLSManager) setUpLetsEncrypt(certData *tls.Certificate,
 	srv := &http.Server{
 		Addr:              t.cfg.LetsEncryptListen,
 		Handler:           manager.HTTPHandler(nil),
-		ReadHeaderTimeout: letsEncryptTimeout,
+		ReadHeaderTimeout: t.cfg.HTTPHeaderTimeout,
 	}
 	shutdownCompleted := make(chan struct{})
 	cleanUp = func() {