From ea41c06e2db91ee09fee372f44588c11b819e147 Mon Sep 17 00:00:00 2001
From: Justin Ricks <justin.rixx@gmail.com>
Date: Sat, 2 Mar 2024 09:26:48 -0700
Subject: [PATCH] Use math/rand global random source and deprecate PRNG global
 variable

---
 rehttp.go              | 24 +++++++++++++++++++-----
 rehttp_delayfn_test.go | 11 +++++++++++
 2 files changed, 30 insertions(+), 5 deletions(-)

diff --git a/rehttp.go b/rehttp.go
index 3b9f6b4..8ad2950 100644
--- a/rehttp.go
+++ b/rehttp.go
@@ -64,6 +64,11 @@ import (
 // PRNG is the *math.Rand value to use to add jitter to the backoff
 // algorithm used in ExpJitterDelay. By default it uses a *rand.Rand
 // initialized with a source based on the current time in nanoseconds.
+//
+// Deprecated: math/rand sources can panic if used concurrently without
+// synchronization. PRNG is no longer used by this package and its use
+// outside this package is discouraged.
+// https://github.com/PuerkitoBio/rehttp/issues/12
 var PRNG = rand.New(rand.NewSource(time.Now().UnixNano()))
 
 // terribly named interface to detect errors that support Temporary.
@@ -253,18 +258,27 @@ func ConstDelay(delay time.Duration) DelayFn {
 	}
 }
 
-// ExpJitterDelay returns a DelayFn that returns a delay between 0 and
-// base * 2^attempt capped at max (an exponential backoff delay with
-// jitter).
+// ExpJitterDelay is identical to [ExpJitterDelayWithRand], using
+// math/rand.Int63n as the random generator function.
+// This package does not call [rand.Seed], so it is the caller's
+// responsibility to ensure the default generator is properly seeded.
+func ExpJitterDelay(base, max time.Duration) DelayFn {
+	return ExpJitterDelayWithRand(base, max, rand.Int63n)
+}
+
+// ExpJitterDelayWithRand returns a DelayFn that returns a delay
+// between 0 and base * 2^attempt capped at max (an exponential
+// backoff delay with jitter). The generator argument is expected
+// to generate a random int64 in the half open interval [0, n).
 //
 // See the full jitter algorithm in:
 // http://www.awsarchitectureblog.com/2015/03/backoff.html
-func ExpJitterDelay(base, max time.Duration) DelayFn {
+func ExpJitterDelayWithRand(base, max time.Duration, generator func(n int64) int64) DelayFn {
 	return func(attempt Attempt) time.Duration {
 		exp := math.Pow(2, float64(attempt.Index))
 		top := float64(base) * exp
 		return time.Duration(
-			PRNG.Int63n(int64(math.Min(float64(max), top))),
+			generator(int64(math.Min(float64(max), top))),
 		)
 	}
 }
diff --git a/rehttp_delayfn_test.go b/rehttp_delayfn_test.go
index bebc4c8..1f3c1e4 100644
--- a/rehttp_delayfn_test.go
+++ b/rehttp_delayfn_test.go
@@ -27,3 +27,14 @@ func TestExpJitterDelay(t *testing.T) {
 		assert.True(t, delay <= actual, "%d: %s > %s", i, delay, actual)
 	}
 }
+
+func TestExpJitterDelayWithRand(t *testing.T) {
+	fn := ExpJitterDelayWithRand(time.Second, 5*time.Second, func(n int64) int64 { return 999_999_999 % n })
+	for i := 0; i < 10; i++ {
+		delay := fn(Attempt{Index: i})
+		top := math.Pow(2, float64(i)) * float64(time.Second)
+		actual := time.Duration(math.Min(float64(5*time.Second), top))
+		assert.True(t, delay > 0, "%d: %s <= 0", i, delay)
+		assert.True(t, delay <= actual, "%d: %s > %s", i, delay, actual)
+	}
+}