Gleipnir/jet
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #416 from go-jet/stmt-cache2

Browse source 
Add support for prepared statement caching
This commit is contained in:
go-jet 2024-10-29 11:50:53 +01:00 • committed by GitHub
commit 49104d1969
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1067 additions and 301 deletions
Download patch file Download diff file Expand all files Collapse all files

19
tests/sqlite/delete_test.go
View file

@ -2,6 +2,7 @@ package sqlite
import (
"context"
"github.com/go-jet/jet/v2/qrm"
"testing"
"time"
@ -60,8 +61,6 @@ LIMIT 1;
}
func TestDeleteContextDeadlineExceeded(t *testing.T) {
tx := beginSampleDBTx(t)
defer tx.Rollback()
deleteStmt := Link.
DELETE().
@ -70,14 +69,18 @@ func TestDeleteContextDeadlineExceeded(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Microsecond)
defer cancel()
time.Sleep(10 * time.Millisecond)
time.Sleep(20 * time.Millisecond)
dest := []model.Link{}
err := deleteStmt.QueryContext(ctx, tx, &dest)
require.Error(t, err, "context deadline exceeded")
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
var dest []model.Link
err := deleteStmt.QueryContext(ctx, tx, &dest)
require.Error(t, err, "context deadline exceeded")
})
_, err = deleteStmt.ExecContext(ctx, tx)
require.Error(t, err, "context deadline exceeded")
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
_, err := deleteStmt.ExecContext(ctx, tx)
require.Error(t, err, "context deadline exceeded")
})
requireLogged(t, deleteStmt)
}

28
tests/sqlite/insert_test.go
View file

@ -2,8 +2,8 @@ package sqlite
import (
"context"
"database/sql"
"github.com/go-jet/jet/v2/internal/utils/ptr"
"github.com/go-jet/jet/v2/qrm"
"math/rand"
"testing"
@ -31,7 +31,7 @@ VALUES (?, ?, ?, ?),
101, "http://www.google.com", "Google", "Search engine",
102, "http://www.yahoo.com", "Yahoo", nil)
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
testutils.AssertExec(t, insertQuery, tx)
requireLogged(t, insertQuery)
@ -76,7 +76,7 @@ VALUES (100, 'http://www.postgresqltutorial.com', 'PostgreSQL Tutorial', NULL);
`,
100, "http://www.postgresqltutorial.com", "PostgreSQL Tutorial", nil)
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
_, err := stmt.Exec(tx)
require.NoError(t, err)
requireLogged(t, stmt)
@ -109,7 +109,7 @@ INSERT INTO link (url, name)
VALUES ('http://www.duckduckgo.com', 'Duck Duck go');
`, "http://www.duckduckgo.com", "Duck Duck go")
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
_, err := query.Exec(tx)
require.NoError(t, err)
})
@ -131,7 +131,7 @@ INSERT INTO link
VALUES (1000, 'http://www.duckduckgo.com', 'Duck Duck go', NULL);
`, int32(1000), "http://www.duckduckgo.com", "Duck Duck go", nil)
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
_, err := query.Exec(tx)
require.NoError(t, err)
})
@ -220,7 +220,7 @@ WHERE link.id = 24;
)
testutils.AssertDebugStatementSql(t, query, expectedSQL, int64(24))
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
_, err := query.Exec(tx)
require.NoError(t, err)
@ -249,7 +249,7 @@ RETURNING link.id AS "link.id",
link.description AS "link.description";
`)
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
var link model.Link
err := stmt.Query(tx, &link)
require.NoError(t, err)
@ -387,9 +387,15 @@ func TestInsertContextDeadlineExceeded(t *testing.T) {
time.Sleep(10 * time.Millisecond)
var dest []model.Link
err := stmt.QueryContext(ctx, sampleDB, &dest)
require.Error(t, err, "context deadline exceeded")
_, err = stmt.ExecContext(ctx, db)
require.Error(t, err, "context deadline exceeded")
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
err := stmt.QueryContext(ctx, tx, &dest)
require.Error(t, err, "context deadline exceeded")
})
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
_, err := stmt.ExecContext(ctx, tx)
require.Error(t, err, "context deadline exceeded")
})
}

