Compare commits
1 Commits
feature/mi
...
5504495e0c
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5504495e0c |
@@ -21,6 +21,10 @@ import (
|
|||||||
//go:embed schema/*.sql
|
//go:embed schema/*.sql
|
||||||
var schemaFS embed.FS
|
var schemaFS embed.FS
|
||||||
|
|
||||||
|
// bootstrapVersion is the migration that creates the schema_migrations
|
||||||
|
// table itself. It is applied before the normal migration loop.
|
||||||
|
const bootstrapVersion = "000"
|
||||||
|
|
||||||
// Params defines dependencies for Database.
|
// Params defines dependencies for Database.
|
||||||
type Params struct {
|
type Params struct {
|
||||||
fx.In
|
fx.In
|
||||||
@@ -84,43 +88,36 @@ func (s *Database) connect(ctx context.Context) error {
|
|||||||
s.db = db
|
s.db = db
|
||||||
s.log.Info("database connected")
|
s.log.Info("database connected")
|
||||||
|
|
||||||
return s.runMigrations(ctx)
|
return applyMigrations(ctx, s.db, s.log)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *Database) runMigrations(ctx context.Context) error {
|
// applyMigrations bootstraps the migrations table from 000.sql and then
|
||||||
// Create migrations tracking table
|
// applies every remaining migration that has not been recorded yet.
|
||||||
_, err := s.db.ExecContext(ctx, `
|
func applyMigrations(ctx context.Context, db *sql.DB, log *slog.Logger) error {
|
||||||
CREATE TABLE IF NOT EXISTS schema_migrations (
|
if err := bootstrapMigrationsTable(ctx, db, log); err != nil {
|
||||||
version TEXT PRIMARY KEY,
|
return err
|
||||||
applied_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
|
||||||
)
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to create migrations table: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get list of migration files
|
|
||||||
entries, err := schemaFS.ReadDir("schema")
|
entries, err := schemaFS.ReadDir("schema")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to read schema directory: %w", err)
|
return fmt.Errorf("failed to read schema directory: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Sort migration files by name (001.sql, 002.sql, etc.)
|
|
||||||
var migrations []string
|
var migrations []string
|
||||||
for _, entry := range entries {
|
for _, entry := range entries {
|
||||||
if !entry.IsDir() && strings.HasSuffix(entry.Name(), ".sql") {
|
if !entry.IsDir() && strings.HasSuffix(entry.Name(), ".sql") {
|
||||||
migrations = append(migrations, entry.Name())
|
migrations = append(migrations, entry.Name())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
sort.Strings(migrations)
|
sort.Strings(migrations)
|
||||||
|
|
||||||
// Apply each migration that hasn't been applied yet
|
|
||||||
for _, migration := range migrations {
|
for _, migration := range migrations {
|
||||||
version := strings.TrimSuffix(migration, filepath.Ext(migration))
|
version := strings.TrimSuffix(migration, filepath.Ext(migration))
|
||||||
|
|
||||||
// Check if already applied
|
|
||||||
var count int
|
var count int
|
||||||
err := s.db.QueryRowContext(ctx,
|
|
||||||
|
err := db.QueryRowContext(ctx,
|
||||||
"SELECT COUNT(*) FROM schema_migrations WHERE version = ?",
|
"SELECT COUNT(*) FROM schema_migrations WHERE version = ?",
|
||||||
version,
|
version,
|
||||||
).Scan(&count)
|
).Scan(&count)
|
||||||
@@ -129,26 +126,24 @@ func (s *Database) runMigrations(ctx context.Context) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if count > 0 {
|
if count > 0 {
|
||||||
s.log.Debug("migration already applied", "version", version)
|
logDebug(log, "migration already applied", "version", version)
|
||||||
|
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// Read and apply migration
|
|
||||||
content, err := schemaFS.ReadFile(filepath.Join("schema", migration))
|
content, err := schemaFS.ReadFile(filepath.Join("schema", migration))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to read migration %s: %w", migration, err)
|
return fmt.Errorf("failed to read migration %s: %w", migration, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
s.log.Info("applying migration", "version", version)
|
logInfo(log, "applying migration", "version", version)
|
||||||
|
|
||||||
_, err = s.db.ExecContext(ctx, string(content))
|
_, err = db.ExecContext(ctx, string(content))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to apply migration %s: %w", migration, err)
|
return fmt.Errorf("failed to apply migration %s: %w", migration, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Record migration as applied
|
_, err = db.ExecContext(ctx,
|
||||||
_, err = s.db.ExecContext(ctx,
|
|
||||||
"INSERT INTO schema_migrations (version) VALUES (?)",
|
"INSERT INTO schema_migrations (version) VALUES (?)",
|
||||||
version,
|
version,
|
||||||
)
|
)
|
||||||
@@ -156,12 +151,81 @@ func (s *Database) runMigrations(ctx context.Context) error {
|
|||||||
return fmt.Errorf("failed to record migration %s: %w", migration, err)
|
return fmt.Errorf("failed to record migration %s: %w", migration, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
s.log.Info("migration applied successfully", "version", version)
|
logInfo(log, "migration applied successfully", "version", version)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// bootstrapMigrationsTable ensures the schema_migrations table exists
|
||||||
|
// by applying 000.sql directly. For databases that already have the
|
||||||
|
// table (created by older code), it records version "000" for
|
||||||
|
// consistency.
|
||||||
|
func bootstrapMigrationsTable(ctx context.Context, db *sql.DB, log *slog.Logger) error {
|
||||||
|
var tableExists int
|
||||||
|
|
||||||
|
err := db.QueryRowContext(ctx,
|
||||||
|
"SELECT COUNT(*) FROM sqlite_master WHERE type='table' AND name='schema_migrations'",
|
||||||
|
).Scan(&tableExists)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to check for migrations table: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if tableExists > 0 {
|
||||||
|
// Table already exists (from older inline-SQL code or a
|
||||||
|
// previous run). Make sure version "000" is recorded so the
|
||||||
|
// normal loop skips the bootstrap file.
|
||||||
|
var recorded int
|
||||||
|
|
||||||
|
err := db.QueryRowContext(ctx,
|
||||||
|
"SELECT COUNT(*) FROM schema_migrations WHERE version = ?",
|
||||||
|
bootstrapVersion,
|
||||||
|
).Scan(&recorded)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to check bootstrap migration status: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if recorded == 0 {
|
||||||
|
_, err = db.ExecContext(ctx,
|
||||||
|
"INSERT INTO schema_migrations (version) VALUES (?)",
|
||||||
|
bootstrapVersion,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to record bootstrap migration: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
logInfo(log, "recorded bootstrap migration for existing table", "version", bootstrapVersion)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Table does not exist — apply 000.sql to create it.
|
||||||
|
content, err := schemaFS.ReadFile("schema/000.sql")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to read bootstrap migration 000.sql: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
logInfo(log, "applying bootstrap migration", "version", bootstrapVersion)
|
||||||
|
|
||||||
|
_, err = db.ExecContext(ctx, string(content))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to apply bootstrap migration: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = db.ExecContext(ctx,
|
||||||
|
"INSERT INTO schema_migrations (version) VALUES (?)",
|
||||||
|
bootstrapVersion,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to record bootstrap migration: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
logInfo(log, "bootstrap migration applied successfully", "version", bootstrapVersion)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// DB returns the underlying sql.DB.
|
// DB returns the underlying sql.DB.
|
||||||
func (s *Database) DB() *sql.DB {
|
func (s *Database) DB() *sql.DB {
|
||||||
return s.db
|
return s.db
|
||||||
@@ -171,72 +235,19 @@ func (s *Database) DB() *sql.DB {
|
|||||||
// This is useful for testing where you want to use the real schema
|
// This is useful for testing where you want to use the real schema
|
||||||
// without the full fx lifecycle.
|
// without the full fx lifecycle.
|
||||||
func ApplyMigrations(db *sql.DB) error {
|
func ApplyMigrations(db *sql.DB) error {
|
||||||
ctx := context.Background()
|
return applyMigrations(context.Background(), db, nil)
|
||||||
|
|
||||||
// Create migrations tracking table
|
|
||||||
_, err := db.ExecContext(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS schema_migrations (
|
|
||||||
version TEXT PRIMARY KEY,
|
|
||||||
applied_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
|
||||||
)
|
|
||||||
`)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to create migrations table: %w", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get list of migration files
|
// logInfo logs at info level when a logger is available.
|
||||||
entries, err := schemaFS.ReadDir("schema")
|
func logInfo(log *slog.Logger, msg string, args ...any) {
|
||||||
if err != nil {
|
if log != nil {
|
||||||
return fmt.Errorf("failed to read schema directory: %w", err)
|
log.Info(msg, args...)
|
||||||
}
|
|
||||||
|
|
||||||
// Sort migration files by name (001.sql, 002.sql, etc.)
|
|
||||||
var migrations []string
|
|
||||||
for _, entry := range entries {
|
|
||||||
if !entry.IsDir() && strings.HasSuffix(entry.Name(), ".sql") {
|
|
||||||
migrations = append(migrations, entry.Name())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sort.Strings(migrations)
|
|
||||||
|
|
||||||
// Apply each migration that hasn't been applied yet
|
|
||||||
for _, migration := range migrations {
|
|
||||||
version := strings.TrimSuffix(migration, filepath.Ext(migration))
|
|
||||||
|
|
||||||
// Check if already applied
|
|
||||||
var count int
|
|
||||||
err := db.QueryRowContext(ctx,
|
|
||||||
"SELECT COUNT(*) FROM schema_migrations WHERE version = ?",
|
|
||||||
version,
|
|
||||||
).Scan(&count)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to check migration status: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if count > 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read and apply migration
|
|
||||||
content, err := schemaFS.ReadFile(filepath.Join("schema", migration))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to read migration %s: %w", migration, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = db.ExecContext(ctx, string(content))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to apply migration %s: %w", migration, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Record migration as applied
|
|
||||||
_, err = db.ExecContext(ctx,
|
|
||||||
"INSERT INTO schema_migrations (version) VALUES (?)",
|
|
||||||
version,
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to record migration %s: %w", migration, err)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
// logDebug logs at debug level when a logger is available.
|
||||||
|
func logDebug(log *slog.Logger, msg string, args ...any) {
|
||||||
|
if log != nil {
|
||||||
|
log.Debug(msg, args...)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
199
internal/database/database_test.go
Normal file
199
internal/database/database_test.go
Normal file
@@ -0,0 +1,199 @@
|
|||||||
|
package database
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
_ "modernc.org/sqlite" // SQLite driver registration
|
||||||
|
)
|
||||||
|
|
||||||
|
// openTestDB returns a fresh in-memory SQLite database.
|
||||||
|
func openTestDB(t *testing.T) *sql.DB {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
db, err := sql.Open("sqlite", ":memory:")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to open test db: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Cleanup(func() { db.Close() })
|
||||||
|
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyMigrations_CreatesSchemaAndTables(t *testing.T) {
|
||||||
|
db := openTestDB(t)
|
||||||
|
|
||||||
|
if err := ApplyMigrations(db); err != nil {
|
||||||
|
t.Fatalf("ApplyMigrations failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The schema_migrations table must exist and contain at least
|
||||||
|
// version "000" (the bootstrap) and "001" (the initial schema).
|
||||||
|
rows, err := db.Query("SELECT version FROM schema_migrations ORDER BY version")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to query schema_migrations: %v", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var versions []string
|
||||||
|
for rows.Next() {
|
||||||
|
var v string
|
||||||
|
if err := rows.Scan(&v); err != nil {
|
||||||
|
t.Fatalf("failed to scan version: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
versions = append(versions, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
t.Fatalf("row iteration error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(versions) < 2 {
|
||||||
|
t.Fatalf("expected at least 2 migrations recorded, got %d: %v", len(versions), versions)
|
||||||
|
}
|
||||||
|
|
||||||
|
if versions[0] != "000" {
|
||||||
|
t.Errorf("first recorded migration = %q, want %q", versions[0], "000")
|
||||||
|
}
|
||||||
|
|
||||||
|
if versions[1] != "001" {
|
||||||
|
t.Errorf("second recorded migration = %q, want %q", versions[1], "001")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify that the application tables created by 001.sql exist.
|
||||||
|
for _, table := range []string{"source_content", "source_metadata", "output_content", "request_cache", "negative_cache", "cache_stats"} {
|
||||||
|
var count int
|
||||||
|
|
||||||
|
err := db.QueryRow(
|
||||||
|
"SELECT COUNT(*) FROM sqlite_master WHERE type='table' AND name=?",
|
||||||
|
table,
|
||||||
|
).Scan(&count)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to check for table %s: %v", table, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if count != 1 {
|
||||||
|
t.Errorf("table %s does not exist after migrations", table)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplyMigrations_Idempotent(t *testing.T) {
|
||||||
|
db := openTestDB(t)
|
||||||
|
|
||||||
|
if err := ApplyMigrations(db); err != nil {
|
||||||
|
t.Fatalf("first ApplyMigrations failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Running a second time must succeed without errors.
|
||||||
|
if err := ApplyMigrations(db); err != nil {
|
||||||
|
t.Fatalf("second ApplyMigrations failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify no duplicate rows in schema_migrations.
|
||||||
|
var count int
|
||||||
|
|
||||||
|
err := db.QueryRow("SELECT COUNT(*) FROM schema_migrations WHERE version = '000'").Scan(&count)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to count 000 rows: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if count != 1 {
|
||||||
|
t.Errorf("expected exactly 1 row for version 000, got %d", count)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBootstrapMigrationsTable_FreshDatabase(t *testing.T) {
|
||||||
|
db := openTestDB(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := bootstrapMigrationsTable(ctx, db, nil); err != nil {
|
||||||
|
t.Fatalf("bootstrapMigrationsTable failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// schema_migrations table must exist.
|
||||||
|
var tableCount int
|
||||||
|
|
||||||
|
err := db.QueryRow(
|
||||||
|
"SELECT COUNT(*) FROM sqlite_master WHERE type='table' AND name='schema_migrations'",
|
||||||
|
).Scan(&tableCount)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to check for table: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if tableCount != 1 {
|
||||||
|
t.Fatalf("schema_migrations table not created")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Version "000" must be recorded.
|
||||||
|
var recorded int
|
||||||
|
|
||||||
|
err = db.QueryRow(
|
||||||
|
"SELECT COUNT(*) FROM schema_migrations WHERE version = '000'",
|
||||||
|
).Scan(&recorded)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to check version: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if recorded != 1 {
|
||||||
|
t.Errorf("expected version 000 to be recorded, got count %d", recorded)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBootstrapMigrationsTable_ExistingTableBackwardsCompat(t *testing.T) {
|
||||||
|
db := openTestDB(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
// Simulate an older database that created the table via inline SQL
|
||||||
|
// (without recording version "000").
|
||||||
|
_, err := db.Exec(`
|
||||||
|
CREATE TABLE schema_migrations (
|
||||||
|
version TEXT PRIMARY KEY,
|
||||||
|
applied_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||||
|
)
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to create legacy table: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Insert a fake migration to prove the table already existed.
|
||||||
|
_, err = db.Exec("INSERT INTO schema_migrations (version) VALUES ('001')")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to insert legacy version: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := bootstrapMigrationsTable(ctx, db, nil); err != nil {
|
||||||
|
t.Fatalf("bootstrapMigrationsTable failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Version "000" must now be recorded.
|
||||||
|
var recorded int
|
||||||
|
|
||||||
|
err = db.QueryRow(
|
||||||
|
"SELECT COUNT(*) FROM schema_migrations WHERE version = '000'",
|
||||||
|
).Scan(&recorded)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to check version: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if recorded != 1 {
|
||||||
|
t.Errorf("expected version 000 to be recorded for legacy DB, got count %d", recorded)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The existing "001" row must still be there.
|
||||||
|
var legacyCount int
|
||||||
|
|
||||||
|
err = db.QueryRow(
|
||||||
|
"SELECT COUNT(*) FROM schema_migrations WHERE version = '001'",
|
||||||
|
).Scan(&legacyCount)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("failed to check legacy version: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if legacyCount != 1 {
|
||||||
|
t.Errorf("legacy version 001 row missing after bootstrap")
|
||||||
|
}
|
||||||
|
}
|
||||||
9
internal/database/schema/000.sql
Normal file
9
internal/database/schema/000.sql
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
-- Migration 000: Schema migrations tracking table
|
||||||
|
-- This must be the first migration applied. The bootstrap logic in
|
||||||
|
-- database.go applies it directly (bypassing the normal migration
|
||||||
|
-- loop) when the schema_migrations table does not yet exist.
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS schema_migrations (
|
||||||
|
version TEXT PRIMARY KEY,
|
||||||
|
applied_at DATETIME DEFAULT CURRENT_TIMESTAMP
|
||||||
|
);
|
||||||
Reference in New Issue
Block a user