feat(internal/gensupport): add configurable retry #1324
There are no files selected for viewing
This file contains 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 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 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,106 @@ | ||
| // Copyright 2021 Google LLC. | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package gensupport | ||
|
|
||
| import ( | ||
| "io" | ||
| "time" | ||
|
|
||
| "github.com/googleapis/gax-go/v2" | ||
| "google.golang.org/api/googleapi" | ||
| ) | ||
|
|
||
| // Backoff is an interface around gax.Backoff's Pause method, allowing tests to provide their | ||
| // own implementation. | ||
| type Backoff interface { | ||
| Pause() time.Duration | ||
| } | ||
|
|
||
| // These are declared as global variables so that tests can overwrite them. | ||
| var ( | ||
| // Per-chunk deadline for resumable uploads. | ||
| retryDeadline = 32 * time.Second | ||
| // Default backoff timer. | ||
| backoff = func() Backoff { | ||
| return &gax.Backoff{Initial: 100 * time.Millisecond} | ||
| } | ||
| // syscallRetryable is a platform-specific hook, specified in retryable_linux.go | ||
| syscallRetryable func(error) bool = func(err error) bool { return false } | ||
| ) | ||
|
|
||
| const ( | ||
| // statusTooManyRequests is returned by the storage API if the | ||
| // per-project limits have been temporarily exceeded. The request | ||
| // should be retried. | ||
| // https://cloud.google.com/storage/docs/json_api/v1/status-codes#standardcodes | ||
| statusTooManyRequests = 429 | ||
| ) | ||
|
|
||
| // shouldRetry indicates whether an error is retryable for the purposes of this | ||
| // package, unless a ShouldRetry func is specified by the RetryConfig instead. | ||
| // It follows guidance from | ||
| // https://cloud.google.com/storage/docs/exponential-backoff . | ||
| func shouldRetry(status int, err error) bool { | ||
| if 500 <= status && status <= 599 { | ||
| return true | ||
| } | ||
| if status == statusTooManyRequests { | ||
| return true | ||
| } | ||
| if err == io.ErrUnexpectedEOF { | ||
| return true | ||
| } | ||
| // Transient network errors should be retried. | ||
| if syscallRetryable(err) { | ||
| return true | ||
| } | ||
| if err, ok := err.(interface{ Temporary() bool }); ok { | ||
| if err.Temporary() { | ||
| return true | ||
| } | ||
| } | ||
| // If Go 1.13 error unwrapping is available, use this to examine wrapped | ||
| // errors. | ||
| if err, ok := err.(interface{ Unwrap() error }); ok { | ||
| return shouldRetry(status, err.Unwrap()) | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // RetryConfig allows configuration of backoff timing and retryable errors. | ||
| type RetryConfig struct { | ||
| Backoff *gax.Backoff | ||
| ShouldRetry func(err error) bool | ||
| } | ||
|
|
||
| // Get a new backoff object based on the configured values. | ||
| func (r *RetryConfig) backoff() Backoff { | ||
| if r == nil || r.Backoff == nil { | ||
| return backoff() | ||
| } | ||
| return &gax.Backoff{ | ||
| Initial: r.Backoff.Initial, | ||
| Max: r.Backoff.Max, | ||
| Multiplier: r.Backoff.Multiplier, | ||
| } | ||
| } | ||
|
|
||
| // This is kind of hacky; it is necessary because ShouldRetry expects to | ||
| // handle HTTP errors via googleapi.Error, but the error has not yet been | ||
| // wrapped with a googleapi.Error at this layer, and the ErrorFunc type | ||
| // in the manual layer does not pass in a status explicitly as it does | ||
| // here. So, we must wrap error status codes in a googleapi.Error so that | ||
| // ShouldRetry can parse this correctly. | ||
| func (r *RetryConfig) errorFunc() func(status int, err error) bool { | ||
| if r == nil || r.ShouldRetry == nil { | ||
| return shouldRetry | ||
| } | ||
| return func(status int, err error) bool { | ||
| if status >= 400 { | ||
| return r.ShouldRetry(&googleapi.Error{Code: status}) | ||
| } | ||
| return r.ShouldRetry(err) | ||
| } | ||
| } |
This file contains 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 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.
Could the error codes be pulled from gax instead of string literals?
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.
Seeing as this is just a one-off comment and these values are not likely to change, I don't think it's work adding extra complexity to the templating in order to accomplish this.