Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove error log pre-allocation and add benchmark #89

Merged
merged 3 commits into from
Aug 3, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 31 additions & 52 deletions retry.go
Original file line number Diff line number Diff line change
Expand Up @@ -117,72 +117,61 @@ func Do(retryableFunc RetryableFunc, opts ...Option) error {
return nil
}

var errorLog Error
if !config.lastErrorOnly {
errorLog = make(Error, config.attempts)
} else {
errorLog = make(Error, 1)
}
errorLog := Error{}

attemptsForError := make(map[error]uint, len(config.attemptsForError))
for err, attempts := range config.attemptsForError {
attemptsForError[err] = attempts
}

lastErrIndex := n
shouldRetry := true
for shouldRetry {
err := retryableFunc()
if err == nil {
return nil
}

if err != nil {
errorLog[lastErrIndex] = unpackUnrecoverable(err)
errorLog = append(errorLog, unpackUnrecoverable(err))

if !config.retryIf(err) {
break
}
if !config.retryIf(err) {
break
}

config.onRetry(n, err)
config.onRetry(n, err)

for errToCheck, attempts := range attemptsForError {
if errors.Is(err, errToCheck) {
attempts--
attemptsForError[errToCheck] = attempts
shouldRetry = shouldRetry && attempts > 0
}
for errToCheck, attempts := range attemptsForError {
if errors.Is(err, errToCheck) {
attempts--
attemptsForError[errToCheck] = attempts
shouldRetry = shouldRetry && attempts > 0
}
}

// if this is last attempt - don't wait
if n == config.attempts-1 {
break
}
// if this is last attempt - don't wait
if n == config.attempts-1 {
break
}

select {
case <-config.timer.After(delay(config, n, err)):
case <-config.context.Done():
if config.lastErrorOnly {
return config.context.Err()
}
n++
errorLog[n] = config.context.Err()
return errorLog[:lenWithoutNil(errorLog)]
select {
case <-config.timer.After(delay(config, n, err)):
case <-config.context.Done():
if config.lastErrorOnly {
return config.context.Err()
}
n++

} else {
return nil
return append(errorLog, config.context.Err())
}

n++
shouldRetry = shouldRetry && n < config.attempts

if !config.lastErrorOnly {
lastErrIndex = n
}
}

if config.lastErrorOnly {
return errorLog[lastErrIndex]
return errorLog.Unwrap()
}
return errorLog[:lenWithoutNil(errorLog)]

return errorLog
}

func newDefaultRetryConfig() *Config {
Expand All @@ -206,7 +195,7 @@ type Error []error
// Error method return string representation of Error
// It is an implementation of error interface
func (e Error) Error() string {
logWithNumber := make([]string, lenWithoutNil(e))
logWithNumber := make([]string, len(e))
for i, l := range e {
if l != nil {
logWithNumber[i] = fmt.Sprintf("#%d: %s", i+1, l.Error())
Expand Down Expand Up @@ -250,17 +239,7 @@ When you need to unwrap all errors, you should use `WrappedErrors()` instead.
Added in version 4.2.0.
*/
func (e Error) Unwrap() error {
return e[lenWithoutNil(e)-1]
}

func lenWithoutNil(e Error) (count int) {
for _, v := range e {
if v != nil {
count++
}
}

return
return e[len(e)-1]
}

// WrappedErrors returns the list of errors that this Error is wrapping.
Expand Down
29 changes: 28 additions & 1 deletion retry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,33 @@ func TestUnwrap(t *testing.T) {
assert.Equal(t, testError, errors.Unwrap(err))
}


func BenchmarkDo(b *testing.B) {
testError := errors.New("test error")

for i := 0; i < b.N; i++ {
Do(
func() error {
return testError
},
Attempts(10),
Delay(0),
)
}
}

func BenchmarkDoNoErrors(b *testing.B) {
for i := 0; i < b.N; i++ {
Do(
func() error {
return nil
},
Attempts(10),
Delay(0),
)
}
}

func TestIsRecoverable(t *testing.T) {
err := errors.New("err")
assert.True(t, IsRecoverable(err))
Expand All @@ -535,4 +562,4 @@ func TestIsRecoverable(t *testing.T) {

err = fmt.Errorf("wrapping: %w", err)
assert.False(t, IsRecoverable(err))
}
}