Merge pull request #99 from kaleido-io/ffresty-require-code-configura…

…tion

Add config option to provide a regex to decide status code that can be retried

pkg/ffresty/config.go

@@ -57,6 +57,9 @@ const (
 	HTTPConfigRetryInitDelay = "retry.initWaitTime"
 	// HTTPConfigRetryMaxDelay the maximum retry delay
 	HTTPConfigRetryMaxDelay = "retry.maxWaitTime"
+	// HTTPConfigRetryErrorStatusCodeRegex the regex that the error response status code must match to trigger retry
+	HTTPConfigRetryErrorStatusCodeRegex = "retry.errorStatusCodeRegex"
+
 	// HTTPConfigRequestTimeout the request timeout
 	HTTPConfigRequestTimeout = "requestTimeout"
 	// HTTPIdleTimeout the max duration to hold a HTTP keepalive connection between calls
@@ -88,6 +91,7 @@ func InitConfig(conf config.Section) {
 	conf.AddKnownKey(HTTPConfigRetryCount, defaultRetryCount)
 	conf.AddKnownKey(HTTPConfigRetryInitDelay, defaultRetryWaitTime)
 	conf.AddKnownKey(HTTPConfigRetryMaxDelay, defaultRetryMaxWaitTime)
+	conf.AddKnownKey(HTTPConfigRetryErrorStatusCodeRegex)
 	conf.AddKnownKey(HTTPConfigRequestTimeout, defaultRequestTimeout)
 	conf.AddKnownKey(HTTPIdleTimeout, defaultHTTPIdleTimeout)
 	conf.AddKnownKey(HTTPMaxIdleConns, defaultHTTPMaxIdleConns)
@@ -113,6 +117,7 @@ func GenerateConfig(ctx context.Context, conf config.Section) (*Config, error) {
 		RetryCount:                    conf.GetInt(HTTPConfigRetryCount),
 		RetryInitialDelay:             conf.GetDuration(HTTPConfigRetryInitDelay),
 		RetryMaximumDelay:             conf.GetDuration(HTTPConfigRetryMaxDelay),
+		RetryErrorStatusCodeRegex:     conf.GetString(HTTPConfigRetryErrorStatusCodeRegex),
 		HTTPRequestTimeout:            conf.GetDuration(HTTPConfigRequestTimeout),
 		HTTPIdleConnTimeout:           conf.GetDuration(HTTPIdleTimeout),
 		HTTPMaxIdleConns:              conf.GetInt(HTTPMaxIdleConns),

pkg/ffresty/config_test.go

@@ -39,6 +39,7 @@ func TestWSConfigGeneration(t *testing.T) {
 	utConf.Set(HTTPConfigRetryInitDelay, 1)
 	utConf.Set(HTTPConfigRetryMaxDelay, 1)
 	utConf.Set(HTTPConfigRetryCount, 1)
+	utConf.Set(HTTPConfigRetryErrorStatusCodeRegex, "(?:429|503)")
 	utConf.Set(HTTPConfigRequestTimeout, 1)
 	utConf.Set(HTTPIdleTimeout, 1)
 	utConf.Set(HTTPMaxIdleConns, 1)
@@ -57,6 +58,7 @@ func TestWSConfigGeneration(t *testing.T) {
 	assert.Equal(t, "pass", config.AuthPassword)
 	assert.Equal(t, time.Duration(1000000), config.RetryInitialDelay)
 	assert.Equal(t, time.Duration(1000000), config.RetryMaximumDelay)
+	assert.Equal(t, "(?:429|503)", config.RetryErrorStatusCodeRegex)
 	assert.Equal(t, 1, config.RetryCount)
 	assert.Equal(t, true, config.Retry)
 	assert.Equal(t, true, config.HTTPPassthroughHeadersEnabled)

pkg/ffresty/ffresty.go

@@ -24,6 +24,7 @@ import (
 	"io"
 	"net"
 	"net/http"
+	"regexp"
 	"strings"
 	"time"
 
@@ -58,6 +59,7 @@ type Config struct {
 	RetryCount                    int                                       `json:"retryCount,omitempty"`
 	RetryInitialDelay             time.Duration                             `json:"retryInitialDelay,omitempty"`
 	RetryMaximumDelay             time.Duration                             `json:"retryMaximumDelay,omitempty"`
+	RetryErrorStatusCodeRegex     string                                    `json:"retryErrorStatusCodeRegex,omitempty"`
 	HTTPMaxIdleConns              int                                       `json:"maxIdleConns,omitempty"`
 	HTTPMaxConnsPerHost           int                                       `json:"maxConnsPerHost,omitempty"`
 	HTTPPassthroughHeadersEnabled bool                                      `json:"httpPassthroughHeadersEnabled,omitempty"`
@@ -208,6 +210,11 @@ func NewWithConfig(ctx context.Context, ffrestyConfig Config) (client *resty.Cli
 		client.SetHeader("Authorization", fmt.Sprintf("Basic %s", base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", ffrestyConfig.AuthUsername, ffrestyConfig.AuthPassword)))))
 	}
 
+	var retryStatusCodeRegex *regexp.Regexp
+	if ffrestyConfig.RetryErrorStatusCodeRegex != "" {
+		retryStatusCodeRegex = regexp.MustCompile(ffrestyConfig.RetryErrorStatusCodeRegex)
+	}
+
 	if ffrestyConfig.Retry {
 		retryCount := ffrestyConfig.RetryCount
 		minTimeout := ffrestyConfig.RetryInitialDelay
@@ -220,6 +227,12 @@ func NewWithConfig(ctx context.Context, ffrestyConfig Config) (client *resty.Cli
 				if r == nil || r.IsSuccess() {
 					return false
 				}
+
+				if r.StatusCode() > 0 && retryStatusCodeRegex != nil && !retryStatusCodeRegex.MatchString(r.Status()) {
+					// the error status code doesn't match the retry status code regex, stop retry
+					return false
+				}
+
 				rCtx := r.Request.Context()
 				rc := rCtx.Value(retryCtxKey{}).(*retryCtx)
 				if ffrestyConfig.OnCheckRetry != nil && !ffrestyConfig.OnCheckRetry(r, err) {

pkg/ffresty/ffresty_test.go

@@ -25,6 +25,7 @@ import (
 	"crypto/x509/pkix"
 	"encoding/json"
 	"encoding/pem"
+	"errors"
 	"fmt"
 	"log"
 	"math/big"
@@ -114,6 +115,55 @@ func TestRequestRetry(t *testing.T) {
 
 }
 
+func TestRequestRetryErrorStatusCodeRegex(t *testing.T) {
+
+	ctx := context.Background()
+
+	resetConf()
+	utConf.Set(HTTPConfigURL, "http://localhost:12345")
+	utConf.Set(HTTPConfigRetryEnabled, true)
+	utConf.Set(HTTPConfigRetryInitDelay, 1)
+	utConf.Set(HTTPConfigRetryErrorStatusCodeRegex, "(?:429|503)")
+
+	c, err := New(ctx, utConf)
+	assert.Nil(t, err)
+	httpmock.ActivateNonDefault(c.GetClient())
+	defer httpmock.DeactivateAndReset()
+
+	httpmock.RegisterResponder("GET", "http://localhost:12345/test",
+		httpmock.NewStringResponder(500, `{"message": "pop"}`))
+
+	httpmock.RegisterResponder("GET", "http://localhost:12345/test2",
+		httpmock.NewStringResponder(429, `{"message": "pop"}`))
+
+	httpmock.RegisterResponder("GET", "http://localhost:12345/test3",
+		httpmock.NewErrorResponder(errors.New("not http response")))
+
+	resp, err := c.R().Get("/test")
+	assert.NoError(t, err)
+	assert.Equal(t, 500, resp.StatusCode())
+	assert.Equal(t, 1, httpmock.GetTotalCallCount())
+
+	err = WrapRestErr(ctx, resp, err, i18n.MsgConfigFailed)
+	assert.Error(t, err)
+
+	resp, err = c.R().Get("/test2")
+	assert.NoError(t, err)
+	assert.Equal(t, 429, resp.StatusCode())
+	assert.Equal(t, 7, httpmock.GetTotalCallCount())
+
+	err = WrapRestErr(ctx, resp, err, i18n.MsgConfigFailed)
+	assert.Error(t, err)
+
+	resp, err = c.R().Get("/test3")
+	assert.Error(t, err)
+	assert.Equal(t, 0, resp.StatusCode())
+	assert.Equal(t, 13, httpmock.GetTotalCallCount())
+
+	err = WrapRestErr(ctx, resp, err, i18n.MsgConfigFailed)
+	assert.Error(t, err)
+
+}
 func TestConfWithProxy(t *testing.T) {
 
 	ctx := context.Background()