resile

package module
v0.0.0-...-b61b47d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 2, 2026 License: MIT Imports: 6 Imported by: 0

README

Resile: Ergonomic Execution Resilience for Go

Go Reference License Build Status Codecov Go Report Card

Resile is a production-grade execution resilience and retry library for Go, inspired by Python's stamina. It provides a type-safe, ergonomic, and highly observable way to handle transient failures in distributed systems.


Table of Contents


Installation

go get github.com/cinar/resile

Why Resile?

In distributed systems, transient failures are a mathematical certainty. Resile simplifies the "Correct Way" to retry:

  • AWS Full Jitter: Uses the industry-standard algorithm to prevent "thundering herd" synchronization.
  • Generic-First: No interface{} or reflection. Full compile-time type safety.
  • Context-Aware: Strictly respects context.Context cancellation and deadlines.
  • Zero-Dependency Core: The core library only depends on the Go standard library.
  • Opinionated Defaults: Sensible production-ready defaults (5 attempts, exponential backoff).

Examples

The examples/ directory contains standalone programs showing how to use Resile in various scenarios:


Common Use Cases

1. Simple Retries

Retry a simple operation that only returns an error.

err := resile.DoErr(ctx, func(ctx context.Context) error {
    return db.PingContext(ctx)
})
2. Value-Yielding Retries (Generics)

Fetch data with full type safety. The return type is inferred from your closure.

// val is automatically inferred as *User
user, err := resile.Do(ctx, func(ctx context.Context) (*User, error) {
    return apiClient.GetUser(ctx, userID)
}, resile.WithMaxAttempts(3))
3. Stateful Retries & Endpoint Rotation

Use DoState to access the RetryState, allowing you to rotate endpoints or fallback logic based on the failure history.

endpoints := []string{"api-v1.example.com", "api-v2.example.com"}

data, err := resile.DoState(ctx, func(ctx context.Context, state resile.RetryState) (string, error) {
    // Rotate endpoint based on attempt number
    url := endpoints[state.Attempt % uint(len(endpoints))]
    return client.Get(ctx, url)
})
4. Handling Rate Limits (Retry-After)

Resile automatically detects if an error implements RetryAfterError and overrides the jittered backoff with the server-dictated duration.

type RateLimitError struct {
    WaitUntil time.Time
}

func (e *RateLimitError) Error() string { return "too many requests" }
func (e *RateLimitError) RetryAfter() time.Duration {
    return time.Until(e.WaitUntil)
}

// Resile will sleep exactly until WaitUntil when this error is encountered.
5. Layered Defense with Circuit Breaker

Combine retries (for transient blips) with a circuit breaker (for systemic outages).

import "github.com/cinar/resile/circuit"

cb := circuit.New(circuit.Config{
    FailureThreshold: 5,
    ResetTimeout:     30 * time.Second,
})

// Returns circuit.ErrCircuitOpen immediately if the downstream is failing consistently.
err := resile.DoErr(ctx, action, resile.WithCircuitBreaker(cb))
6. Structured Logging & Telemetry

Integrate with slog or OpenTelemetry without bloating your core dependencies.

import "github.com/cinar/resile/telemetry/resileslog"

logger := slog.Default()
resile.Do(ctx, action, 
    resile.WithName("get-inventory"), // Name your operation for metrics/logs
    resile.WithInstrumenter(resileslog.New(logger)),
)
7. Fast Unit Testing

Never let retry timers slow down your CI. Use WithTestingBypass to make all retries execute instantly.

func TestMyService(t *testing.T) {
    ctx := resile.WithTestingBypass(context.Background())
    
    // This will retry 10 times instantly without sleeping.
    err := service.Handle(ctx)
}

Configuration Reference

Option Description Default
WithName(string) Identifies the operation in logs/metrics. ""
WithMaxAttempts(uint) Total number of attempts (initial + retries). 5
WithBaseDelay(duration) Initial backoff duration. 100ms
WithMaxDelay(duration) Maximum possible backoff duration. 30s
WithRetryIf(error) Only retry if errors.Is(err, target). All non-fatal
WithRetryIfFunc(func) Custom logic to decide if an error is retriable. nil
WithCircuitBreaker(cb) Attaches a circuit breaker state machine. nil
WithInstrumenter(inst) Attaches telemetry (slog/OTel/Prometheus). nil

Architecture & Design

Resile is built for high-performance, concurrent applications:

  • Memory Safety: Uses time.NewTimer with proper cleanup to prevent memory leaks in long-running loops.
  • Context Integrity: Every internal sleep is a select between the timer and ctx.Done().
  • Zero Allocations: Core execution loop is designed to be allocation-efficient.
  • Errors are Values: Leverage standard errors.Is and errors.As for all policy decisions.

Acknowledgements

  • AWS Architecture Blog: For the definitive Exponential Backoff and Jitter algorithm (Full Jitter).
  • Stamina & Tenacity: For pioneering ergonomic retry APIs in the Python ecosystem that inspired the design of Resile.

License

Resile is released under the MIT License.

Copyright (c) 2026 Onur Cinar.
The source code is provided under MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Do

func Do[T any](ctx context.Context, action func(context.Context) (T, error), opts ...Option) (T, error)

Do executes an action with retry logic using the provided options. This generic function handles functions returning (T, error).

func DoErr

