feat(storage): add maxAttempts RetryOption

storage/bucket_test.go

@@ -1071,6 +1071,7 @@ func TestBucketRetryer(t *testing.T) {
 						Multiplier: 3,
 					}),
 					WithPolicy(RetryAlways),
+					WithMaxRetry(5),
 					WithErrorFunc(func(err error) bool { return false }))
 			},
 			want: &retryConfig{
@@ -1079,8 +1080,9 @@ func TestBucketRetryer(t *testing.T) {
 					Max:        30 * time.Second,
 					Multiplier: 3,
 				},
-				policy:      RetryAlways,
-				shouldRetry: func(err error) bool { return false },
+				policy:        RetryAlways,
+				maxRetryCount: 5,
+				shouldRetry:   func(err error) bool { return false },
 			},
 		},
 		{
@@ -1105,6 +1107,15 @@ func TestBucketRetryer(t *testing.T) {
 				policy: RetryNever,
 			},
 		},
+		{
+			name: "set max retry count only",
+			call: func(b *BucketHandle) *BucketHandle {
+				return b.Retryer(WithMaxRetry(5))
+			},
+			want: &retryConfig{
+				maxRetryCount: 5,
+			},
+		},
 		{
 			name: "set ErrorFunc only",
 			call: func(b *BucketHandle) *BucketHandle {

storage/invoke.go

@@ -71,6 +71,9 @@ func run(ctx context.Context, call func(ctx context.Context) error, retry *retry
 		ctxWithHeaders := setInvocationHeaders(ctx, invocationID, attempts)
 		err = call(ctxWithHeaders)
 		attempts++
+		if attempts == retry.maxRetryCount {
+			return true, err
+		}
 		return !errorFunc(err), err
 	})
 }

storage/storage.go

@@ -2076,6 +2076,21 @@ func (wb *withBackoff) apply(config *retryConfig) {
 	config.backoff = &wb.backoff
 }
 
+// WithMaxRetry sets the maximum number of retries for operations that may fail.
+func WithMaxRetry(maxRetryCount int) RetryOption {
+	return &withMaxRetry{
+		maxRetryCount: maxRetryCount,
+	}
+}
+
+type withMaxRetry struct {
+	maxRetryCount int
+}
+
+func (wb *withMaxRetry) apply(config *retryConfig) {
+	config.maxRetryCount = wb.maxRetryCount
+}
+
 // RetryPolicy describes the available policies for which operations should be
 // retried. The default is `RetryIdempotent`.
 type RetryPolicy int
@@ -2145,9 +2160,10 @@ func (wef *withErrorFunc) apply(config *retryConfig) {
 }
 
 type retryConfig struct {
-	backoff     *gax.Backoff
-	policy      RetryPolicy
-	shouldRetry func(err error) bool
+	backoff       *gax.Backoff
+	policy        RetryPolicy
+	shouldRetry   func(err error) bool
+	maxRetryCount int
 }
 
 func (r *retryConfig) clone() *retryConfig {
@@ -2165,9 +2181,10 @@ func (r *retryConfig) clone() *retryConfig {
 	}
 
 	return &retryConfig{
-		backoff:     bo,
-		policy:      r.policy,
-		shouldRetry: r.shouldRetry,
+		backoff:       bo,
+		policy:        r.policy,
+		shouldRetry:   r.shouldRetry,
+		maxRetryCount: r.maxRetryCount,
 	}
 }
 

storage/storage_test.go

@@ -977,6 +977,7 @@ func TestObjectRetryer(t *testing.T) {
 						Max:        30 * time.Second,
 						Multiplier: 3,
 					}),
+					WithMaxRetry(5),
 					WithPolicy(RetryAlways),
 					WithErrorFunc(func(err error) bool { return false }))
 			},
@@ -986,8 +987,9 @@ func TestObjectRetryer(t *testing.T) {
 					Max:        30 * time.Second,
 					Multiplier: 3,
 				},
-				policy:      RetryAlways,
-				shouldRetry: func(err error) bool { return false },
+				maxRetryCount: 5,
+				policy:        RetryAlways,
+				shouldRetry:   func(err error) bool { return false },
 			},
 		},
 		{
@@ -1012,6 +1014,15 @@ func TestObjectRetryer(t *testing.T) {
 				policy: RetryNever,
 			},
 		},
+		{
+			name: "set max retry count only",
+			call: func(o *ObjectHandle) *ObjectHandle {
+				return o.Retryer(WithMaxRetry(11))
+			},
+			want: &retryConfig{
+				maxRetryCount: 11,
+			},
+		},
 		{
 			name: "set ErrorFunc only",
 			call: func(o *ObjectHandle) *ObjectHandle {
@@ -1063,6 +1074,7 @@ func TestClientSetRetry(t *testing.T) {
 					Max:        30 * time.Second,
 					Multiplier: 3,
 				}),
+				WithMaxRetry(5),
 				WithPolicy(RetryAlways),
 				WithErrorFunc(func(err error) bool { return false }),
 			},
@@ -1072,8 +1084,9 @@ func TestClientSetRetry(t *testing.T) {
 					Max:        30 * time.Second,
 					Multiplier: 3,
 				},
