Merge pull request #588 from xmidt-org/retryingonhttperror

Http error retry funcs

Author: mtrinh11

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v2.0.2]
+- Added logic to xhttp for retrying on http errors.[#588](https://github.com/xmidt-org/webpa-common/pull/588)
+
 ## [v2.0.1]
 - Avoid service discovery events for index underflow or retryable errors [#586](https://github.com/xmidt-org/webpa-common/pull/586)
 
@@ -217,7 +220,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
  - The first official release. We will be better about documenting changes 
    moving forward.
 
-[Unreleased]: https://github.com/xmidt-org/webpa-common/compare/v2.0.1...HEAD
+[Unreleased]: https://github.com/xmidt-org/webpa-common/compare/v2.0.2...HEAD
+[v2.0.2]: https://github.com/xmidt-org/webpa-common/compare/v2.0.1...v2.0.2
 [v2.0.1]: https://github.com/xmidt-org/webpa-common/compare/v2.0.0...v2.0.1
 [v2.0.0]: https://github.com/xmidt-org/webpa-common/compare/v1.11.9...v2.0.0
 [v1.11.9]: https://github.com/xmidt-org/webpa-common/compare/v1.11.8...v1.11.9

xhttp/error.go

@@ -1,3 +1,20 @@
+/**
+ * Copyright 2021 Comcast Cable Communications Management, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 package xhttp
 
 import (

xhttp/error_test.go

@@ -1,3 +1,20 @@
+/**
+ * Copyright 2021 Comcast Cable Communications Management, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 package xhttp
 
 import (

xhttp/mocks_test.go

@@ -56,3 +56,9 @@ func (m *mockListener) Close() error {
 func (m *mockListener) Addr() net.Addr {
 	return m.Called().Get(0).(net.Addr)
 }
+
+type mockTempError struct{}
+
+func (m mockTempError) Temporary() bool { return true }
+
+func (m mockTempError) Error() string { return "mock temp error" }

xhttp/retry.go

@@ -1,6 +1,25 @@
+/**
+ * Copyright 2021 Comcast Cable Communications Management, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 package xhttp
 
 import (
+	"context"
+	"errors"
 	"net/http"
 	"time"
 
@@ -146,3 +165,33 @@ func RetryTransactor(o RetryOptions, next func(*http.Request) (*http.Response, e
 		return response, err
 	}
 }
+
+func IsTemporary(err error) bool {
+	type temporary interface {
+		Temporary() bool
+	}
+	var te temporary
+	if errors.As(err, &te) {
+		return te.Temporary()
+	}
+	return false
+}
+
+func ShouldRetry(err error) bool {
+	if errors.Is(err, context.DeadlineExceeded) {
+		return false
+	}
+	return IsTemporary(err)
+}
+
+func RetryCodes(i int) bool {
+	switch i {
+	case http.StatusRequestTimeout:
+		return true
+	case http.StatusTooManyRequests:
+		return true
+	case http.StatusGatewayTimeout:
+		return true
+	}
+	return false
+}

xhttp/retry_test.go

@@ -1,6 +1,24 @@
+/**
+ * Copyright 2021 Comcast Cable Communications Management, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
 package xhttp
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"io"
@@ -273,3 +291,72 @@ func TestRetryTransactor(t *testing.T) {
 	t.Run("RewindError", testRetryTransactorRewindError)
 	t.Run("StatusRetry", testRetryTransactorStatus)
 }
+
+func TestRetryCodes(t *testing.T) {
+	tcs := []struct {
+		desc           string
+		httpCode       int
+		expectedResult bool
+	}{
+		{
+			desc:           "StatusRequestTimeout",
+			httpCode:       408,
+			expectedResult: true,
+		},
+		{
+			desc:           "StatusTooManyRequests",
+			httpCode:       429,
+			expectedResult: true,
+		},
+		{
+			desc:           "StatusGatewayTimeout",
+			httpCode:       504,
+			expectedResult: true,
+		},
+		{
+			desc:           "Random Code Failure",
+			httpCode:       400,
+			expectedResult: false,
+		},
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.desc, func(t *testing.T) {
+			assert := assert.New(t)
+			res := RetryCodes(tc.httpCode)
+			assert.Equal(res, tc.expectedResult)
+		})
+	}
+}
+
+func TestShouldRetry(t *testing.T) {
+	var mockTempErr mockTempError
+	tcs := []struct {
+		desc           string
+		errCase        error
+		expectedResult bool
+	}{
+		{
+			desc:           "DeadlineExceeded Case",
+			errCase:        context.DeadlineExceeded,
+			expectedResult: false,
+		},
+		{
+			desc:           "False Temporary Error Case",
+			errCase:        errors.New("not temp"),
+			expectedResult: false,
+		},
+		{
+			desc:           "True Temporary Error Case",
+			errCase:        mockTempErr,
+			expectedResult: true,
+		},
+	}
+	for _, tc := range tcs {
+		t.Run(tc.desc, func(t *testing.T) {
+			assert := assert.New(t)
+			res := ShouldRetry(tc.errCase)
+			assert.Equal(res, tc.expectedResult)
+		})
+	}
+}