Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Allow customizing of AWS retry codes #295

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Allow customizing of AWS retry codes #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions aws_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,18 @@ func resolveRetryer(ctx context.Context, awsConfig *aws.Config) {
})
}

var r aws.Retryer = &networkErrorShortcutter{
RetryerV2: retry.NewStandard(standardOptions...),
}

// Add additional retry codes
if retryCodes := os.Getenv("AWS_RETRY_CODES"); retryCodes != "" {
codes := strings.Split(retryCodes, ",")
r = retry.AddWithErrorCodes(r, codes...)
}

awsConfig.Retryer = func() aws.Retryer {
return &networkErrorShortcutter{
RetryerV2: retry.NewStandard(standardOptions...),
}
return r
}
}

Expand Down
88 changes: 88 additions & 0 deletions aws_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"github.com/aws/aws-sdk-go-v2/config"
"github.com/aws/aws-sdk-go-v2/feature/ec2/imds"
"github.com/aws/aws-sdk-go-v2/service/sts"
"github.com/aws/smithy-go"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"github.com/google/go-cmp/cmp"
Expand Down Expand Up @@ -1649,6 +1650,93 @@ max_attempts = 10
}
}

func TestRetryCodes(t *testing.T) {
testCases := map[string]struct {
Config *Config
EnvironmentVariables map[string]string
ExpectedRetryableErrors []smithy.APIError
ExpectedNonRetryableErrors []smithy.APIError
}{
"no configuration": {
Config: &Config{
AccessKey: servicemocks.MockStaticAccessKey,
SecretKey: servicemocks.MockStaticSecretKey,
},
ExpectedNonRetryableErrors: []smithy.APIError{
&smithy.GenericAPIError{Code: "error 1"},
},
},

"AWS_RETRY_CODES single": {
Config: &Config{
AccessKey: servicemocks.MockStaticAccessKey,
SecretKey: servicemocks.MockStaticSecretKey,
},
EnvironmentVariables: map[string]string{
"AWS_RETRY_CODES": "error 1",
},
ExpectedRetryableErrors: []smithy.APIError{
&smithy.GenericAPIError{Code: "error 1"},
},
ExpectedNonRetryableErrors: []smithy.APIError{
&smithy.GenericAPIError{Code: "error 2"},
},
},

"AWS_RETRY_CODES multiple": {
Config: &Config{
AccessKey: servicemocks.MockStaticAccessKey,
SecretKey: servicemocks.MockStaticSecretKey,
},
EnvironmentVariables: map[string]string{
"AWS_RETRY_CODES": "error 1,error 2",
},
ExpectedRetryableErrors: []smithy.APIError{
&smithy.GenericAPIError{Code: "error 1"},
&smithy.GenericAPIError{Code: "error 2"},
},
ExpectedNonRetryableErrors: []smithy.APIError{
&smithy.GenericAPIError{Code: "error 3"},
},
},
}

for testName, testCase := range testCases {
testCase := testCase

t.Run(testName, func(t *testing.T) {
oldEnv := servicemocks.InitSessionTestEnv()
defer servicemocks.PopEnv(oldEnv)

for k, v := range testCase.EnvironmentVariables {
os.Setenv(k, v)
}

testCase.Config.SkipCredsValidation = true

awsConfig, err := GetAwsConfig(context.Background(), testCase.Config)
if err != nil {
t.Fatalf("error in GetAwsConfig() '%[1]T': %[1]s", err)
}

retryer := awsConfig.Retryer()
if retryer == nil {
t.Fatal("no retryer set")
}
for _, e := range testCase.ExpectedRetryableErrors {
if a := retryer.IsErrorRetryable(e); !a {
t.Errorf(`expected error %q would be retryable, got not retryable`, e)
}
}
for _, e := range testCase.ExpectedNonRetryableErrors {
if a := retryer.IsErrorRetryable(e); a {
t.Errorf(`expected error %q would not be retryable, got retryable`, e)
}
}
})
}
}