-				policy:      RetryAlways,
-				shouldRetry: func(err error) bool { return false },
+				maxRetryCount: 5,
+				policy:        RetryAlways,
+				shouldRetry:   func(err error) bool { return false },
 			},
 		},
 		{
@@ -1097,6 +1110,15 @@ func TestClientSetRetry(t *testing.T) {
 				policy: RetryNever,
 			},
 		},
+		{
+			name: "set max retry count only",
+			clientOptions: []RetryOption{
+				WithMaxRetry(7),
+			},
+			want: &retryConfig{
+				maxRetryCount: 7,
+			},
+		},
 		{
 			name: "set ErrorFunc only",
 			clientOptions: []RetryOption{
@@ -1150,11 +1172,13 @@ func TestRetryer(t *testing.T) {
 			name: "object retryer configures retry",
 			objectOptions: []RetryOption{
 				WithPolicy(RetryAlways),
+				WithMaxRetry(5),
 				WithErrorFunc(ShouldRetry),
 			},
 			want: &retryConfig{
-				shouldRetry: ShouldRetry,
-				policy:      RetryAlways,
+				shouldRetry:   ShouldRetry,
+				maxRetryCount: 5,
+				policy:        RetryAlways,
 			},
 		},
 		{
@@ -1166,6 +1190,7 @@ func TestRetryer(t *testing.T) {
 					Multiplier: 6,
 				}),
 				WithPolicy(RetryAlways),
+				WithMaxRetry(11),
 				WithErrorFunc(ShouldRetry),
 			},
 			want: &retryConfig{
@@ -1174,8 +1199,9 @@ func TestRetryer(t *testing.T) {
 					Max:        time.Hour,
 					Multiplier: 6,
 				},
-				shouldRetry: ShouldRetry,
-				policy:      RetryAlways,
+				shouldRetry:   ShouldRetry,
+				maxRetryCount: 11,
+				policy:        RetryAlways,
 			},
 		},
 		{
@@ -1187,6 +1213,7 @@ func TestRetryer(t *testing.T) {
 					Multiplier: 6,
 				}),
 				WithPolicy(RetryAlways),
+				WithMaxRetry(7),
 				WithErrorFunc(ShouldRetry),
 			},
 			want: &retryConfig{
@@ -1195,8 +1222,9 @@ func TestRetryer(t *testing.T) {
 					Max:        time.Hour,
 					Multiplier: 6,
 				},
-				shouldRetry: ShouldRetry,
-				policy:      RetryAlways,
+				shouldRetry:   ShouldRetry,
+				maxRetryCount: 7,
+				policy:        RetryAlways,
 			},
 		},
 		{
@@ -1206,11 +1234,13 @@ func TestRetryer(t *testing.T) {
 			},
 			objectOptions: []RetryOption{
 				WithPolicy(RetryNever),
+				WithMaxRetry(5),
 				WithErrorFunc(ShouldRetry),
 			},
 			want: &retryConfig{
-				policy:      RetryNever,
-				shouldRetry: ShouldRetry,
+				policy:        RetryNever,
+				maxRetryCount: 5,
+				shouldRetry:   ShouldRetry,
 			},
 		},
 		{
@@ -1220,11 +1250,13 @@ func TestRetryer(t *testing.T) {
 			},
 			objectOptions: []RetryOption{
 				WithPolicy(RetryNever),
+				WithMaxRetry(11),
 				WithErrorFunc(ShouldRetry),
 			},
 			want: &retryConfig{
-				policy:      RetryNever,
-				shouldRetry: ShouldRetry,
+				policy:        RetryNever,
+				maxRetryCount: 11,
+				shouldRetry:   ShouldRetry,
 			},
 		},
 		{
@@ -1243,10 +1275,12 @@ func TestRetryer(t *testing.T) {
 					Max:     time.Microsecond,
 				}),
 				WithErrorFunc(ShouldRetry),
+				WithMaxRetry(5),
 			},
 			want: &retryConfig{
-				policy:      RetryAlways,
-				shouldRetry: ShouldRetry,
+				policy:        RetryAlways,
+				maxRetryCount: 5,
+				shouldRetry:   ShouldRetry,
 				backoff: &gax.Backoff{
 					Initial: time.Nanosecond,
 					Max:     time.Microsecond,
@@ -1280,6 +1314,7 @@ func TestRetryer(t *testing.T) {
 			bucketOptions: []RetryOption{
 				WithPolicy(RetryNever),
 				WithErrorFunc(ShouldRetry),
+				WithMaxRetry(5),
 			},
 			objectOptions: []RetryOption{
 				WithBackoff(gax.Backoff{
@@ -1288,8 +1323,9 @@ func TestRetryer(t *testing.T) {
 				}),
 			},
 			want: &retryConfig{
-				policy:      RetryNever,
-				shouldRetry: ShouldRetry,
+				policy:        RetryNever,
+				maxRetryCount: 5,
+				shouldRetry:   ShouldRetry,
 				backoff: &gax.Backoff{
 					Initial: time.Nanosecond,
 					Max:     time.Second,