SQLStore: Fix SQLite error propagation if query retries are disabled (#64904)

* SQLStore: Add test when query retrying is disabled

* Fix condition

* Add test cases for sqlite3.ErrLocked
This commit is contained in:
Sofia Papagiannaki 2023-03-17 12:57:13 +02:00 committed by GitHub
parent 595518ec12
commit 41843464d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 69 additions and 13 deletions

View File

@ -95,7 +95,7 @@ func (ss *SQLStore) retryOnLocks(ctx context.Context, callback DBTransactionFunc
ctxLogger.Info("Database locked, sleeping then retrying", "error", err, "retry", retry, "code", sqlError.Code)
// retryer immediately returns the error (if there is one) without checking the response
// therefore we only have to send it if we have reached the maximum retries
if retry == ss.dbCfg.QueryRetries {
if retry >= ss.dbCfg.QueryRetries {
return retryer.FuncError, ErrMaximumRetriesReached.Errorf("retry %d: %w", retry, err)
}
return retryer.FuncFailure, nil

View File

@ -7,9 +7,61 @@ import (
"testing"
"github.com/mattn/go-sqlite3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestRetryingDisabled(t *testing.T) {
store := InitTestDB(t)
require.Equal(t, 0, store.dbCfg.QueryRetries)
funcToTest := map[string]func(ctx context.Context, callback DBTransactionFunc) error{
"WithDbSession": store.WithDbSession,
"WithNewDbSession": store.WithNewDbSession,
}
for name, f := range funcToTest {
t.Run(fmt.Sprintf("%s should return the error immediately", name), func(t *testing.T) {
i := 0
callback := func(sess *DBSession) error {
i++
return errors.New("some error")
}
err := f(context.Background(), callback)
require.Error(t, err)
require.Equal(t, 1, i)
})
errCodes := []sqlite3.ErrNo{sqlite3.ErrBusy, sqlite3.ErrLocked}
for _, c := range errCodes {
t.Run(fmt.Sprintf("%s should return the sqlite3.Error %v immediately", name, c.Error()), func(t *testing.T) {
i := 0
callback := func(sess *DBSession) error {
i++
return sqlite3.Error{Code: c}
}
err := f(context.Background(), callback)
require.Error(t, err)
var driverErr sqlite3.Error
require.ErrorAs(t, err, &driverErr)
require.Equal(t, 1, i)
assert.Equal(t, c, driverErr.Code)
})
}
t.Run(fmt.Sprintf("%s should not return error if the callback succeeds", name), func(t *testing.T) {
i := 0
callback := func(sess *DBSession) error {
i++
return nil
}
err := f(context.Background(), callback)
require.NoError(t, err)
require.Equal(t, 1, i)
})
}
}
func TestRetryingOnFailures(t *testing.T) {
store := InitTestDB(t)
store.dbCfg.QueryRetries = 5
@ -31,18 +83,22 @@ func TestRetryingOnFailures(t *testing.T) {
require.Equal(t, 1, i)
})
t.Run(fmt.Sprintf("%s should return the sqlite3.Error if all retries have failed", name), func(t *testing.T) {
i := 0
callback := func(sess *DBSession) error {
i++
return sqlite3.Error{Code: sqlite3.ErrBusy}
}
err := f(context.Background(), callback)
require.Error(t, err)
var driverErr sqlite3.Error
require.ErrorAs(t, err, &driverErr)
require.Equal(t, store.dbCfg.QueryRetries, i)
})
errCodes := []sqlite3.ErrNo{sqlite3.ErrBusy, sqlite3.ErrLocked}
for _, c := range errCodes {
t.Run(fmt.Sprintf("%s should return the sqlite3.Error %v if all retries have failed", name, c.Error()), func(t *testing.T) {
i := 0
callback := func(sess *DBSession) error {
i++
return sqlite3.Error{Code: c}
}
err := f(context.Background(), callback)
require.Error(t, err)
var driverErr sqlite3.Error
require.ErrorAs(t, err, &driverErr)
require.Equal(t, store.dbCfg.QueryRetries, i)
assert.Equal(t, c, driverErr.Code)
})
}
t.Run(fmt.Sprintf("%s should not return the error if successive retries succeed", name), func(t *testing.T) {
i := 0