Files
916f6b7225 MM-68332: consistently enforce query timeouts (#36522)
* Remove QueryRowx (no-timeout) from sqlxDBWrapper; migrate caller to QueryRowX

QueryRowx forwarded to context.Background() with no timeout, while QueryRowX
(uppercase) already enforces the wrapper timeout. Removing the no-timeout
variant eliminates an accidental footgun and migrates the one sqlstore caller
(plugin_store) to the timeout-enforcing method.

* sqlxRow, with timeout cancel after Scan

Introduce sqlxRow, which pairs *sqlx.Row with its context cancel function.
QueryRowX (on both sqlxDBWrapper and sqlxTxWrapper) now returns *sqlxRow;
Scan calls cancel immediately after the row is consumed, releasing the
timeout context as soon as possible rather than waiting for the timer.

* sqlxRows, with timeout cancel on Close

Introduce sqlxRows, which embeds *sqlx.Rows and holds the timeout context's
cancel function. Close() cancels the context immediately after the rows are
done, releasing timeout resources as soon as iteration completes rather than
waiting for the timer to fire.

Introduce rowScanner interface (Next/Scan/Err) so the internal helpers
scanRowsIntoMap and scanRetentionIdsForDeletion accept any row iterator
rather than the concrete *sql.Rows, accommodating the new return types
without threading *sqlxRows through every caller.

* abolish the X suffix altogether

* delete unused NamedQuery

* add timeout tests for Query and QueryRow on db and tx wrappers

* fix tx/timeout tests: handle pq driver.ErrBadConn on killed connection

* fixup! fix tx/timeout tests: handle pq driver.ErrBadConn on killed connection

* override Next() on sqlxRows to cancel on EOF

* rm redundant row.Err(), handled by Scan

* apply timeout to context unless deadline set

* rebind consistently

* address review feedback: rename, trace, and QueryContext fix

- Rename withQueryTimeout → ensureQueryTimeout to better convey that it
  respects existing deadlines rather than overriding them.
- Add missing w.trace blocks to QueryRowContext and ExecContext.
- Change QueryContext to use ensureQueryTimeout and return *sqlxRows
  (instead of *sql.Rows) so the cancel is deferred to Close/Next
  rather than released prematurely.

* fix Beginx → Begin after master merge

* fix golangci-lint inline warning in sqlx_wrapper_test

---------

Co-authored-by: Mattermost Build <[email protected]>
2026-05-15 13:02:13 +00:00

318 lines
8.9 KiB
Go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package sqlstore
import (
"testing"
"github.com/mattermost/mattermost/server/public/shared/request"
"github.com/mattermost/mattermost/server/v8/channels/store"
"github.com/stretchr/testify/require"
)
func TestChunkSlice(t *testing.T) {
if enableFullyParallelTests {
t.Parallel()
}
t.Run("empty slice returns nil", func(t *testing.T) {
result := chunkSlice([]int{}, 5, defaultMaxInsertParams)
require.Nil(t, result)
})
t.Run("under limit returns single chunk", func(t *testing.T) {
items := []int{1, 2, 3}
result := chunkSlice(items, 15, defaultMaxInsertParams) // 3*15=45 params, well under 50k
require.Len(t, result, 1)
require.Equal(t, items, result[0])
})
t.Run("exact boundary returns single chunk", func(t *testing.T) {
n := defaultMaxInsertParams / 10 // exactly at limit with 10 cols
items := make([]int, n)
result := chunkSlice(items, 10, defaultMaxInsertParams)
require.Len(t, result, 1)
require.Len(t, result[0], n)
})
t.Run("over limit splits into chunks", func(t *testing.T) {
n := defaultMaxInsertParams/10 + 1 // one over
items := make([]int, n)
result := chunkSlice(items, 10, defaultMaxInsertParams)
require.Len(t, result, 2)
require.Len(t, result[0], defaultMaxInsertParams/10)
require.Len(t, result[1], 1)
})
t.Run("remainder is handled correctly", func(t *testing.T) {
chunkSize := defaultMaxInsertParams / 15 // 3333
n := chunkSize*2 + 100 // two full chunks + 100 remainder
items := make([]int, n)
result := chunkSlice(items, 15, defaultMaxInsertParams)
require.Len(t, result, 3)
require.Len(t, result[0], chunkSize)
require.Len(t, result[1], chunkSize)
require.Len(t, result[2], 100)
})
t.Run("columnsPerRow > maxParams panics", func(t *testing.T) {
require.Panics(t, func() {
chunkSlice([]int{1}, defaultMaxInsertParams+1, defaultMaxInsertParams)
})
})
t.Run("columnsPerRow <= 0 panics", func(t *testing.T) {
require.Panics(t, func() {
chunkSlice([]int{1}, 0, defaultMaxInsertParams)
})
require.Panics(t, func() {
chunkSlice([]int{1}, -1, defaultMaxInsertParams)
})
})
t.Run("maxParams <= 0 panics", func(t *testing.T) {
require.Panics(t, func() {
chunkSlice([]int{1}, 1, 0)
})
})
}
func TestMapStringsToQueryParams(t *testing.T) {
if enableFullyParallelTests {
t.Parallel()
}
t.Run("one item", func(t *testing.T) {
input := []string{"apple"}
keys, params := MapStringsToQueryParams(input, "Fruit")
require.Len(t, params, 1, "returned incorrect params", params)
require.Equal(t, "apple", params["Fruit0"], "returned incorrect params", params)
require.Equal(t, "(:Fruit0)", keys, "returned incorrect query", keys)
})
t.Run("multiple items", func(t *testing.T) {
input := []string{"carrot", "tomato", "potato"}
keys, params := MapStringsToQueryParams(input, "Vegetable")
require.Len(t, params, 3, "returned incorrect params", params)
require.Equal(t, "carrot", params["Vegetable0"], "returned incorrect params", params)
require.Equal(t, "tomato", params["Vegetable1"], "returned incorrect params", params)
require.Equal(t, "potato", params["Vegetable2"], "returned incorrect params", params)
require.Equal(t, "(:Vegetable0,:Vegetable1,:Vegetable2)", keys, "returned incorrect query", keys)
})
}
var (
keys string
params map[string]any
)
func BenchmarkMapStringsToQueryParams(b *testing.B) {
b.Run("one item", func(b *testing.B) {
input := []string{"apple"}
for b.Loop() {
keys, params = MapStringsToQueryParams(input, "Fruit")
}
})
b.Run("multiple items", func(b *testing.B) {
input := []string{"carrot", "tomato", "potato"}
for b.Loop() {
keys, params = MapStringsToQueryParams(input, "Vegetable")
}
})
}
func TestSanitizeSearchTerm(t *testing.T) {
if enableFullyParallelTests {
t.Parallel()
}
term := "test"
result := sanitizeSearchTerm(term, "\\")
require.Equal(t, result, term)
term = "%%%"
expected := "\\%\\%\\%"
result = sanitizeSearchTerm(term, "\\")
require.Equal(t, result, expected)
term = "%\\%\\%"
expected = "\\%\\%\\%"
result = sanitizeSearchTerm(term, "\\")
require.Equal(t, result, expected)
term = "%_test_%"
expected = "\\%\\_test\\_\\%"
result = sanitizeSearchTerm(term, "\\")
require.Equal(t, result, expected)
term = "**test_%"
expected = "test*_*%"
result = sanitizeSearchTerm(term, "*")
require.Equal(t, result, expected)
}
func TestRemoveNonAlphaNumericUnquotedTerms(t *testing.T) {
if enableFullyParallelTests {
t.Parallel()
}
const (
sep = " "
chineseHello = "你好"
japaneseHello = "こんにちは"
)
tests := []struct {
term string
want string
name string
}{
{term: "", want: "", name: "empty"},
{term: "h", want: "h", name: "singleChar"},
{term: "hello", want: "hello", name: "multiChar"},
{term: `hel*lo "**" **& hello`, want: `hel*lo "**" hello`, name: "quoted_unquoted_english"},
{term: japaneseHello + chineseHello, want: japaneseHello + chineseHello, name: "japanese_chinese"},
{term: japaneseHello + ` "*" ` + chineseHello, want: japaneseHello + ` "*" ` + chineseHello, name: `quoted_japanese_and_chinese`},
{term: japaneseHello + ` "*" &&* ` + chineseHello, want: japaneseHello + ` "*" ` + chineseHello, name: "quoted_unquoted_japanese_and_chinese"},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got := removeNonAlphaNumericUnquotedTerms(test.term, sep)
require.Equal(t, test.want, got)
})
}
}
func TestScanRowsIntoMap(t *testing.T) {
StoreTest(t, func(t *testing.T, rctx request.CTX, ss store.Store) {
sqlStore := ss.(*SqlStore)
t.Run("basic mapping", func(t *testing.T) {
// Create a test table
_, err := sqlStore.GetMaster().Exec(`
CREATE TEMPORARY TABLE IF NOT EXISTS MapTest (
id VARCHAR(50) PRIMARY KEY,
value INT
)
`)
require.NoError(t, err)
// Insert test data
_, err = sqlStore.GetMaster().Exec(`
INSERT INTO MapTest VALUES ('key1', 10), ('key2', 20), ('key3', 30)
`)
require.NoError(t, err)
// Query the data
rows, err := sqlStore.GetMaster().Query(`SELECT id, value FROM MapTest ORDER BY id`)
require.NoError(t, err)
defer rows.Close()
// Create scanner function
scanner := func(rows rowScanner) (string, int, error) {
var key string
var value int
return key, value, rows.Scan(&key, &value)
}
// Call the function under test
result, err := scanRowsIntoMap(rows, scanner, nil)
// Assert results
require.NoError(t, err)
require.Len(t, result, 3)
require.Equal(t, 10, result["key1"])
require.Equal(t, 20, result["key2"])
require.Equal(t, 30, result["key3"])
})
t.Run("with default values", func(t *testing.T) {
// Create a test table
_, err := sqlStore.GetMaster().Exec(`
CREATE TEMPORARY TABLE IF NOT EXISTS MapTestDefaults (
id VARCHAR(50) PRIMARY KEY,
value INT
)
`)
require.NoError(t, err)
// Insert test data - only insert one key to test defaults
_, err = sqlStore.GetMaster().Exec(`
INSERT INTO MapTestDefaults VALUES ('key1', 10)
`)
require.NoError(t, err)
// Query the data
rows, err := sqlStore.GetMaster().Query(`SELECT id, value FROM MapTestDefaults`)
require.NoError(t, err)
defer rows.Close()
// Create scanner function
scanner := func(rows rowScanner) (string, int, error) {
var key string
var value int
return key, value, rows.Scan(&key, &value)
}
// Define defaults
defaults := map[string]int{
"key1": 100, // Should be overwritten
"key2": 200, // Should remain
"key3": 300, // Should remain
}
// Call the function under test
result, err := scanRowsIntoMap(rows, scanner, defaults)
// Assert results
require.NoError(t, err)
require.Len(t, result, 3)
require.Equal(t, 10, result["key1"]) // Should be from DB, not default
require.Equal(t, 200, result["key2"]) // Should be from defaults
require.Equal(t, 300, result["key3"]) // Should be from defaults
})
t.Run("with empty result set", func(t *testing.T) {
// Create a test table
_, err := sqlStore.GetMaster().Exec(`
CREATE TEMPORARY TABLE IF NOT EXISTS MapTestEmpty (
id VARCHAR(50) PRIMARY KEY,
value INT
)
`)
require.NoError(t, err)
// Query the empty table
rows, err := sqlStore.GetMaster().Query(`SELECT id, value FROM MapTestEmpty`)
require.NoError(t, err)
defer rows.Close()
// Create scanner function
scanner := func(rows rowScanner) (string, int, error) {
var key string
var value int
return key, value, rows.Scan(&key, &value)
}
// Define defaults
defaults := map[string]int{
"key1": 100,
"key2": 200,
}
// Call the function under test
result, err := scanRowsIntoMap(rows, scanner, defaults)
// Assert results
require.NoError(t, err)
require.Len(t, result, 2)
require.Equal(t, 100, result["key1"]) // Should be from defaults
require.Equal(t, 200, result["key2"]) // Should be from defaults
})
})
}