mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-19 21:31:37 +00:00
58e9b8c8f6
Here we add special handling for sending an error response when the write timeout of the HTTP server is just about to expire. This is surprisingly difficult to get right, since is must be ensured that all output is fully flushed in time, which needs support from multiple levels of the RPC handler stack: The timeout response can't use chunked transfer-encoding because there is no way to write the final terminating chunk. net/http writes it when the topmost handler returns, but the timeout will already be over by the time that happens. We decided to disable chunked encoding by setting content-length explicitly. Gzip compression must also be disabled for timeout responses because we don't know the true content-length before compressing all output, i.e. compression would reintroduce chunked transfer-encoding. Co-authored-by: Sina Mahmoodi <1591639+s1na@users.noreply.github.com>
63 lines
2.7 KiB
Go
63 lines
2.7 KiB
Go
// Copyright 2018 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package node
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/XinFinOrg/XDPoSChain/log"
|
|
"github.com/XinFinOrg/XDPoSChain/rpc"
|
|
)
|
|
|
|
// checkModuleAvailability checks that all names given in modules are actually
|
|
// available API services. It assumes that the MetadataApi module ("rpc") is always available;
|
|
// the registration of this "rpc" module happens in NewServer() and is thus common to all endpoints.
|
|
func checkModuleAvailability(modules []string, apis []rpc.API) (bad, available []string) {
|
|
availableSet := make(map[string]struct{})
|
|
for _, api := range apis {
|
|
if _, ok := availableSet[api.Namespace]; !ok {
|
|
availableSet[api.Namespace] = struct{}{}
|
|
available = append(available, api.Namespace)
|
|
}
|
|
}
|
|
for _, name := range modules {
|
|
if _, ok := availableSet[name]; !ok && name != rpc.MetadataApi {
|
|
bad = append(bad, name)
|
|
}
|
|
}
|
|
return bad, available
|
|
}
|
|
|
|
// CheckTimeouts ensures that timeout values are meaningful
|
|
func CheckTimeouts(timeouts *rpc.HTTPTimeouts) {
|
|
if timeouts.ReadTimeout < time.Second {
|
|
log.Warn("Sanitizing invalid HTTP read timeout", "provided", timeouts.ReadTimeout, "updated", rpc.DefaultHTTPTimeouts.ReadTimeout)
|
|
timeouts.ReadTimeout = rpc.DefaultHTTPTimeouts.ReadTimeout
|
|
}
|
|
if timeouts.ReadHeaderTimeout < time.Second {
|
|
log.Warn("Sanitizing invalid HTTP read header timeout", "provided", timeouts.ReadHeaderTimeout, "updated", rpc.DefaultHTTPTimeouts.ReadHeaderTimeout)
|
|
timeouts.ReadHeaderTimeout = rpc.DefaultHTTPTimeouts.ReadHeaderTimeout
|
|
}
|
|
if timeouts.WriteTimeout < time.Second {
|
|
log.Warn("Sanitizing invalid HTTP write timeout", "provided", timeouts.WriteTimeout, "updated", rpc.DefaultHTTPTimeouts.WriteTimeout)
|
|
timeouts.WriteTimeout = rpc.DefaultHTTPTimeouts.WriteTimeout
|
|
}
|
|
if timeouts.IdleTimeout < time.Second {
|
|
log.Warn("Sanitizing invalid HTTP idle timeout", "provided", timeouts.IdleTimeout, "updated", rpc.DefaultHTTPTimeouts.IdleTimeout)
|
|
timeouts.IdleTimeout = rpc.DefaultHTTPTimeouts.IdleTimeout
|
|
}
|
|
}
|