Add retry logic to UCP GetAWSResourceWithPost handler
#8170
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,82 @@ | ||
| package retry | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
|
|
||
| "github.com/sethvargo/go-retry" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultInterval = 1 * time.Second | ||
| defaultMaxRetries = 10 | ||
| defaultMaxDuration = 60 * time.Second | ||
| ) | ||
|
|
||
| // RetryConfig is the configuration for a retry operation. | ||
| type RetryConfig struct { | ||
| // BackoffStrategy is the backoff strategy to use. | ||
| BackoffStrategy retry.Backoff | ||
| } | ||
|
|
||
| // Retryer is a utility for retrying functions. | ||
| type Retryer struct { | ||
| config *RetryConfig | ||
| } | ||
|
|
||
| // NewNoOpRetryer creates a new Retryer that does not retry. | ||
| // This is useful for testing. | ||
| func NewNoOpRetryer() *Retryer { | ||
|
There was a problem hiding this comment. this is useful for testing. using this retryer should be the same functionality as we have today. |
||
| b := retry.NewConstant(1 * time.Second) | ||
| b = retry.WithMaxRetries(0, b) | ||
|
|
||
| return NewRetryer(&RetryConfig{ | ||
| BackoffStrategy: b, | ||
| }) | ||
| } | ||
|
|
||
| // DefaultBackoffStrategy returns the default backoff strategy. | ||
| // The default backoff strategy is an exponential backoff with a maximum duration and maximum retries. | ||
| func DefaultBackoffStrategy() retry.Backoff { | ||
| b := retry.NewExponential(1 * time.Second) | ||
| b = retry.WithMaxDuration(defaultMaxDuration, b) | ||
| b = retry.WithMaxRetries(defaultMaxRetries, b) | ||
|
|
||
| return b | ||
| } | ||
|
|
||
| // NewDefaultRetryer creates a new Retryer with the default configuration. | ||
| // The default configuration is an exponential backoff with a maximum duration and maximum retries. | ||
| func NewDefaultRetryer() *Retryer { | ||
| return NewRetryer(&RetryConfig{ | ||
| BackoffStrategy: DefaultBackoffStrategy(), | ||
| }) | ||
| } | ||
|
|
||
| // NewRetryer creates a new Retryer with the given configuration. | ||
| // If either the config or config.BackoffStrategy are nil, | ||
| // the default configuration is used. | ||
| // The default configuration is an exponential backoff with a maximum duration and maximum retries. | ||
| func NewRetryer(config *RetryConfig) *Retryer { | ||
| retryConfig := &RetryConfig{} | ||
|
|
||
| if config != nil && config.BackoffStrategy != nil { | ||
| retryConfig.BackoffStrategy = config.BackoffStrategy | ||
| } else { | ||
| retryConfig.BackoffStrategy = DefaultBackoffStrategy() | ||
| } | ||
|
|
||
| return &Retryer{ | ||
| config: retryConfig, | ||
|
There was a problem hiding this comment. Can retryConfig ever be just empty? Like config is not nil but config.BackOffStrategy is? There was a problem hiding this comment. good find - I changed the code to not allow this case. now the retryer will use the default configuration in this case. I also added a test |
||
| } | ||
| } | ||
|
|
||
| // RetryFunc retries the given function with the backoff strategy. | ||
| func (r *Retryer) RetryFunc(ctx context.Context, f func(ctx context.Context) error) error { | ||
| return retry.Do(ctx, r.config.BackoffStrategy, f) | ||
| } | ||
|
|
||
| // RetryableError marks an error as retryable. | ||
| func RetryableError(err error) error { | ||
| return retry.RetryableError(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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| package retry | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
| "time" | ||
|
|
||
| goretry "github.com/sethvargo/go-retry" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestNewNoOpRetryer(t *testing.T) { | ||
| retryer := NewNoOpRetryer() | ||
| require.NotNil(t, retryer) | ||
| require.NotNil(t, retryer.config) | ||
| require.NotNil(t, retryer.config.BackoffStrategy) | ||
|
|
||
| expectedBackoffStrategy := goretry.NewConstant(time.Second * 1) | ||
| expectedBackoffStrategy = goretry.WithMaxRetries(0, expectedBackoffStrategy) | ||
|
|
||
| require.IsType(t, expectedBackoffStrategy, retryer.config.BackoffStrategy) | ||
| } | ||
|
|
||
| func TestDefaultBackoffStrategy(t *testing.T) { | ||
| backoff := DefaultBackoffStrategy() | ||
| require.NotNil(t, backoff) | ||
| } | ||
|
|
||
| func TestNewDefaultRetryer(t *testing.T) { | ||
| retryer := NewDefaultRetryer() | ||
| require.NotNil(t, retryer) | ||
| require.NotNil(t, retryer.config) | ||
| require.NotNil(t, retryer.config.BackoffStrategy) | ||
|
|
||
| expectedBackoffStrategy := goretry.NewConstant(time.Second * 1) | ||
| expectedBackoffStrategy = goretry.WithMaxRetries(0, expectedBackoffStrategy) | ||
|
|
||
| require.IsType(t, expectedBackoffStrategy, retryer.config.BackoffStrategy) | ||
| } | ||
|
|
||
| func TestNewRetryer(t *testing.T) { | ||
| config := &RetryConfig{ | ||
| BackoffStrategy: goretry.NewConstant(1 * time.Second), | ||
| } | ||
|
Comment on lines
+42
to
+45
There was a problem hiding this comment. We can test this with a RetryConfig that has a nil BackOffStrategy. |
||
| retryer := NewRetryer(config) | ||
| require.NotNil(t, retryer) | ||
| require.NotNil(t, retryer.config) | ||
|
|
||
| retryer = NewRetryer(nil) | ||
| require.NotNil(t, retryer) | ||
| require.NotNil(t, retryer.config) | ||
| require.NotNil(t, retryer.config.BackoffStrategy) | ||
|
|
||
| config = &RetryConfig{} | ||
| retryer = NewRetryer(config) | ||
| require.NotNil(t, retryer) | ||
| require.NotNil(t, retryer.config) | ||
| require.NotNil(t, retryer.config.BackoffStrategy) | ||
| } | ||
|
|
||
| func TestRetryer_RetryFunc(t *testing.T) { | ||
| retryer := NewDefaultRetryer() | ||
| ctx := context.Background() | ||
|
|
||
| // Test successful function | ||
| err := retryer.RetryFunc(ctx, func(ctx context.Context) error { | ||
| return nil | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| // Test retryable error | ||
| retryCount := 0 | ||
| err = retryer.RetryFunc(ctx, func(ctx context.Context) error { | ||
| retryCount++ | ||
| if retryCount < 3 { | ||
| return RetryableError(errors.New("retryable error")) | ||
| } | ||
| return nil | ||
| }) | ||
| require.NoError(t, err) | ||
| require.Equal(t, 3, retryCount) | ||
|
|
||
| // Test non-retryable error | ||
| err = retryer.RetryFunc(ctx, func(ctx context.Context) error { | ||
| return errors.New("non-retryable error") | ||
| }) | ||
| require.Error(t, 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
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
Oops, something went wrong.
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.
I added this package to simplify our retry logic across the project. Looks like it is well tested with no dependencies so I think it is a good choice. Let's discuss in this PR
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.
Last commit seems to be from 6 months ago. Just wondering if that could be an issue.
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.
I think it should be okay. The code is straightforward and has no dependencies, so hopefully there shouldn't need to be too many new commits.