docs(database): clarify test coverage scope and experimental variable

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
カン 2026-04-28 12:27:36 +09:00 committed by 康厚超
parent b0cfc49c0d
commit 0499e91ebe

View file

@ -14,23 +14,23 @@ import (
"gorm.io/gorm/logger" "gorm.io/gorm/logger"
) )
// TestInitDBConcurrencyConfig verifies that InitDB applies both settings used // TestInitDBConcurrencyConfig verifies that InitDB applies the concurrency
// by TestConcurrentWrites to reduce "database is locked" errors from // settings these tests rely on to reduce "database is locked" errors from
// concurrent access within this process: // concurrent access within this process:
// //
// 1. WAL journal mode — reduces the window during which a write lock is held // 1. WAL journal mode — asserted directly by this test via PRAGMA
// (readers no longer block writers and vice-versa). // journal_mode.
// 2. SetMaxOpenConns(1) — serialises all GORM writes through a single // 2. SetMaxOpenConns(1) — asserted directly by this test via
// connection at the Go pool level, which prevents the specific // sql.DB.Stats(), with its effect on the reproduced contention pattern
// intra-process write-contention pattern exercised by these tests. // demonstrated separately by TestConcurrentWrites.
// //
// Chain of proof: // Chain of proof:
// //
// TestConcurrentWrites/with_fix_* shows SetMaxOpenConns(1) prevents the // TestConcurrentWrites/with_fix_* shows SetMaxOpenConns(1) prevents the
// specific concurrent-write lock contention reproduced by that test. // specific concurrent-write lock contention reproduced by that test.
// TestInitDBConcurrencyConfig/single_connection_pool proves InitDB calls it. // TestInitDBConcurrencyConfig/WAL_journal_mode proves InitDB enables WAL.
// Therefore InitDB applies the same mitigation for this process/pool, // TestInitDBConcurrencyConfig/single_connection_pool proves InitDB calls
// without implying that SQLite lock errors cannot occur in all scenarios. // SetMaxOpenConns(1).
func TestInitDBConcurrencyConfig(t *testing.T) { func TestInitDBConcurrencyConfig(t *testing.T) {
dbPath := filepath.Join(t.TempDir(), "test.db") dbPath := filepath.Join(t.TempDir(), "test.db")
if err := InitDB(dbPath); err != nil { if err := InitDB(dbPath); err != nil {
@ -64,7 +64,8 @@ func TestInitDBConcurrencyConfig(t *testing.T) {
// //
// Both sub-tests use _busy_timeout=10ms so that lock contention surfaces // Both sub-tests use _busy_timeout=10ms so that lock contention surfaces
// within milliseconds rather than the go-sqlite3 default of 5 000 ms. // within milliseconds rather than the go-sqlite3 default of 5 000 ms.
// The ONLY variable that differs between the two sub-tests is MaxOpenConns. // The primary variable intentionally changed between the two sub-tests is
// MaxOpenConns.
// //
// Without fix (MaxOpenConns=2): // Without fix (MaxOpenConns=2):
// //