func TestServiceEndpointTypes(t *testing.T) {
testCases := map[string]struct {
Config *Config
Expand Down
13 changes: 13 additions & 0 deletions v2/awsv1shim/session.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import ( // nosemgrep: no-sdkv2-imports-in-awsv1shim
"fmt"
"log"
"os"
"strings"

awsv2 "github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go/aws"
Expand Down Expand Up @@ -89,6 +90,18 @@ func GetSession(awsC *awsv2.Config, c *awsbase.Config) (*session.Session, error)
sess = sess.Copy(&aws.Config{MaxRetries: aws.Int(retryer.MaxAttempts())})
}

// Add custom error code retries. It's easier to recheck the environment variable
// here as the retry codes aren't available from the original v2 config
if retryCodes := os.Getenv("AWS_RETRY_CODES"); retryCodes != "" {
codes := strings.Split(retryCodes, ",")
log.Printf("[DEBUG] Using additional retry codes: %s", codes)
sess.Handlers.Retry.PushBack(func(r *request.Request) {
if tfawserr.ErrCodeEquals(r.Error, codes...) {
r.Retryable = aws.Bool(true)
}
})
}

SetSessionUserAgent(sess, c.APNInfo, c.UserAgent)

// Add custom input from ENV to the User-Agent request header
Expand Down
95 changes: 95 additions & 0 deletions v2/awsv1shim/session_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1470,6 +1470,101 @@ max_attempts = 10
}
}

func TestRetryCodes(t *testing.T) {
testCases := map[string]struct {
Config *awsbase.Config
EnvironmentVariables map[string]string
ExpectedRetryableErrors []awserr.Error
ExpectedNonRetryableErrors []awserr.Error
}{
"no configuration": {
Config: &awsbase.Config{
AccessKey: servicemocks.MockStaticAccessKey,
SecretKey: servicemocks.MockStaticSecretKey,
},
ExpectedNonRetryableErrors: []awserr.Error{
awserr.New("error 1", "", nil),
},
},

"AWS_RETRY_CODES single": {
Config: &awsbase.Config{
AccessKey: servicemocks.MockStaticAccessKey,
SecretKey: servicemocks.MockStaticSecretKey,
},
EnvironmentVariables: map[string]string{
"AWS_RETRY_CODES": "error 1",
},
ExpectedRetryableErrors: []awserr.Error{
awserr.New("error 1", "", nil),
},
ExpectedNonRetryableErrors: []awserr.Error{
awserr.New("error 2", "", nil),
},
},

"AWS_RETRY_CODES multiple": {
Config: &awsbase.Config{
AccessKey: servicemocks.MockStaticAccessKey,
SecretKey: servicemocks.MockStaticSecretKey,
},
EnvironmentVariables: map[string]string{
"AWS_RETRY_CODES": "error 1,error 2",
},
ExpectedRetryableErrors: []awserr.Error{
awserr.New("error 1", "", nil),
awserr.New("error 2", "", nil),
},
ExpectedNonRetryableErrors: []awserr.Error{
awserr.New("error 3", "", nil),
},
},
}

for testName, testCase := range testCases {
testCase := testCase

t.Run(testName, func(t *testing.T) {
oldEnv := servicemocks.InitSessionTestEnv()
defer servicemocks.PopEnv(oldEnv)

for k, v := range testCase.EnvironmentVariables {
os.Setenv(k, v)
}

testCase.Config.SkipCredsValidation = true

awsConfig, err := awsbase.GetAwsConfig(context.Background(), testCase.Config)
if err != nil {
t.Fatalf("GetAwsConfig() returned error: %s", err)
}
actualSession, err := GetSession(&awsConfig, testCase.Config)
if err != nil {
t.Fatalf("error in GetSession() '%[1]T': %[1]s", err)
}

for _, e := range testCase.ExpectedRetryableErrors {
r := &request.Request{
Error: e,
}
actualSession.Handlers.Retry.Run(r)
if !aws.BoolValue(r.Retryable) {
t.Errorf(`expected error %q would be retryable, got not retryable`, e)
}
}
for _, e := range testCase.ExpectedNonRetryableErrors {
r := &request.Request{
Error: e,
}
actualSession.Handlers.Retry.Run(r)
if aws.BoolValue(r.Retryable) {
t.Errorf(`expected error %q would not be retryable, got retryable`, e)
}
}
})
}
}

func TestServiceEndpointTypes(t *testing.T) {
testCases := map[string]struct {
Config *awsbase.Config
Expand Down