chore(lint): upgrade golangci-lint to v1.47.2
- Fix Slowloris attacks on HTTP servers - Force set default of 5 minutes for pprof read timeout - Change `ShutdownTimeout` to time.Duration since it cannot be set to 0
This commit is contained in:
@@ -22,23 +22,34 @@ type Settings struct {
|
||||
// Logger is the logger to use.
|
||||
// It must be set and cannot be left to nil.
|
||||
Logger Logger
|
||||
// ReadHeaderTimeout is the HTTP header read timeout duration
|
||||
// of the HTTP server. It defaults to 3 seconds if left unset.
|
||||
ReadHeaderTimeout time.Duration
|
||||
// ReadTimeout is the HTTP read timeout duration
|
||||
// of the HTTP server. It defaults to 3 seconds if left unset.
|
||||
ReadTimeout time.Duration
|
||||
// ShutdownTimeout is the shutdown timeout duration
|
||||
// of the HTTP server. It defaults to 3 seconds.
|
||||
ShutdownTimeout *time.Duration
|
||||
// of the HTTP server. It defaults to 3 seconds if left unset.
|
||||
ShutdownTimeout time.Duration
|
||||
}
|
||||
|
||||
func (s *Settings) SetDefaults() {
|
||||
s.Address = helpers.DefaultString(s.Address, ":8000")
|
||||
const defaultReadTimeout = 3 * time.Second
|
||||
s.ReadHeaderTimeout = helpers.DefaultDuration(s.ReadHeaderTimeout, defaultReadTimeout)
|
||||
s.ReadTimeout = helpers.DefaultDuration(s.ReadTimeout, defaultReadTimeout)
|
||||
const defaultShutdownTimeout = 3 * time.Second
|
||||
s.ShutdownTimeout = helpers.DefaultDuration(s.ShutdownTimeout, defaultShutdownTimeout)
|
||||
}
|
||||
|
||||
func (s Settings) Copy() Settings {
|
||||
return Settings{
|
||||
Address: s.Address,
|
||||
Handler: s.Handler,
|
||||
Logger: s.Logger,
|
||||
ShutdownTimeout: helpers.CopyDurationPtr(s.ShutdownTimeout),
|
||||
Address: s.Address,
|
||||
Handler: s.Handler,
|
||||
Logger: s.Logger,
|
||||
ReadHeaderTimeout: s.ReadHeaderTimeout,
|
||||
ReadTimeout: s.ReadTimeout,
|
||||
ShutdownTimeout: s.ShutdownTimeout,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -48,6 +59,8 @@ func (s *Settings) MergeWith(other Settings) {
|
||||
if s.Logger == nil {
|
||||
s.Logger = other.Logger
|
||||
}
|
||||
s.ReadHeaderTimeout = helpers.MergeWithDuration(s.ReadHeaderTimeout, other.ReadHeaderTimeout)
|
||||
s.ReadTimeout = helpers.MergeWithDuration(s.ReadTimeout, other.ReadTimeout)
|
||||
s.ShutdownTimeout = helpers.MergeWithDuration(s.ShutdownTimeout, other.ShutdownTimeout)
|
||||
}
|
||||
|
||||
@@ -57,13 +70,17 @@ func (s *Settings) OverrideWith(other Settings) {
|
||||
if other.Logger != nil {
|
||||
s.Logger = other.Logger
|
||||
}
|
||||
s.ReadHeaderTimeout = helpers.OverrideWithDuration(s.ReadHeaderTimeout, other.ReadHeaderTimeout)
|
||||
s.ReadTimeout = helpers.OverrideWithDuration(s.ReadTimeout, other.ReadTimeout)
|
||||
s.ShutdownTimeout = helpers.OverrideWithDuration(s.ShutdownTimeout, other.ShutdownTimeout)
|
||||
}
|
||||
|
||||
var (
|
||||
ErrHandlerIsNotSet = errors.New("HTTP handler cannot be left unset")
|
||||
ErrLoggerIsNotSet = errors.New("logger cannot be left unset")
|
||||
ErrShutdownTimeoutTooSmall = errors.New("shutdown timeout is too small")
|
||||
ErrHandlerIsNotSet = errors.New("HTTP handler cannot be left unset")
|
||||
ErrLoggerIsNotSet = errors.New("logger cannot be left unset")
|
||||
ErrReadHeaderTimeoutTooSmall = errors.New("read header timeout is too small")
|
||||
ErrReadTimeoutTooSmall = errors.New("read timeout is too small")
|
||||
ErrShutdownTimeoutTooSmall = errors.New("shutdown timeout is too small")
|
||||
)
|
||||
|
||||
func (s Settings) Validate() (err error) {
|
||||
@@ -81,11 +98,24 @@ func (s Settings) Validate() (err error) {
|
||||
return ErrLoggerIsNotSet
|
||||
}
|
||||
|
||||
const minReadTimeout = time.Millisecond
|
||||
if s.ReadHeaderTimeout < minReadTimeout {
|
||||
return fmt.Errorf("%w: %s must be at least %s",
|
||||
ErrReadHeaderTimeoutTooSmall,
|
||||
s.ReadHeaderTimeout, minReadTimeout)
|
||||
}
|
||||
|
||||
if s.ReadTimeout < minReadTimeout {
|
||||
return fmt.Errorf("%w: %s must be at least %s",
|
||||
ErrReadTimeoutTooSmall,
|
||||
s.ReadTimeout, minReadTimeout)
|
||||
}
|
||||
|
||||
const minShutdownTimeout = 5 * time.Millisecond
|
||||
if *s.ShutdownTimeout < minShutdownTimeout {
|
||||
if s.ShutdownTimeout < minShutdownTimeout {
|
||||
return fmt.Errorf("%w: %s must be at least %s",
|
||||
ErrShutdownTimeoutTooSmall,
|
||||
*s.ShutdownTimeout, minShutdownTimeout)
|
||||
s.ShutdownTimeout, minShutdownTimeout)
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -94,7 +124,9 @@ func (s Settings) Validate() (err error) {
|
||||
func (s Settings) ToLinesNode() (node *gotree.Node) {
|
||||
node = gotree.New("HTTP server settings:")
|
||||
node.Appendf("Listening address: %s", s.Address)
|
||||
node.Appendf("Shutdown timeout: %s", *s.ShutdownTimeout)
|
||||
node.Appendf("Read header timeout: %s", s.ReadHeaderTimeout)
|
||||
node.Appendf("Read timeout: %s", s.ReadTimeout)
|
||||
node.Appendf("Shutdown timeout: %s", s.ShutdownTimeout)
|
||||
return node
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user