Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sleep option for buffered retries #198

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions buffer/buffer.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,14 @@ Examples of a buffering middleware:
// Will do the same as above, but with responses
buffer.New(handler,
buffer.MemResponseBodyBytes(2 * 1024 * 1024),
buffer.MaxResponseBodyBytes(10 * 1024 * 1024))
buffer.MaxResponseBodyBytes(10 * 1024 * 1024))


// Buffer will replay the request if the handler returns error at least 3 times
// before returning the response
buffer.New(handler, buffer.Retry(`IsNetworkError() && Attempts() <= 2`))
// before returning the response, sleeping for 1 second in between attempts
buffer.New(handler,
buffer.Retry(`IsNetworkError() && Attempts() <= 2`),
buffer.RetrySleep(time.Second))

*/
package buffer
Expand All @@ -43,6 +46,7 @@ import (
"net"
"net/http"
"reflect"
"time"

"github.com/mailgun/multibuf"
log "github.com/sirupsen/logrus"
Expand All @@ -56,6 +60,8 @@ const (
DefaultMaxBodyBytes = -1
// DefaultMaxRetryAttempts Maximum retry attempts
DefaultMaxRetryAttempts = 10
// DefaultRetrySleep specifies the default sleep between retries
DefaultRetrySleep = time.Second * 0
)

var errHandler utils.ErrorHandler = &SizeErrHandler{}
Expand All @@ -69,6 +75,8 @@ type Buffer struct {
maxResponseBodyBytes int64
memResponseBodyBytes int64

retrySleep time.Duration

retryPredicate hpredicate

next http.Handler
Expand All @@ -88,6 +96,8 @@ func New(next http.Handler, setters ...optSetter) (*Buffer, error) {
maxResponseBodyBytes: DefaultMaxBodyBytes,
memResponseBodyBytes: DefaultMemBodyBytes,

retrySleep: DefaultRetrySleep,

log: log.StandardLogger(),
}
for _, s := range setters {
Expand Down Expand Up @@ -202,6 +212,17 @@ func MemResponseBodyBytes(m int64) optSetter {
}
}

// RetrySleep sets sleep duration between retries
func RetrySleep(t time.Duration) optSetter {
return func(b *Buffer) error {
if t < 0 {
return fmt.Errorf("sleep duration should be >= 0 got %s", t)
}
b.retrySleep = t
return nil
}
}

// Wrap sets the next handler to be called by buffer handler.
func (b *Buffer) Wrap(next http.Handler) error {
b.next = next
Expand Down Expand Up @@ -317,6 +338,8 @@ func (b *Buffer) ServeHTTP(w http.ResponseWriter, req *http.Request) {

outreq = b.copyRequest(req, body, totalSize)
b.log.Debugf("vulcand/oxy/buffer: retry Request(%v %v) attempt %v", req.Method, req.URL, attempt)

time.Sleep(b.retrySleep)
}
}

Expand Down
9 changes: 6 additions & 3 deletions buffer/retry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"net/http"
"net/http/httptest"
"testing"
"time"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -37,7 +38,7 @@ func TestRetryOnError(t *testing.T) {
})
defer srv.Close()

lb, rt := newBufferMiddleware(t, `IsNetworkError() && Attempts() <= 2`)
lb, rt := newBufferMiddleware(t, `IsNetworkError() && Attempts() <= 2`, RetrySleep(time.Second))

proxy := httptest.NewServer(rt)
defer proxy.Close()
Expand Down Expand Up @@ -72,7 +73,7 @@ func TestRetryExceedAttempts(t *testing.T) {
assert.Equal(t, http.StatusBadGateway, re.StatusCode)
}

func newBufferMiddleware(t *testing.T, p string) (*roundrobin.RoundRobin, *Buffer) {
func newBufferMiddleware(t *testing.T, p string, setters ...optSetter) (*roundrobin.RoundRobin, *Buffer) {
// forwarder will proxy the request to whatever destination
fwd, err := forward.New()
require.NoError(t, err)
Expand All @@ -81,8 +82,10 @@ func newBufferMiddleware(t *testing.T, p string) (*roundrobin.RoundRobin, *Buffe
lb, err := roundrobin.New(fwd)
require.NoError(t, err)

setters = append(setters, Retry(p), MemRequestBodyBytes(1))

// stream handler will forward requests to redirect, make sure it uses files
st, err := New(lb, Retry(p), MemRequestBodyBytes(1))
st, err := New(lb, setters...)
require.NoError(t, err)

return lb, st
Expand Down