32a9170428
All checks were successful
check / check (push) Successful in 1m37s
Refactor Dockerfile to use a separate lint stage with a pinned golangci-lint v2.11.3 Docker image instead of installing golangci-lint via curl in the builder stage. This follows the pattern used by sneak/pixa. Changes: - Dockerfile: separate lint stage using golangci/golangci-lint:v2.11.3 (Debian-based, pinned by sha256) with COPY --from=lint dependency - Bump Go from 1.24 to 1.26.1 (golang:1.26.1-bookworm, pinned) - Bump golangci-lint from v1.64.8 to v2.11.3 - Migrate .golangci.yml from v1 to v2 format (same linters, format only) - All Docker images pinned by sha256 digest - Fix all lint issues from the v2 linter upgrade: - Add package comments to all packages - Add doc comments to all exported types, functions, and methods - Fix unchecked errors (errcheck) - Fix unused parameters (revive) - Fix gosec warnings (MaxBytesReader for form parsing) - Fix staticcheck suggestions (fmt.Fprintf instead of WriteString) - Rename DeliveryTask to Task to avoid stutter (delivery.Task) - Rename shadowed builtin 'max' parameter - Update README.md version requirements
153 lines
3.0 KiB
Go
153 lines
3.0 KiB
Go
package delivery
|
|
|
|
import (
|
|
"sync"
|
|
"time"
|
|
)
|
|
|
|
// CircuitState represents the current state of a circuit
|
|
// breaker.
|
|
type CircuitState int
|
|
|
|
const (
|
|
// CircuitClosed is the normal operating state.
|
|
CircuitClosed CircuitState = iota
|
|
// CircuitOpen means the circuit has tripped.
|
|
CircuitOpen
|
|
// CircuitHalfOpen allows a single probe delivery to
|
|
// test whether the target has recovered.
|
|
CircuitHalfOpen
|
|
)
|
|
|
|
const (
|
|
// defaultFailureThreshold is the number of consecutive
|
|
// failures before a circuit breaker trips open.
|
|
defaultFailureThreshold = 5
|
|
|
|
// defaultCooldown is how long a circuit stays open
|
|
// before transitioning to half-open.
|
|
defaultCooldown = 30 * time.Second
|
|
)
|
|
|
|
// CircuitBreaker implements the circuit breaker pattern
|
|
// for a single delivery target.
|
|
type CircuitBreaker struct {
|
|
mu sync.Mutex
|
|
state CircuitState
|
|
failures int
|
|
threshold int
|
|
cooldown time.Duration
|
|
lastFailure time.Time
|
|
}
|
|
|
|
// NewCircuitBreaker creates a circuit breaker with default
|
|
// settings.
|
|
func NewCircuitBreaker() *CircuitBreaker {
|
|
return &CircuitBreaker{
|
|
state: CircuitClosed,
|
|
threshold: defaultFailureThreshold,
|
|
cooldown: defaultCooldown,
|
|
}
|
|
}
|
|
|
|
// Allow checks whether a delivery attempt should proceed.
|
|
func (cb *CircuitBreaker) Allow() bool {
|
|
cb.mu.Lock()
|
|
defer cb.mu.Unlock()
|
|
|
|
switch cb.state {
|
|
case CircuitClosed:
|
|
return true
|
|
|
|
case CircuitOpen:
|
|
if time.Since(cb.lastFailure) >= cb.cooldown {
|
|
cb.state = CircuitHalfOpen
|
|
|
|
return true
|
|
}
|
|
|
|
return false
|
|
|
|
case CircuitHalfOpen:
|
|
return false
|
|
|
|
default:
|
|
return true
|
|
}
|
|
}
|
|
|
|
// CooldownRemaining returns how much time is left before
|
|
// an open circuit transitions to half-open.
|
|
func (cb *CircuitBreaker) CooldownRemaining() time.Duration {
|
|
cb.mu.Lock()
|
|
defer cb.mu.Unlock()
|
|
|
|
if cb.state != CircuitOpen {
|
|
return 0
|
|
}
|
|
|
|
remaining := cb.cooldown - time.Since(cb.lastFailure)
|
|
if remaining < 0 {
|
|
return 0
|
|
}
|
|
|
|
return remaining
|
|
}
|
|
|
|
// RecordSuccess records a successful delivery and resets
|
|
// the circuit breaker to closed state.
|
|
func (cb *CircuitBreaker) RecordSuccess() {
|
|
cb.mu.Lock()
|
|
defer cb.mu.Unlock()
|
|
|
|
cb.failures = 0
|
|
cb.state = CircuitClosed
|
|
}
|
|
|
|
// RecordFailure records a failed delivery. If the failure
|
|
// count reaches the threshold, the circuit trips open.
|
|
func (cb *CircuitBreaker) RecordFailure() {
|
|
cb.mu.Lock()
|
|
defer cb.mu.Unlock()
|
|
|
|
cb.failures++
|
|
cb.lastFailure = time.Now()
|
|
|
|
switch cb.state {
|
|
case CircuitClosed:
|
|
if cb.failures >= cb.threshold {
|
|
cb.state = CircuitOpen
|
|
}
|
|
|
|
case CircuitOpen:
|
|
// Already open; no state change needed.
|
|
|
|
case CircuitHalfOpen:
|
|
// Probe failed -- reopen immediately.
|
|
cb.state = CircuitOpen
|
|
}
|
|
}
|
|
|
|
// State returns the current circuit state.
|
|
func (cb *CircuitBreaker) State() CircuitState {
|
|
cb.mu.Lock()
|
|
defer cb.mu.Unlock()
|
|
|
|
return cb.state
|
|
}
|
|
|
|
// String returns the human-readable name of a circuit
|
|
// state.
|
|
func (s CircuitState) String() string {
|
|
switch s {
|
|
case CircuitClosed:
|
|
return "closed"
|
|
case CircuitOpen:
|
|
return "open"
|
|
case CircuitHalfOpen:
|
|
return "half-open"
|
|
default:
|
|
return "unknown"
|
|
}
|
|
}
|