1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
|
package hedgedhttp_test
import (
"context"
"errors"
"math/rand"
"net/http"
"sync/atomic"
"time"
"github.com/cristalhq/hedgedhttp"
)
/*
func ExampleClient() {
ctx := context.Background()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://cristalhq.dev", http.NoBody)
if err != nil {
panic(err)
}
timeout := 10 * time.Millisecond
upto := 7
client := &http.Client{Timeout: time.Second}
hedged, err := hedgedhttp.NewClient(timeout, upto, client)
if err != nil {
panic(err)
}
// will take `upto` requests, with a `timeout` delay between them
resp, err := hedged.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
// and do something with resp
// Output:
}
*/
func Example_configNext() {
rt := &observableRoundTripper{
rt: http.DefaultTransport,
}
cfg := hedgedhttp.Config{
Transport: rt,
Upto: 3,
Delay: 50 * time.Millisecond,
Next: func() (upto int, delay time.Duration) {
return 3, rt.MaxLatency()
},
}
client, err := hedgedhttp.New(cfg)
if err != nil {
panic(err)
}
// or client.Do
resp, err := client.RoundTrip(&http.Request{})
_ = resp
// Output:
}
/*
func ExampleRoundTripper() {
ctx := context.Background()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://cristalhq.dev", http.NoBody)
if err != nil {
panic(err)
}
timeout := 10 * time.Millisecond
upto := 7
transport := http.DefaultTransport
hedged, stats, err := hedgedhttp.NewRoundTripperAndStats(timeout, upto, transport)
if err != nil {
panic(err)
}
// print stats periodically
go func() {
for {
time.Sleep(time.Second)
fmt.Fprintf(io.Discard, "all requests: %d\n", stats.ActualRoundTrips())
}
}()
// will take `upto` requests, with a `timeout` delay between them
resp, err := hedged.RoundTrip(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
// and do something with resp
// Output:
}
*/
func Example_instrumented() {
transport := &InstrumentedTransport{
Transport: http.DefaultTransport,
}
_, err := hedgedhttp.NewRoundTripper(time.Millisecond, 3, transport)
if err != nil {
panic(err)
}
// Output:
}
type InstrumentedTransport struct {
Transport http.RoundTripper // Used to make actual requests.
}
func (t *InstrumentedTransport) RoundTrip(req *http.Request) (*http.Response, error) {
// NOTE: log, update metric, add trace to the req variable.
resp, err := t.Transport.RoundTrip(req)
if err != nil {
return nil, err
}
// NOTE: log, update metric based on the resp variable.
return resp, nil
}
func Example_ratelimited() {
transport := &RateLimitedHedgedTransport{
Transport: http.DefaultTransport,
Limiter: &RandomRateLimiter{},
}
_, err := hedgedhttp.NewRoundTripper(time.Millisecond, 3, transport)
if err != nil {
panic(err)
}
// Output:
}
// by example https://pkg.go.dev/golang.org/x/time/rate
type RateLimiter interface {
Wait(ctx context.Context) error
}
type RateLimitedHedgedTransport struct {
Transport http.RoundTripper // Used to make actual requests.
Limiter RateLimiter // Any ratelimit-like thing.
}
func (t *RateLimitedHedgedTransport) RoundTrip(r *http.Request) (*http.Response, error) {
// apply rate limit only for hedged requests
if hedgedhttp.IsHedgedRequest(r) {
if err := t.Limiter.Wait(r.Context()); err != nil {
return nil, err
}
}
return t.Transport.RoundTrip(r)
}
// Just for the example.
type RandomRateLimiter struct{}
func (r *RandomRateLimiter) Wait(ctx context.Context) error {
if rand.Int()%2 == 0 {
return errors.New("rate limit exceed")
}
return nil
}
func ExampleMultiTransport() {
transport := &MultiTransport{
First: &http.Transport{MaxIdleConns: 10}, // just an example
Hedged: &http.Transport{MaxIdleConns: 30}, // just an example
}
_, err := hedgedhttp.NewRoundTripper(time.Millisecond, 3, transport)
if err != nil {
panic(err)
}
// Output:
}
type MultiTransport struct {
First http.RoundTripper // Used to make 1st requests.
Hedged http.RoundTripper // Used to make hedged requests.
}
func (t *MultiTransport) RoundTrip(req *http.Request) (*http.Response, error) {
if hedgedhttp.IsHedgedRequest(req) {
return t.Hedged.RoundTrip(req)
}
return t.First.RoundTrip(req)
}
type observableRoundTripper struct {
rt http.RoundTripper
maxLatency atomic.Uint64
}
func (ort *observableRoundTripper) MaxLatency() time.Duration {
return time.Duration(ort.maxLatency.Load())
}
func (ort *observableRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
start := time.Now()
resp, err := ort.rt.RoundTrip(req)
if err != nil {
return resp, err
}
took := uint64(time.Since(start).Nanoseconds())
for {
max := ort.maxLatency.Load()
if max >= took {
return resp, err
}
if ort.maxLatency.CompareAndSwap(max, took) {
return resp, err
}
}
}
|