feat: Use retry http and add backoff #151
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "regexp" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| "github.com/hashicorp/go-retryablehttp" | ||
| ) | ||
|
|
||
| var ( | ||
| rateLimitResetHeaders = []string{ | ||
| "x-organization-rate-limit-reset", | ||
| "x-instant-test-rate-limit-reset", | ||
| } | ||
| resetHeaderPattern = regexp.MustCompile(`^\s*[0-9]+\s*$`) | ||
| timeNow = time.Now | ||
| ) | ||
|
|
||
| // Custom backoff function | ||
| func thousandEyesBackoff(min, max time.Duration, attemptNum int, resp *http.Response) time.Duration { | ||
| if resp == nil { | ||
| return 0 | ||
| } | ||
|
|
||
| if resp.StatusCode == http.StatusTooManyRequests || resp.StatusCode == http.StatusServiceUnavailable { | ||
| if sleep, ok := parseRetryAfterHeader(resp.Header["Retry-After"]); ok { | ||
| return sleep | ||
| } | ||
| } | ||
|
|
||
| for _, header := range rateLimitResetHeaders { | ||
| if resetTimeStr := resp.Header.Get(header); resetTimeStr != "" { | ||
| if sleep, ok := parseResetHeader(&resetTimeStr); ok { | ||
| return sleep | ||
| } | ||
|
|
||
| // Default backoff if no valid reset time is found | ||
| return retryablehttp.DefaultBackoff(min, max, attemptNum, resp) | ||
| } | ||
| } | ||
|
|
||
| // Default case for no Retry-After and rateLimitResetHeaders | ||
| return retryablehttp.DefaultBackoff(min, max, attemptNum, resp) | ||
| } | ||
|
|
||
| func parseRetryAfterHeader(headers []string) (time.Duration, bool) { | ||
|
tshe-te marked this conversation as resolved.
|
||
| if len(headers) == 0 || headers[0] == "" { | ||
| return 0, false | ||
| } | ||
| header := headers[0] | ||
| // Retry-After: 120 | ||
| if sleep, err := strconv.ParseInt(header, 10, 64); err == nil { | ||
| if sleep < 0 { // a negative sleep doesn't make sense | ||
| return 0, false | ||
| } | ||
| return time.Second * time.Duration(sleep), true | ||
| } | ||
|
|
||
| // Retry-After: Fri, 31 Dec 1999 23:59:59 GMT | ||
| retryTime, err := time.Parse(time.RFC1123, header) | ||
| if err != nil { | ||
| return 0, false | ||
| } | ||
| if until := retryTime.Sub(timeNow()); until > 0 { | ||
| return until, true | ||
| } | ||
| // date is in the past | ||
| return 0, true | ||
| } | ||
|
|
||
| // Function to parse the reset header | ||
| func parseResetHeader(value *string) (time.Duration, bool) { | ||
| if value == nil || !resetHeaderPattern.MatchString(*value) { | ||
| return 0, false | ||
| } | ||
|
|
||
| // Parse the header value to a Unix timestamp | ||
| resetTimeUnix, err := strconv.ParseInt(*value, 10, 64) | ||
| if err != nil { | ||
| return 0, false | ||
| } | ||
|
|
||
| // Calculate the duration until the reset time | ||
| resetTime := time.Unix(resetTimeUnix, 0) | ||
| waitDuration := time.Until(resetTime) | ||
|
|
||
| // Return 0 if the reset time has already passed | ||
| if waitDuration < 0 { | ||
| return 0, true | ||
| } | ||
| return waitDuration, true | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,15 @@ | ||
| module github.com/thousandeyes/thousandeyes-sdk-go/v3 | ||
|
|
||
| go 1.23 | ||
|
|
||
| toolchain go1.24.8 | ||
|
|
||
| require github.com/stretchr/testify v1.7.2 | ||
|
|
||
| require ( | ||
| github.com/davecgh/go-spew v1.1.0 // indirect | ||
| github.com/hashicorp/go-cleanhttp v0.5.2 // indirect | ||
| github.com/hashicorp/go-retryablehttp v0.7.8 // indirect | ||
| github.com/pmezard/go-difflib v1.0.0 // indirect | ||
| gopkg.in/yaml.v3 v3.0.1 // indirect | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This function has the same logic as the python SDK which respects Retry-After first then checks thousandeyes headers. https://github.com/thousandeyes/thousandeyes-sdk-python/pull/7/files#diff-8587054108c7902eac148f3b9ea7a213f04ddebde0be29f8b68affe61b98b39fR46