[优化] 重构数据库迁移逻辑，整合遗留和Goose迁移处理

2026-10-08 00:26:37 +08:00 · 2026-06-02 23:35:02 +08:00
parent 4ca6f2957b
commit a0e9484e37
10 changed files with 312 additions and 134 deletions
@@ -0,0 +1,223 @@
+package goose
+
+import (
+	"database/sql"
+	"errors"
+	"fmt"
+	"log/slog"
+
+	"gorm.io/gorm"
+)
+
+type BridgeContext interface {
+	Context
+	AutoMigrateLegacySchemaMetadata(db *gorm.DB) error
+	InitializeFreshDatabaseSchema(db *gorm.DB, backend string) error
+	IsDatabaseEmpty(db *gorm.DB) (bool, error)
+	RepairCurrentSchemaState(db *gorm.DB, backend string) error
+	SaveLegacyDatabaseSchemaVersion(db *gorm.DB, version int) error
+	UpgradeLegacyDatabaseSchema(db *gorm.DB, backend string, version int) error
+	ValidateCurrentDatabaseSchema(db *gorm.DB, backend string) error
+}
+
+type schemaMigrationState int
+
+const (
+	schemaMigrationStateFresh schemaMigrationState = iota
+	schemaMigrationStateLegacyOnly
+	schemaMigrationStateGooseOnly
+	schemaMigrationStateLegacyBootstrap
+	schemaMigrationStateMixed
+)
+
+func detectSchemaState(db *gorm.DB, ctx BridgeContext) (schemaMigrationState, error) {
+	hasLegacyTable := db.Migrator().HasTable("database_schema_versions")
+	hasGooseTable := db.Migrator().HasTable("goose_db_version")
+
+	switch {
+	case hasLegacyTable && hasGooseTable:
+		return schemaMigrationStateMixed, nil
+	case hasLegacyTable:
+		return schemaMigrationStateLegacyOnly, nil
+	case hasGooseTable:
+		return schemaMigrationStateGooseOnly, nil
+	}
+
+	empty, err := ctx.IsDatabaseEmpty(db)
+	if err != nil {
+		return 0, err
+	}
+	if empty {
+		return schemaMigrationStateFresh, nil
+	}
+	return schemaMigrationStateLegacyBootstrap, nil
+}
+
+func LoadDatabaseVersion(db *gorm.DB) (int, bool, error) {
+	if db == nil || !db.Migrator().HasTable("goose_db_version") {
+		return 0, false, nil
+	}
+
+	var version int64
+	err := db.Table("goose_db_version").
+		Where("is_applied = ?", true).
+		Order("version_id DESC").
+		Select("version_id").
+		Limit(1).
+		Row().
+		Scan(&version)
+	if errors.Is(err, sql.ErrNoRows) {
+		return 0, false, nil
+	}
+	if err != nil {
+		return 0, false, err
+	}
+	return int(version), true, nil
+}
+
+func loadLegacyDatabaseSchemaVersion(db *gorm.DB) (int, bool, error) {
+	if db == nil || !db.Migrator().HasTable("database_schema_versions") {
+		return 0, false, nil
+	}
+
+	var version int
+	err := db.Table("database_schema_versions").
+		Where("id = ?", 1).
+		Select("version").
+		Limit(1).
+		Row().
+		Scan(&version)
+	if errors.Is(err, sql.ErrNoRows) {
+		return 0, false, nil
+	}
+	if err != nil {
+		return 0, false, err
+	}
+	return version, true, nil
+}
+
+func bootstrapLegacySchemaVersion(db *gorm.DB, ctx BridgeContext) error {
+	if err := ctx.AutoMigrateLegacySchemaMetadata(db); err != nil {
+		return err
+	}
+	version, exists, err := loadLegacyDatabaseSchemaVersion(db)
+	if err != nil {
+		return err
+	}
+	if exists {
+		if int64(version) > LegacyBridgeVersion {
+			return fmt.Errorf("legacy schema version %d is newer than supported terminal version %d", version, LegacyBridgeVersion)
+		}
+		return nil
+	}
+	return ctx.SaveLegacyDatabaseSchemaVersion(db, 7)
+}
+
+func upgradeLegacyToTerminal(db *gorm.DB, backend string, ctx BridgeContext) error {
+	if err := bootstrapLegacySchemaVersion(db, ctx); err != nil {
+		return err
+	}
+	version, exists, err := loadLegacyDatabaseSchemaVersion(db)
+	if err != nil {
+		return err
+	}
+	if !exists {
+		return fmt.Errorf("legacy schema version record is missing after bootstrap")
+	}
+	return ctx.UpgradeLegacyDatabaseSchema(db, backend, version)
+}
+
+func validateGooseBridgeState(db *gorm.DB) error {
+	version, exists, err := LoadDatabaseVersion(db)
+	if err != nil {
+		return err
+	}
+	if !exists {
+		return nil
+	}
+	if int64(version) < LegacyBridgeVersion {
+		return fmt.Errorf("goose schema version %d is below legacy bridge baseline %d", version, LegacyBridgeVersion)
+	}
+	if int64(version) > CurrentTargetVersion() {
+		return fmt.Errorf("goose schema version %d is newer than application target version %d", version, CurrentTargetVersion())
+	}
+	return nil
+}
+
+func finalizeLegacyToGooseBridge(db *gorm.DB) error {
+	gooseVersion, exists, err := LoadDatabaseVersion(db)
+	if err != nil {
+		return err
+	}
+	if !exists || int64(gooseVersion) < LegacyBridgeVersion {
+		return nil
+	}
+	if !db.Migrator().HasTable("database_schema_versions") {
+		return nil
+	}
+	if err := db.Exec("DROP TABLE IF EXISTS database_schema_versions").Error; err != nil {
+		return fmt.Errorf("drop legacy schema versions table failed: %w", err)
+	}
+	slog.Info("completed legacy-to-goose migration bridge", "goose_version", gooseVersion)
+	return nil
+}
+
+func ValidateRegisteredSchema(db *gorm.DB) error {
+	if err := validateNodeCapabilitiesJSON(db); err != nil {
+		return err
+	}
+	return nil
+}
+
+func EnsureDatabaseSchemaUpToDate(db *gorm.DB, backend string, ctx BridgeContext) error {
+	state, err := detectSchemaState(db, ctx)
+	if err != nil {
+		return err
+	}
+
+	switch state {
+	case schemaMigrationStateFresh:
+		if err := ctx.InitializeFreshDatabaseSchema(db, backend); err != nil {
+			return err
+		}
+	case schemaMigrationStateLegacyOnly:
+		if err := upgradeLegacyToTerminal(db, backend, ctx); err != nil {
+			return err
+		}
+	case schemaMigrationStateGooseOnly:
+		if err := validateGooseBridgeState(db); err != nil {
+			return err
+		}
+	case schemaMigrationStateLegacyBootstrap:
+		if err := upgradeLegacyToTerminal(db, backend, ctx); err != nil {
+			return err
+		}
+	case schemaMigrationStateMixed:
+		legacyVersion, exists, err := loadLegacyDatabaseSchemaVersion(db)
+		if err != nil {
+			return err
+		}
+		if exists && int64(legacyVersion) != LegacyBridgeVersion {
+			return fmt.Errorf("incomplete mixed migration state: legacy schema version %d does not match bridge terminal version %d", legacyVersion, LegacyBridgeVersion)
+		}
+		if err := validateGooseBridgeState(db); err != nil {
+			return err
+		}
+	default:
+		return fmt.Errorf("unknown schema migration state: %d", state)
+	}
+
+	if err := runMigrations(db, backend, ctx); err != nil {
+		return err
+	}
+	if err := finalizeLegacyToGooseBridge(db); err != nil {
+		return err
+	}
+	if err := ctx.RepairCurrentSchemaState(db, backend); err != nil {
+		return err
+	}
+	if err := ctx.ValidateCurrentDatabaseSchema(db, backend); err != nil {
+		return err
+	}
+	return ValidateRegisteredSchema(db)
+}
@@ -0,0 +1,50 @@
+package goose
+
+import (
+	"encoding/json"
+	"fmt"
+
+	presslygoose "github.com/pressly/goose/v3"
+	"gorm.io/gorm"
+)
+
+const versionNodeCapabilitiesJSON int64 = 202606020001
+
+// migration202606020001 adds a future-proof JSON field for node capability
+// summaries after the legacy v17 migration bridge.
+func migration202606020001(backend string, ctx Context) *presslygoose.Migration {
+	return newGORMMigration(
+		versionNodeCapabilitiesJSON,
+		"202606020001_add_node_capabilities_json.go",
+		backend,
+		ctx,
+		migrateNodeCapabilitiesJSON,
+	)
+}
+
+func migrateNodeCapabilitiesJSON(ctx Context, db *gorm.DB, backend string) error {
+	if err := ctx.ApplyCurrentSchema(db, backend); err != nil {
+		return err
+	}
+	emptyJSON, err := json.Marshal([]string{})
+	if err != nil {
+		return fmt.Errorf("marshal default node capabilities: %w", err)
+	}
+	if err := db.Exec(
+		`UPDATE nodes SET capabilities_json = ? WHERE capabilities_json IS NULL OR TRIM(capabilities_json) = ''`,
+		string(emptyJSON),
+	).Error; err != nil {
+		return fmt.Errorf("backfill nodes.capabilities_json: %w", err)
+	}
+	return validateNodeCapabilitiesJSON(db)
+}
+
+func validateNodeCapabilitiesJSON(db *gorm.DB) error {
+	if db == nil {
+		return fmt.Errorf("database handle is nil")
+	}
+	if !db.Migrator().HasColumn("nodes", "capabilities_json") {
+		return fmt.Errorf("column nodes.capabilities_json is missing")
+	}
+	return nil
+}
@@ -0,0 +1,71 @@
+package goose
+
+import (
+	"context"
+	"database/sql"
+	"fmt"
+
+	presslygoose "github.com/pressly/goose/v3"
+	"gorm.io/gorm"
+)
+
+const LegacyBridgeVersion int64 = 17
+
+type migrationFunc func(ctx Context, db *gorm.DB, backend string) error
+
+func newBaselineMigration() *presslygoose.Migration {
+	migration := presslygoose.NewGoMigration(LegacyBridgeVersion, nil, nil)
+	migration.Source = fmt.Sprintf("%05d_legacy_terminal_baseline.go", LegacyBridgeVersion)
+	return migration
+}
+
+func newGORMMigration(version int64, source string, backend string, ctx Context, up migrationFunc) *presslygoose.Migration {
+	migration := presslygoose.NewGoMigration(version, &presslygoose.GoFunc{
+		RunDB: func(_ context.Context, sqlDB *sql.DB) error {
+			gormDB, err := openGORMDB(ctx, sqlDB, backend)
+			if err != nil {
+				return err
+			}
+			if backend == "postgres" {
+				return gormDB.Transaction(func(tx *gorm.DB) error {
+					return up(ctx, tx, backend)
+				})
+			}
+			return up(ctx, gormDB, backend)
+		},
+	}, nil)
+	migration.Source = source
+	return migration
+}
+
+func registeredMigrations(backend string, ctx Context) []*presslygoose.Migration {
+	return []*presslygoose.Migration{
+		migration202606020001(backend, ctx),
+	}
+}
+
+func buildMigrations(backend string, ctx Context) []*presslygoose.Migration {
+	migrations := []*presslygoose.Migration{newBaselineMigration()}
+	migrations = append(migrations, registeredMigrations(backend, ctx)...)
+	return migrations
+}
+
+func CurrentTargetVersion() int64 {
+	var maxVersion int64 = LegacyBridgeVersion
+	for _, migration := range buildMigrations("sqlite", noopContext{}) {
+		if migration.Version > maxVersion {
+			maxVersion = migration.Version
+		}
+	}
+	return maxVersion
+}
+
+type noopContext struct{}
+
+func (noopContext) ApplyCurrentSchema(db *gorm.DB, backend string) error {
+	return nil
+}
+
+func (noopContext) RegisterSharding(db *gorm.DB, backend string) error {
+	return nil
+}
@@ -0,0 +1,81 @@
+package goose
+
+import (
+	"context"
+	"database/sql"
+	"fmt"
+
+	"github.com/glebarez/sqlite"
+	presslygoose "github.com/pressly/goose/v3"
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+	"gorm.io/gorm/schema"
+)
+
+type Context interface {
+	ApplyCurrentSchema(db *gorm.DB, backend string) error
+	RegisterSharding(db *gorm.DB, backend string) error
+}
+
+func dialectForBackend(backend string) (presslygoose.Dialect, error) {
+	switch backend {
+	case "postgres":
+		return presslygoose.DialectPostgres, nil
+	case "sqlite":
+		return presslygoose.DialectSQLite3, nil
+	default:
+		return "", fmt.Errorf("unsupported database backend: %s", backend)
+	}
+}
+
+func openGORMDB(ctx Context, db *sql.DB, backend string) (*gorm.DB, error) {
+	var dialector gorm.Dialector
+	switch backend {
+	case "postgres":
+		dialector = postgres.New(postgres.Config{Conn: db})
+	case "sqlite":
+		dialector = &sqlite.Dialector{Conn: db}
+	default:
+		return nil, fmt.Errorf("unsupported database backend: %s", backend)
+	}
+
+	gormDB, err := gorm.Open(dialector, &gorm.Config{
+		NamingStrategy: schema.NamingStrategy{},
+	})
+	if err != nil {
+		return nil, err
+	}
+	if err := ctx.RegisterSharding(gormDB, backend); err != nil {
+		return nil, err
+	}
+	return gormDB, nil
+}
+
+func buildProvider(db *gorm.DB, backend string, ctx Context) (*presslygoose.Provider, error) {
+	sqlDB, err := db.DB()
+	if err != nil {
+		return nil, err
+	}
+	dialect, err := dialectForBackend(backend)
+	if err != nil {
+		return nil, err
+	}
+	return presslygoose.NewProvider(
+		dialect,
+		sqlDB,
+		nil,
+		presslygoose.WithDisableGlobalRegistry(true),
+		presslygoose.WithGoMigrations(buildMigrations(backend, ctx)...),
+	)
+}
+
+func runMigrations(db *gorm.DB, backend string, ctx Context) error {
+	provider, err := buildProvider(db, backend, ctx)
+	if err != nil {
+		return fmt.Errorf("build goose provider: %w", err)
+	}
+	if _, err := provider.Up(context.Background()); err != nil {
+		return fmt.Errorf("goose up failed: %w", err)
+	}
+	return nil
+}