httpx

Documentation

Index

• Variables
• func DefaultShouldRetry(request *http.Request, response *http.Response, withDelay time.Duration) bool
• func Do(client *http.Client, request *http.Request, retries *RetryConfig, ...) (*http.Response, error)
• func NewRequest(method string, url string, body io.Reader, headers map[string]string) (*http.Request, error)
• func ParseRetryAfter(value string) time.Duration
• func SetDebug(enabled bool)
• func SetRequestor(requestor Requestor)
• type AccessConfig
  • func NewAccessConfig(resolveTimeout time.Duration, disallowedIPs []net.IP) *AccessConfig
  • func (c *AccessConfig) Allow(request *http.Request) (bool, error)
• type MockRequestor
  • func NewMockRequestor(mocks map[string][]MockResponse) *MockRequestor
  • func (r *MockRequestor) Clone() *MockRequestor
  • func (r *MockRequestor) Do(client *http.Client, request *http.Request) (*http.Response, error)
  • func (r *MockRequestor) HasUnused() bool
  • func (r *MockRequestor) MarshalJSON() ([]byte, error)
  • func (r *MockRequestor) UnmarshalJSON(data []byte) error
• type MockResponse
  • func NewMockResponse(status int, headers map[string]string, body string) MockResponse
  • func (m MockResponse) Make(request *http.Request) *http.Response
  • func (m *MockResponse) MarshalJSON() ([]byte, error)
  • func (m *MockResponse) UnmarshalJSON(data []byte) error
• type Requestor
• type RetryConfig
  • func NewExponentialRetries(initialBackoff time.Duration, count int, jitter float64) *RetryConfig
  • func NewFixedRetries(backoffs ...time.Duration) *RetryConfig
  • func (r *RetryConfig) Backoff(n int) time.Duration
  • func (r *RetryConfig) MaxRetries() int
• type Trace
  • func DoTrace(client *http.Client, request *http.Request, retries *RetryConfig, ...) (*Trace, error)
  • func (t *Trace) ResponseTraceUTF8(placeholder string) string
  • func (t *Trace) String() string

Variables

var MockConnectionError = MockResponse{Status: 0, Headers: nil, Body: []byte{}, BodyRepeat: 0}

MockConnectionError mocks a connection error

Functions

func DefaultShouldRetry

func DefaultShouldRetry(request *http.Request, response *http.Response, withDelay time.Duration) bool

DefaultShouldRetry is the default function for determining if a response should be retried

func Do

func Do(client *http.Client, request *http.Request, retries *RetryConfig, access *AccessConfig) (*http.Response, error)

Do makes the given HTTP request using the current requestor and retry config

func NewRequest

func NewRequest(method string, url string, body io.Reader, headers map[string]string) (*http.Request, error)

NewRequest is a convenience method to create a request with the given headers

func ParseRetryAfter

func ParseRetryAfter(value string) time.Duration

ParseRetryAfter parses value of Retry-After headers which can be date or delay in seconds see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After

func SetDebug

func SetDebug(enabled bool)

SetDebug enables debugging

func SetRequestor

func SetRequestor(requestor Requestor)

SetRequestor sets the requestor used by Request

Types

type AccessConfig

type AccessConfig struct {
	ResolveTimeout time.Duration
	DisallowedIPs  []net.IP
}

AccessConfig configures what can be accessed

func NewAccessConfig

func NewAccessConfig(resolveTimeout time.Duration, disallowedIPs []net.IP) *AccessConfig

NewAccessConfig creates a new access config

func (*AccessConfig) Allow

func (c *AccessConfig) Allow(request *http.Request) (bool, error)

Allow determines whether the given request should be allowed

type MockRequestor

type MockRequestor struct {
	// contains filtered or unexported fields
}

MockRequestor is a requestor which can be mocked with responses for given URLs

func NewMockRequestor

func NewMockRequestor(mocks map[string][]MockResponse) *MockRequestor

NewMockRequestor creates a new mock requestor with the given mocks

func (*MockRequestor) Clone

func (r *MockRequestor) Clone() *MockRequestor

Clone returns a clone of this requestor

func (*MockRequestor) Do

func (r *MockRequestor) Do(client *http.Client, request *http.Request) (*http.Response, error)

Do returns the mocked reponse for the given request

func (*MockRequestor) HasUnused

func (r *MockRequestor) HasUnused() bool

HasUnused returns true if there are unused mocks leftover

func (*MockRequestor) MarshalJSON

func (r *MockRequestor) MarshalJSON() ([]byte, error)

func (*MockRequestor) UnmarshalJSON

func (r *MockRequestor) UnmarshalJSON(data []byte) error

type MockResponse

type MockResponse struct {
	Status     int
	Headers    map[string]string
	Body       []byte
	BodyRepeat int
}

func NewMockResponse

func NewMockResponse(status int, headers map[string]string, body string) MockResponse

NewMockResponse creates a new mock response from a string

func (MockResponse) Make

func (m MockResponse) Make(request *http.Request) *http.Response

Make mocks making the given request and returning this as the response

func (*MockResponse) MarshalJSON

func (m *MockResponse) MarshalJSON() ([]byte, error)

func (*MockResponse) UnmarshalJSON

func (m *MockResponse) UnmarshalJSON(data []byte) error

type Requestor

type Requestor interface {
	Do(*http.Client, *http.Request) (*http.Response, error)
}

Requestor is anything that can make an HTTP request with a client

var DefaultRequestor Requestor = defaultRequestor{}

DefaultRequestor is the default HTTP requestor

type RetryConfig

type RetryConfig struct {
	Backoffs    []time.Duration
	Jitter      float64
	ShouldRetry func(*http.Request, *http.Response, time.Duration) bool
}

RetryConfig configures if and how retrying of requests happens

func NewExponentialRetries

func NewExponentialRetries(initialBackoff time.Duration, count int, jitter float64) *RetryConfig

NewExponentialRetries creates a new retry config with the given delays

func NewFixedRetries

func NewFixedRetries(backoffs ...time.Duration) *RetryConfig

NewFixedRetries creates a new retry config with the given backoffs

func (*RetryConfig) Backoff

func (r *RetryConfig) Backoff(n int) time.Duration

Backoff gets the backoff time for the nth retry

func (*RetryConfig) MaxRetries

func (r *RetryConfig) MaxRetries() int

MaxRetries gets the maximum number of retries allowed

type Trace

type Trace struct {
	Request       *http.Request
	RequestTrace  []byte
	Response      *http.Response
	ResponseTrace []byte
	ResponseBody  []byte // response body stored separately
	StartTime     time.Time
	EndTime       time.Time
}

Trace holds the complete trace of an HTTP request/response

func DoTrace

func DoTrace(client *http.Client, request *http.Request, retries *RetryConfig, access *AccessConfig, maxBodyBytes int) (*Trace, error)

DoTrace makes the given request saving traces of the complete request and response

func (*Trace) ResponseTraceUTF8

func (t *Trace) ResponseTraceUTF8(placeholder string) string

ResponseTraceUTF8 returns a valid UTF-8 string version of trace, substituting the body with placeholder if it isn't valid UTF-8

func (*Trace) String

func (t *Trace) String() string