Files
ragflow/internal/common/retry.go
Zhichang Yu f12c0ec08a feat(knowledge_compile): materialize wiki page graph (wiki_entity/wiki_relation) (#17976)
Re-materialize wiki page graph from merged wiki_page rows after each
batch merge. Adds ProjectWikiGraph/DropWikiGraph, full page_type/slug
identity, delete-then-insert, tests.
2026-08-07 17:47:59 +08:00

123 lines
3.5 KiB
Go

// Package common — generic retry utility with exponential backoff.
//
// RetryWithBackoff calls fn up to maxRetries+1 times (one initial
// attempt + maxRetries retries), sleeping delay*2^attempt between
// failures (capped at 1 minute). The sleep honours ctx cancellation.
//
// maxRetries <= 0 yields a single attempt (no retries).
// initialDelay <= 0 results in no delay between retries.
//
// Usage:
//
// err := RetryWithBackoff(ctx, 3, 2*time.Second, func() error {
// return someFailableOperation()
// })
package common
import (
"context"
"errors"
"fmt"
"strings"
"time"
)
const (
// DefaultRetryMax is the default number of retries (3).
DefaultRetryMax = 3
// DefaultRetryDelay is the initial backoff delay (2s).
DefaultRetryDelay = 2 * time.Second
)
// RetryWithBackoff retries fn on error with exponential backoff.
// Returns nil on the first successful attempt. Returns the last
// error wrapped with the retry count when all attempts fail.
//
// An optional shouldRetry predicate lets callers abort on
// non-transient errors: when supplied and it returns false for a
// given error, RetryWithBackoff stops immediately and returns that
// error without further backoff. A nil predicate (or a nil function
// in the slice) retries on every error, preserving the original
// behavior.
func RetryWithBackoff(ctx context.Context, maxRetries int, initialDelay time.Duration, fn func() error, shouldRetry ...func(error) bool) error {
if maxRetries <= 0 {
return fn()
}
canRetry := func(err error) bool {
if len(shouldRetry) == 0 || shouldRetry[0] == nil {
return true
}
return shouldRetry[0](err)
}
delay := initialDelay
var lastErr error
for attempt := 0; attempt <= maxRetries; attempt++ {
err := fn()
if err == nil {
return nil
}
lastErr = err
if !canRetry(err) {
return err
}
if attempt == maxRetries {
break
}
select {
case <-ctx.Done():
return ctx.Err()
case <-time.After(delay):
}
delay *= 2
if delay > time.Minute {
delay = time.Minute
}
}
return fmt.Errorf("failed after %d retries: %w", maxRetries, lastErr)
}
// IsTransientError reports whether err is a transient provider failure worth
// retrying, as opposed to a permanent configuration/client error. It is the
// shared shouldRetry predicate for provider HTTP calls.
//
// Classification:
// - context.Canceled: permanent (caller cancelled; do not retry)
// - context.DeadlineExceeded: transient (a slow provider can succeed on retry)
// - an embedded HTTP status parsed from the error message: 5xx and 429 are
// transient (server / rate limit); other 4xx are permanent (auth, unknown
// model, invalid request)
// - anything else (network reset, connection refused, timeout): transient
//
// Provider drivers surface HTTP statuses as "API request failed with status
// <code>: <body>" (see BaseModel.doRequest), so parsing that prefix is enough.
func IsTransientError(err error) bool {
if err == nil {
return false
}
if errors.Is(err, context.Canceled) {
return false
}
if errors.Is(err, context.DeadlineExceeded) {
return true
}
msg := strings.ToLower(err.Error())
if idx := strings.Index(msg, "status "); idx >= 0 {
code := 0
for _, r := range msg[idx+len("status "):] {
if r < '0' || r > '9' {
break
}
code = code*10 + int(r-'0')
}
if code >= 500 || code == 429 {
return true
}
if code >= 400 && code < 500 {
return false
}
}
// No recognizable permanent marker: treat as transient (network, timeout).
return true
}