Merge pull request #16 from borgstrom/concurrent

Make Duration safe for concurrent use
This commit is contained in:
Jaime Pillora 2019-10-03 22:55:55 +10:00 committed by GitHub
commit 6fb1b8a52b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 8 deletions

View File

@ -4,6 +4,7 @@ package backoff
import ( import (
"math" "math"
"math/rand" "math/rand"
"sync/atomic"
"time" "time"
) )
@ -14,19 +15,19 @@ import (
// Backoff is not generally concurrent-safe, but the ForAttempt method can // Backoff is not generally concurrent-safe, but the ForAttempt method can
// be used concurrently. // be used concurrently.
type Backoff struct { type Backoff struct {
//Factor is the multiplying factor for each increment step attempt uint64
attempt, Factor float64 // Factor is the multiplying factor for each increment step
//Jitter eases contention by randomizing backoff steps Factor float64
// Jitter eases contention by randomizing backoff steps
Jitter bool Jitter bool
//Min and Max are the minimum and maximum values of the counter // Min and Max are the minimum and maximum values of the counter
Min, Max time.Duration Min, Max time.Duration
} }
// Duration returns the duration for the current attempt before incrementing // Duration returns the duration for the current attempt before incrementing
// the attempt counter. See ForAttempt. // the attempt counter. See ForAttempt.
func (b *Backoff) Duration() time.Duration { func (b *Backoff) Duration() time.Duration {
d := b.ForAttempt(b.attempt) d := b.ForAttempt(float64(atomic.AddUint64(&b.attempt, 1) - 1))
b.attempt++
return d return d
} }
@ -80,12 +81,12 @@ func (b *Backoff) ForAttempt(attempt float64) time.Duration {
// Reset restarts the current attempt counter at zero. // Reset restarts the current attempt counter at zero.
func (b *Backoff) Reset() { func (b *Backoff) Reset() {
b.attempt = 0 atomic.StoreUint64(&b.attempt, 0)
} }
// Attempt returns the current attempt counter value. // Attempt returns the current attempt counter value.
func (b *Backoff) Attempt() float64 { func (b *Backoff) Attempt() float64 {
return b.attempt return float64(atomic.LoadUint64(&b.attempt))
} }
// Copy returns a backoff with equals constraints as the original // Copy returns a backoff with equals constraints as the original

View File

@ -2,6 +2,7 @@ package backoff
import ( import (
"reflect" "reflect"
"sync"
"testing" "testing"
"time" "time"
) )
@ -120,7 +121,28 @@ func TestCopy(t *testing.T) {
equals(t, b, b2) equals(t, b, b2)
} }
func TestConcurrent(t *testing.T) {
b := &Backoff{
Min: 100 * time.Millisecond,
Max: 10 * time.Second,
Factor: 2,
}
wg := &sync.WaitGroup{}
test := func() {
time.Sleep(b.Duration())
wg.Done()
}
wg.Add(2)
go test()
go test()
wg.Wait()
}
func between(t *testing.T, actual, low, high time.Duration) { func between(t *testing.T, actual, low, high time.Duration) {
t.Helper()
if actual < low { if actual < low {
t.Fatalf("Got %s, Expecting >= %s", actual, low) t.Fatalf("Got %s, Expecting >= %s", actual, low)
} }
@ -130,6 +152,7 @@ func between(t *testing.T, actual, low, high time.Duration) {
} }
func equals(t *testing.T, v1, v2 interface{}) { func equals(t *testing.T, v1, v2 interface{}) {
t.Helper()
if !reflect.DeepEqual(v1, v2) { if !reflect.DeepEqual(v1, v2) {
t.Fatalf("Got %v, Expecting %v", v1, v2) t.Fatalf("Got %v, Expecting %v", v1, v2)
} }