60
tests/sqlite/main_test.go
View file

@ -5,8 +5,8 @@ import (
"database/sql"
"fmt"
"github.com/go-jet/jet/v2/internal/utils/throw"
"github.com/go-jet/jet/v2/postgres"
"github.com/go-jet/jet/v2/sqlite"
"github.com/go-jet/jet/v2/stmtcache"
"github.com/go-jet/jet/v2/tests/dbconfig"
"github.com/pkg/profile"
"github.com/stretchr/testify/require"
@ -17,28 +17,52 @@ import (
_ "github.com/mattn/go-sqlite3"
)
var db *sql.DB
var sampleDB *sql.DB
var db *stmtcache.DB
var sampleDB *stmtcache.DB
var withStatementCaching bool
func init() {
withStatementCaching = os.Getenv("JET_TESTS_WITH_STMT_CACHE") == "true"
}
func TestMain(m *testing.M) {
defer profile.Start().Stop()
var err error
db, err = sql.Open("sqlite3", "file:"+dbconfig.SakilaDBPath)
throw.OnError(err)
defer db.Close()
func() {
fmt.Printf("\nRunning sqlite tests caching enabled: %t \n", withStatementCaching)
_, err = db.Exec(fmt.Sprintf("ATTACH DATABASE '%s' as 'chinook';", dbconfig.ChinookDBPath))
throw.OnError(err)
sqlDB, err := sql.Open("sqlite3", "file:"+dbconfig.SakilaDBPath)
throw.OnError(err)
db = stmtcache.New(sqlDB).SetCaching(withStatementCaching)
defer db.Close()
sampleDB, err = sql.Open("sqlite3", dbconfig.TestSampleDBPath)
throw.OnError(err)
_, err = db.Exec(fmt.Sprintf("ATTACH DATABASE '%s' as 'chinook';", dbconfig.ChinookDBPath))
throw.OnError(err)
ret := m.Run()
sqlSampleDB, err := sql.Open("sqlite3", dbconfig.TestSampleDBPath)
throw.OnError(err)
sampleDB = stmtcache.New(sqlSampleDB).SetCaching(withStatementCaching)
defer sampleDB.Close()
if ret != 0 {
os.Exit(ret)
for i := 0; i < runCount(withStatementCaching); i++ {
ret := m.Run()
if ret != 0 {
fmt.Printf("\nFAIL: Running sqlite tests failed, caching enabled: %t \n", withStatementCaching)
os.Exit(ret)
}
}
}()
}
func runCount(stmtCaching bool) int {
if stmtCaching {
return 4
}
return 1
}
var loggedSQL string
@ -62,7 +86,7 @@ func init() {
})
}
func requireQueryLogged(t *testing.T, statement postgres.Statement, rowsProcessed int64) {
func requireQueryLogged(t *testing.T, statement sqlite.Statement, rowsProcessed int64) {
query, args := statement.Sql()
queryLogged, argsLogged := queryInfo.Statement.Sql()
@ -84,13 +108,13 @@ func requireLogged(t *testing.T, statement sqlite.Statement) {
require.Equal(t, loggedDebugSQL, statement.DebugSql())
}
func beginSampleDBTx(t *testing.T) *sql.Tx {
tx, err := sampleDB.Begin()
func beginSampleDBTx(t *testing.T) *stmtcache.Tx {
tx, err := sampleDB.BeginTx(context.Background(), nil)
require.NoError(t, err)
return tx
}
func beginDBTx(t *testing.T) *sql.Tx {
func beginDBTx(t *testing.T) *stmtcache.Tx {
tx, err := db.Begin()
require.NoError(t, err)
return tx

4
tests/sqlite/sample_test.go
View file

@ -1,8 +1,8 @@
package sqlite
import (
"database/sql"
"github.com/go-jet/jet/v2/internal/testutils"
"github.com/go-jet/jet/v2/qrm"
"github.com/go-jet/jet/v2/internal/utils/ptr"
"github.com/stretchr/testify/require"
"testing"
@ -49,7 +49,7 @@ WHERE people.people_id = ?;
})
t.Run("should insert without generated columns", func(t *testing.T) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, sampleDB, func(tx qrm.DB) {
insertQuery := People.INSERT(
People.MutableColumns,
).MODEL(

16
tests/sqlite/select_test.go
View file

@ -987,14 +987,14 @@ WHERE artists.''ArtistId'' = 11;
}
func TestRowsScan(t *testing.T) {
stmt :=
SELECT(
Inventory.AllColumns,
).FROM(
Inventory,
).ORDER_BY(
Inventory.InventoryID.ASC(),
)
stmt := SELECT(
Inventory.AllColumns,
).FROM(
Inventory,
).ORDER_BY(
Inventory.InventoryID.ASC(),
)
rows, err := stmt.Rows(context.Background(), db)
require.NoError(t, err)

131
tests/sqlite/stmtcache_test.go Normal file
View file

@ -0,0 +1,131 @@
package sqlite
import (
"context"
"database/sql"
"github.com/go-jet/jet/v2/internal/testutils"
. "github.com/go-jet/jet/v2/sqlite"
"github.com/go-jet/jet/v2/stmtcache"
"github.com/go-jet/jet/v2/tests/.gentestdata/sqlite/sakila/model"
. "github.com/go-jet/jet/v2/tests/.gentestdata/sqlite/sakila/table"
"github.com/go-jet/jet/v2/tests/dbconfig"
"github.com/stretchr/testify/require"
"testing"
)
func TestPreparedStatementCache(t *testing.T) {
sqlDB, err := sql.Open("sqlite3", "file:"+dbconfig.SakilaDBPath)
require.NoError(t, err)
stmtCachedDB := stmtcache.New(sqlDB)
defer func(db *stmtcache.DB) {
err := db.Close()
require.NoError(t, err)
require.Equal(t, db.CacheSize(), 0)
}(stmtCachedDB)
require.True(t, stmtCachedDB.CachingEnabled())
require.Equal(t, stmtCachedDB.CacheSize(), 0)
testStatementCaching := func(cachingEnabled bool) {
stmtCachedDB.SetCaching(cachingEnabled)
require.Equal(t, stmtCachedDB.CachingEnabled(), cachingEnabled)
ctx := context.TODO()
stmt := SELECT(Actor.AllColumns).
FROM(Actor).
WHERE(Actor.ActorID.BETWEEN(Int(1), Int(10)))
query, args := stmt.Sql()
preStmt, err := stmtCachedDB.Prepare(query)
require.NoError(t, err)
preStmt2, err := stmtCachedDB.PrepareContext(ctx, query)
require.NoError(t, err)
require.Equal(t, preStmt == preStmt2, cachingEnabled)
t.Run("Exec", func(t *testing.T) {
testutils.AssertExec(t, stmt, stmtCachedDB)
testutils.AssertExecContext(t, stmt, ctx, stmtCachedDB)
_, err := stmtCachedDB.Exec(query, args...)
require.NoError(t, err)
})
t.Run("Query", func(t *testing.T) {
var dest []model.Actor
err := stmt.Query(stmtCachedDB, &dest)
require.NoError(t, err)
require.Len(t, dest, 10)
rows, err := stmtCachedDB.Query(query, args...)
rows.Close()
require.NoError(t, err)
t.Run("ctx", func(t *testing.T) {
var dest []model.Actor
err := stmt.QueryContext(ctx, stmtCachedDB, &dest)
require.NoError(t, err)
require.Len(t, dest, 10)
})
})
t.Run("tx", func(t *testing.T) {
tx, err := stmtCachedDB.Begin()
require.NoError(t, err)
preStmtTx, err := tx.Prepare(query)
require.NoError(t, err)
_, err = preStmtTx.Exec(args...)
require.NoError(t, err)
preStmtTx2, err := tx.PrepareContext(ctx, query)
require.NoError(t, err)
require.Equal(t, preStmtTx == preStmtTx2, cachingEnabled)
_, err = preStmtTx2.ExecContext(ctx, args...)
require.NoError(t, err)
t.Run("Exec", func(t *testing.T) {
testutils.AssertExec(t, stmt, tx)
testutils.AssertExecContext(t, stmt, ctx, tx)
_, err := tx.Exec(query, args...)
require.NoError(t, err)
})
t.Run("Query", func(t *testing.T) {
var dest []model.Actor
err = stmt.QueryContext(ctx, tx, &dest)
require.NoError(t, err)
require.Len(t, dest, 10)
rows, err := tx.Query(query, args...)
require.NoError(t, err)
require.NoError(t, rows.Close())
})
t.Run("new tx", func(t *testing.T) {
txCtx, err := stmtCachedDB.BeginTx(ctx, nil)
require.NoError(t, err)
preStmtTxCtx, err := txCtx.PrepareContext(ctx, query)
require.NoError(t, err)
require.NotEqual(t, preStmtTx, preStmtTxCtx)
require.NoError(t, txCtx.Rollback())
})
require.NoError(t, preStmtTx.Close())
require.NoError(t, preStmtTx2.Close())
require.NoError(t, tx.Commit())
})
}
testStatementCaching(true)
require.Equal(t, stmtCachedDB.CacheSize(), 1)
testStatementCaching(false)
require.Equal(t, stmtCachedDB.CacheSize(), 1)
require.NoError(t, stmtCachedDB.ClearCache())
require.Equal(t, stmtCachedDB.CacheSize(), 0)
}

19
tests/sqlite/update_test.go
View file

@ -2,6 +2,7 @@ package sqlite
import (
"context"
"github.com/go-jet/jet/v2/qrm"
model2 "github.com/go-jet/jet/v2/tests/.gentestdata/sqlite/sakila/model"
"github.com/go-jet/jet/v2/tests/.gentestdata/sqlite/sakila/table"
"testing"
@ -215,7 +216,7 @@ WHERE link.id = 20;
testutils.AssertDebugStatementSql(t, stmt, expectedSQL, nil, "DuckDuckGo", "http://www.duckduckgo.com", int32(20))
testutils.AssertExec(t, stmt, tx)
testutils.AssertExec(t, stmt, tx, 1)
requireLogged(t, stmt)
}
@ -271,8 +272,6 @@ func TestUpdateWithInvalidModelData(t *testing.T) {
}
func TestUpdateContextDeadlineExceeded(t *testing.T) {
tx := beginSampleDBTx(t)
defer tx.Rollback()
updateStmt := Link.UPDATE(Link.Name, Link.URL).
SET("Bong", "http://bong.com").
@ -283,12 +282,16 @@ func TestUpdateContextDeadlineExceeded(t *testing.T) {
time.Sleep(10 * time.Millisecond)
var dest []model.Link
err := updateStmt.QueryContext(ctx, tx, &dest)
require.Error(t, err, "context deadline exceeded")
testutils.ExecuteInTxAndRollback(t, db, func(tx qrm.DB) {
var dest []model.Link
err := updateStmt.QueryContext(ctx, tx, &dest)
require.Error(t, err, "context deadline exceeded")
})
_, err = updateStmt.ExecContext(ctx, tx)
require.Error(t, err, "context deadline exceeded")
testutils.ExecuteInTxAndRollback(t, db, func(tx qrm.DB) {
_, err := updateStmt.ExecContext(ctx, tx)
require.Error(t, err, "context deadline exceeded")
})
}
func TestUpdateFrom(t *testing.T) {

4
tests/sqlite/values_test.go
View file

@ -1,8 +1,8 @@
package sqlite
import (
"database/sql"
"github.com/go-jet/jet/v2/internal/testutils"
"github.com/go-jet/jet/v2/qrm"
"github.com/stretchr/testify/require"
"strings"
"testing"
@ -293,7 +293,7 @@ RETURNING payment.payment_id AS "payment.payment_id",
payment.last_update AS "payment.last_update";
`, "''", "`"))
testutils.ExecuteInTxAndRollback(t, db, func(tx *sql.Tx) {
testutils.ExecuteInTxAndRollback(t, db, func(tx qrm.DB) {
var payments []model.Payment
err := stmt.Query(tx, &payments)