Generalize retry code #380
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
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,113 @@ | ||
| package retry | ||
|
|
||
| import ( | ||
| "context" | ||
| "math" | ||
| "time" | ||
|
|
||
| v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2" | ||
| "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap" | ||
| "go.opentelemetry.io/otel" | ||
| "go.uber.org/zap" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| ) | ||
|
|
||
| var tracer = otel.Tracer("baton-sdk/retry") | ||
|
|
||
| type Retryer struct { | ||
| attempts uint | ||
| maxAttempts uint | ||
| initialDelay time.Duration | ||
| maxDelay time.Duration | ||
| } | ||
|
|
||
| type RetryConfig struct { | ||
| MaxAttempts uint // 0 means no limit (which is also the default). | ||
| InitialDelay time.Duration // Default is 1 second. | ||
| MaxDelay time.Duration // Default is 60 seconds. 0 means no limit. | ||
| } | ||
|
|
||
| func NewRetryer(ctx context.Context, config RetryConfig) *Retryer { | ||
| r := &Retryer{ | ||
| attempts: 0, | ||
| maxAttempts: config.MaxAttempts, | ||
| initialDelay: config.InitialDelay, | ||
| maxDelay: config.MaxDelay, | ||
| } | ||
| if r.initialDelay == 0 { | ||
| r.initialDelay = time.Second | ||
| } | ||
| if r.maxDelay == 0 { | ||
| r.maxDelay = 60 * time.Second | ||
| } | ||
| return r | ||
| } | ||
|
|
||
| func (r *Retryer) ShouldWaitAndRetry(ctx context.Context, err error) bool { | ||
| ctx, span := tracer.Start(ctx, "retry.ShouldWaitAndRetry") | ||
| defer span.End() | ||
|
|
||
| if err == nil { | ||
| r.attempts = 0 | ||
| return true | ||
| } | ||
| if status.Code(err) != codes.Unavailable && status.Code(err) != codes.DeadlineExceeded { | ||
| return false | ||
| } | ||
|
Comment on lines
+55
to
+57
There was a problem hiding this comment. 💡 Verification agent 🧩 Analysis chainConsider handling additional recoverable gRPC codes (e.g. Only - if status.Code(err) != codes.Unavailable && status.Code(err) != codes.DeadlineExceeded {
+ switch status.Code(err) {
+ case codes.Unavailable, codes.DeadlineExceeded, codes.ResourceExhausted, codes.Internal:
+ // retryable
+ default:
return false
- }
+ }🏁 Script executed: #!/bin/bash
# Locate retry.go and display the relevant retry logic context
file=$(fd --exact-name retry.go)
echo "Found file: $file"
sed -n '40,80p' "$file"Length of output: 345 🏁 Script executed: #!/bin/bash
# Locate retry.go using find
file=$(find . -type f -name "retry.go" | head -n1)
if [ -z "$file" ]; then
echo "retry.go not found"
exit 1
fi
echo "Found file: $file"
# Show lines around the retry condition (lines 40–80)
sed -n '40,80p' "$file"Length of output: 1269 Enhance retry logic to include additional transient gRPC codes Currently only Suggested change in - if status.Code(err) != codes.Unavailable && status.Code(err) != codes.DeadlineExceeded {
- return false
- }
+ switch status.Code(err) {
+ case codes.Unavailable,
+ codes.DeadlineExceeded,
+ codes.ResourceExhausted,
+ codes.Internal:
+ // retryable
+ default:
+ return false
+ }This ensures you’ll back off and retry on throttling ( |
||
|
|
||
| r.attempts++ | ||
| l := ctxzap.Extract(ctx) | ||
|
|
||
| if r.maxAttempts > 0 && r.attempts > r.maxAttempts { | ||
| l.Warn("max attempts reached", zap.Error(err), zap.Uint("max_attempts", r.maxAttempts)) | ||
| return false | ||
| } | ||
|
|
||
| // use linear backoff by default | ||
| var wait time.Duration | ||
| if r.attempts > math.MaxInt64 { | ||
|
Contributor
Author
There was a problem hiding this comment. It was to get the linter to shut up. |
||
| wait = r.maxDelay | ||
| } else { | ||
| wait = time.Duration(int64(r.attempts)) * r.initialDelay | ||
| } | ||
|
|
||
| // If error contains rate limit data, use that instead | ||
| if st, ok := status.FromError(err); ok { | ||
| details := st.Details() | ||
| for _, detail := range details { | ||
| if rlData, ok := detail.(*v2.RateLimitDescription); ok { | ||
| waitResetAt := time.Until(rlData.ResetAt.AsTime()) | ||
| if waitResetAt <= 0 { | ||
| continue | ||
| } | ||
| duration := time.Duration(rlData.Limit) | ||
| if duration <= 0 { | ||
| continue | ||
| } | ||
| waitResetAt /= duration | ||
| // Round up to the nearest second to make sure we don't hit the rate limit again | ||
| waitResetAt = time.Duration(math.Ceil(waitResetAt.Seconds())) * time.Second | ||
| if waitResetAt > 0 { | ||
| wait = waitResetAt | ||
| break | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+75
to
+96
There was a problem hiding this comment. Rate-limit wait calculation appears incorrect.
Please revisit the algorithm; otherwise the retryer may sleep far too short or far too long. |
||
| } | ||
|
|
||
| if wait > r.maxDelay { | ||
| wait = r.maxDelay | ||
| } | ||
|
|
||
| l.Warn("retrying operation", zap.Error(err), zap.Duration("wait", wait)) | ||
|
|
||
| for { | ||
| select { | ||
| case <-time.After(wait): | ||
| return true | ||
| case <-ctx.Done(): | ||
| return false | ||
| } | ||
| } | ||
| } | ||
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,50 @@ | ||
| package retry | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| ) | ||
|
|
||
| func TestBasicRetry(t *testing.T) { | ||
| ctx := context.Background() | ||
| retryer := NewRetryer(ctx, RetryConfig{ | ||
| MaxAttempts: 3, | ||
| InitialDelay: 100 * time.Millisecond, | ||
| MaxDelay: 1 * time.Second, | ||
| }) | ||
|
|
||
| shouldRetry := retryer.ShouldWaitAndRetry(ctx, errors.New("generic unrecoverable error")) | ||
| require.False(t, shouldRetry, "generic unrecoverable error should not be retried") | ||
|
|
||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, status.Error(codes.Unavailable, "recoverable error")) | ||
| require.True(t, shouldRetry, "recoverable error should be retried") | ||
|
|
||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, status.Error(codes.Unknown, "unknown error")) | ||
| require.False(t, shouldRetry, "unknown error should not be retried") | ||
|
|
||
| // This has the side effect of resetting attempts to 0. | ||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, nil) | ||
| require.True(t, shouldRetry, "nil error should be retried") | ||
|
|
||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, status.Error(codes.Unavailable, "first attempt")) | ||
| require.True(t, shouldRetry, "first attempt should be retried") | ||
|
|
||
| startTime := time.Now() | ||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, status.Error(codes.Unavailable, "second attempt")) | ||
| require.True(t, shouldRetry, "second attempt should be retried") | ||
| elapsed := time.Since(startTime) | ||
| require.Greater(t, elapsed, 100*time.Millisecond, "second attempt should take longer than 100ms") | ||
| require.Less(t, elapsed, 300*time.Millisecond, "second attempt should take less than 300ms") | ||
|
|
||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, status.Error(codes.Unavailable, "third attempt")) | ||
| require.True(t, shouldRetry, "third attempt should be retried") | ||
|
|
||
| shouldRetry = retryer.ShouldWaitAndRetry(ctx, status.Error(codes.Unavailable, "fourth attempt")) | ||
| require.False(t, shouldRetry, "fourth attempt should not be retried") | ||
| } |
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.
MaxAttempts should be 2.
The Temporal activity has a timeout of 5 minutes, so the time from start to close shouldn't exceed that limit. c1 ticket would end up in a weird state if we retry 3 times.
For example,
Customers are not aware of the current status of the ticket.
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.
Three retries would wait 30, 60, then 90 seconds, which is 3 minutes total.
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.
Three minutes seems to be the ideal timing. I haven’t looked into the code to see how C1 tickets change status, but based on my testing, three attempts don’t work — the C1 ticket seems to be stuck.
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.