From a695ca7e597eccfa2f191dae493506f5c04b74f5 Mon Sep 17 00:00:00 2001
From: Ravi Atluri <ravi.atluri@gojek.com>
Date: Tue, 16 Jul 2024 09:25:24 +0530
Subject: [PATCH] chore: Update retry middleware to set MaxDuration below kafka
 consumer config

---
 xkafka/middleware/retry/example_test.go | 3 ++-
 xkafka/middleware/retry/retry.go        | 8 +++++---
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/xkafka/middleware/retry/example_test.go b/xkafka/middleware/retry/example_test.go
index 8c76a59..4e0b7b9 100644
--- a/xkafka/middleware/retry/example_test.go
+++ b/xkafka/middleware/retry/example_test.go
@@ -33,7 +33,8 @@ func Example() {
 
 	consumer.Use(
 		retry.ExponentialBackoff(
-			retry.MaxRetries(3),                // retry 3 times
+			retry.MaxRetries(3), // retry 3 times
+			// MaxDuration should be less than `max.poll.interval.ms` kafka consumer config
 			retry.MaxDuration(10*time.Second),  // don't retry after 10 seconds
 			retry.Delay(1*time.Second),         // initial delay
 			retry.Jitter(100*time.Millisecond), // random delay to avoid thundering herd
diff --git a/xkafka/middleware/retry/retry.go b/xkafka/middleware/retry/retry.go
index ed7cca7..966ee56 100644
--- a/xkafka/middleware/retry/retry.go
+++ b/xkafka/middleware/retry/retry.go
@@ -28,6 +28,7 @@ type MaxRetries int
 func (m MaxRetries) apply(c *config) { c.maxRetries = int(m) }
 
 // MaxDuration sets the maximum retry duration since the first execution.
+// It should be less than `max.poll.interval.ms` kafka consumer config.
 type MaxDuration time.Duration
 
 func (m MaxDuration) apply(c *config) { c.maxDuration = time.Duration(m) }
@@ -57,8 +58,9 @@ type config struct {
 
 func newConfig(opts ...Option) *config {
 	c := &config{
-		maxRetries:  100,
-		maxDuration: time.Hour,
+		maxRetries: 100,
+		// less than 5 minutes default max.poll.interval.ms
+		maxDuration: 299 * time.Second,
 		delay:       200 * time.Millisecond,
 		jitter:      20 * time.Millisecond,
 		multiplier:  1.5,
@@ -76,7 +78,7 @@ func newConfig(opts ...Option) *config {
 // lifetime is reached.
 // Default values:
 // - MaxRetries: 100
-// - MaxDuration: 1 hour
+// - MaxDuration: 5 minutes
 // - Delay: 200 milliseconds
 // - Jitter: 20 milliseconds
 // - Multiplier: 1.5