func DoErr(ctx context.Context, action func(context.Context) error, opts ...Option) error

DoErr executes an action with retry logic using the provided options. This function handles functions returning only error.

func DoErrState

func DoErrState(ctx context.Context, action func(context.Context, RetryState) error, opts ...Option) error

DoErrState executes a stateful action with retry logic using the provided options.

func DoState

func DoState[T any](ctx context.Context, action func(context.Context, RetryState) (T, error), opts ...Option) (T, error)

DoState executes a stateful action with retry logic using the provided options. The RetryState is passed to the closure, allowing it to adapt to failure history.

func FatalError

func FatalError(err error) error

FatalError wraps an error to indicate that the retry loop should terminate immediately.

func WithTestingBypass

func WithTestingBypass(ctx context.Context) context.Context

WithTestingBypass returns a new context that signals the retry loop to skip all sleep delays. This is intended for use in unit tests to prevent CI pipelines from being slowed down by backoff.

Types

type Backoff

type Backoff interface {
	// Next calculates the duration to wait before the specified attempt.
	// The attempt parameter is 0-indexed.
	Next(attempt uint) time.Duration
}

Backoff defines the interface for temporal distribution of retries.

func NewFullJitter

func NewFullJitter(base, cap time.Duration) Backoff

NewFullJitter returns a Backoff implementation using the AWS Full Jitter algorithm. The base duration dictates the initial delay, and the cap defines the absolute maximum.

type Config

type Config struct {
	Name           string
	MaxAttempts    uint
	BaseDelay      time.Duration
	MaxDelay       time.Duration
	Backoff        Backoff
	Policy         *retryPolicy
	Instrumenter   Instrumenter
	CircuitBreaker *circuit.Breaker
}

Config represents the configuration for the retry execution.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns a reasonable production-grade configuration.

func (*Config) Do

func (c *Config) Do(ctx context.Context, action func(context.Context) (any, error)) (any, error)

Do satisfies the Retryer interface. Note: returns any for interface compliance.

func (*Config) DoErr

func (c *Config) DoErr(ctx context.Context, action func(context.Context) error) error

DoErr satisfies the Retryer interface.

type Instrumenter

type Instrumenter interface {
	// BeforeAttempt is called before each execution attempt.
	// It can return a new context (e.g., to inject trace spans).
	BeforeAttempt(ctx context.Context, state RetryState) context.Context
	// AfterAttempt is called after each execution attempt.
	AfterAttempt(ctx context.Context, state RetryState)
}

Instrumenter defines the lifecycle hooks for monitoring retry executions. It is a zero-dependency interface to allow custom implementations for logging, metrics, and tracing.

type Option

type Option func(*Config)

Option defines a functional option for configuring a retry execution.

func WithBackoff

func WithBackoff(backoff Backoff) Option

WithBackoff sets a custom backoff algorithm.

func WithBaseDelay

func WithBaseDelay(delay time.Duration) Option

WithBaseDelay sets the initial delay for the backoff algorithm.

func WithCircuitBreaker

func WithCircuitBreaker(cb *circuit.Breaker) Option

WithCircuitBreaker integrates a circuit breaker into the retry execution.

func WithInstrumenter

func WithInstrumenter(instr Instrumenter) Option

WithInstrumenter sets a telemetry instrumenter.

func WithMaxAttempts

func WithMaxAttempts(attempts uint) Option

WithMaxAttempts sets the maximum number of execution attempts.

func WithMaxDelay

func WithMaxDelay(delay time.Duration) Option

WithMaxDelay sets the maximum delay for the backoff algorithm.

func WithName

func WithName(name string) Option

WithName sets the name for the operation. This is used in telemetry labels.

func WithRetryIf

func WithRetryIf(target error) Option

WithRetryIf sets a specific error to trigger a retry.

func WithRetryIfFunc

func WithRetryIfFunc(f func(error) bool) Option

WithRetryIfFunc sets a custom function to determine if an error should be retried.

type RetryAfterError

type RetryAfterError interface {
	error
	RetryAfter() time.Duration
}

RetryAfterError is implemented by errors that specify how long to wait before retrying. This is commonly used with HTTP 429 (Too Many Requests) or 503 (Service Unavailable) to respect Retry-After headers.

type RetryState

type RetryState struct {
	// Name is the optional identifier for the operation being retried.
	Name string
	// Attempt is the current 0-indexed retry iteration.
	Attempt uint
	// MaxAttempts is the maximum number of attempts allowed.
	MaxAttempts uint
	// LastError is the error encountered in the previous attempt.
	LastError error
	// TotalDuration is the cumulative time spent across all attempts and sleeps.
	TotalDuration time.Duration
	// NextDelay is the duration to be slept before the next attempt.
	NextDelay time.Duration
}

RetryState encapsulates the current state of a retry execution.

type Retryer

type Retryer interface {
	// Do executes a function that returns a value and an error.
	Do(ctx context.Context, action func(context.Context) (any, error)) (any, error)
	// DoErr executes a function that returns only an error.
	DoErr(ctx context.Context, action func(context.Context) error) error
}

Retryer defines the interface for executing actions with resilience.

func New

func New(opts ...Option) Retryer

New returns a new Retryer pre-configured with the provided options. This is useful for dependency injection and reusable resilience clients.

Directories

Path Synopsis
examples
basic command
circuitbreaker command
http command
stateful command
telemetry

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL