Migrate to Xormigrate

go.mod

@@ -133,6 +133,7 @@ require (
 	gopkg.in/ini.v1 v1.67.0
 	gopkg.in/yaml.v3 v3.0.1
 	mvdan.cc/xurls/v2 v2.5.0
+	src.techknowlogick.com/xormigrate v1.7.1
 	strk.kbt.io/projects/go/libravatar v0.0.0-20191008002943-06d1c002b251
 	xorm.io/builder v0.3.13
 	xorm.io/xorm v1.3.9

models/migrations/migrations.go

@@ -27,45 +27,15 @@ import (
 	"code.gitea.io/gitea/models/migrations/v1_8"
 	"code.gitea.io/gitea/models/migrations/v1_9"
 	"code.gitea.io/gitea/modules/git"
-	"code.gitea.io/gitea/modules/log"
-	"code.gitea.io/gitea/modules/setting"
 
+	"src.techknowlogick.com/xormigrate"
 	"xorm.io/xorm"
 	"xorm.io/xorm/names"
 )
 
-const minDBVersion = 70 // Gitea 1.5.3
-
-// Migration describes on migration from lower version to high version
-type Migration interface {
-	Description() string
-	Migrate(*xorm.Engine) error
-}
-
-type migration struct {
-	description string
-	migrate     func(*xorm.Engine) error
-}
-
 // NewMigration creates a new migration
-func NewMigration(desc string, fn func(*xorm.Engine) error) Migration {
-	return &migration{desc, fn}
-}
-
-// Description returns the migration's description
-func (m *migration) Description() string {
-	return m.description
-}
-
-// Migrate executes the migration
-func (m *migration) Migrate(x *xorm.Engine) error {
-	return m.migrate(x)
-}
-
-// Version describes the version table. Should have only one row with id==1
-type Version struct {
-	ID      int64 `xorm:"pk autoincr"`
-	Version int64
+func NewMigration(desc string, fn func(*xorm.Engine) error) *xormigrate.Migration {
+	return &xormigrate.Migration{ID: desc, Migrate: fn}
 }
 
 // Use noopMigration when there is a migration that has been no-oped
@@ -74,7 +44,10 @@ var noopMigration = func(_ *xorm.Engine) error { return nil }
 // This is a sequence of migrations. Add new migrations to the bottom of the list.
 // If you want to "retire" a migration, remove it from the top of the list and
 // update minDBVersion accordingly
-var migrations = []Migration{
+var migrations = []*xormigrate.Migration{
+	// Migration to Xormigrate must happen before anything else happens
+	NewMigration("Migrate to Xormigrate", v1_23.MigrateToXormigrate),
+
 	// Gitea 1.5.0 ends at v69
 
 	// v70 -> v71
@@ -157,7 +130,7 @@ var migrations = []Migration{
 	// Gitea 1.10.0 ends at v102
 
 	// v102 -> v103
-	NewMigration("update migration repositories' service type", v1_11.DropColumnHeadUserNameOnPullRequest),
+	NewMigration("update migration repositories' service type v2", v1_11.DropColumnHeadUserNameOnPullRequest),
 	// v103 -> v104
 	NewMigration("Add WhitelistDeployKeys to protected branch", v1_11.AddWhitelistDeployKeysToBranches),
 	// v104 -> v105
@@ -605,112 +578,49 @@ var migrations = []Migration{
 	NewMigration("Add Repository Licenses", v1_23.AddRepositoryLicenses),
 }
 
-// GetCurrentDBVersion returns the current db version
-func GetCurrentDBVersion(x *xorm.Engine) (int64, error) {
-	if err := x.Sync(new(Version)); err != nil {
-		return -1, fmt.Errorf("sync: %w", err)
-	}
-
-	currentVersion := &Version{ID: 1}
-	has, err := x.Get(currentVersion)
-	if err != nil {
-		return -1, fmt.Errorf("get: %w", err)
-	}
-	if !has {
-		return -1, nil
-	}
-	return currentVersion.Version, nil
-}
-
-// ExpectedVersion returns the expected db version
-func ExpectedVersion() int64 {
-	return int64(minDBVersion + len(migrations))
-}
-
 // EnsureUpToDate will check if the db is at the correct version
 func EnsureUpToDate(x *xorm.Engine) error {
-	currentDB, err := GetCurrentDBVersion(x)
-	if err != nil {
-		return err
-	}
-
-	if currentDB < 0 {
-		return fmt.Errorf("Database has not been initialized")
-	}
-
-	if minDBVersion > currentDB {
-		return fmt.Errorf("DB version %d (<= %d) is too old for auto-migration. Upgrade to Gitea 1.6.4 first then upgrade to this version", currentDB, minDBVersion)
-	}
-
-	expected := ExpectedVersion()
-
-	if currentDB != expected {
-		return fmt.Errorf(`Current database version %d is not equal to the expected version %d. Please run "gitea [--config /path/to/app.ini] migrate" to update the database version`, currentDB, expected)
+	for _, m := range migrations {
+		count, err := x.
+			In("id", m.ID).
+			Count(&xormigrate.Migration{})
+		if err != nil {
+			return err
+		}
+		if count < 1 {
+			return fmt.Errorf("Database misses migration %s", m.ID)
+		}
 	}
 
 	return nil
 }
 
+// EnsureUpToDate will check if the db is completely new
+func IsFreshDB(x *xorm.Engine) (bool, error) {
+	exist, err := x.IsTableExist(&xormigrate.Migration{})
+	return !exist, err
+}
+
 // Migrate database to current version
 func Migrate(x *xorm.Engine) error {
 	// Set a new clean the default mapper to GonicMapper as that is the default for Gitea.
 	x.SetMapper(names.GonicMapper{})
-	if err := x.Sync(new(Version)); err != nil {
-		return fmt.Errorf("sync: %w", err)
-	}
-
-	currentVersion := &Version{ID: 1}
-	has, err := x.Get(currentVersion)
-	if err != nil {
-		return fmt.Errorf("get: %w", err)
-	} else if !has {
-		// If the version record does not exist we think
-		// it is a fresh installation and we can skip all migrations.
-		currentVersion.ID = 0
-		currentVersion.Version = int64(minDBVersion + len(migrations))
-
-		if _, err = x.InsertOne(currentVersion); err != nil {
-			return fmt.Errorf("insert: %w", err)
-		}
-	}
-
-	v := currentVersion.Version
-	if minDBVersion > v {
-		log.Fatal(`Gitea no longer supports auto-migration from your previously installed version.
-Please try upgrading to a lower version first (suggested v1.6.4), then upgrade to this version.`)
-		return nil
-	}
-
-	// Downgrading Gitea's database version not supported
-	if int(v-minDBVersion) > len(migrations) {
-		msg := fmt.Sprintf("Your database (migration version: %d) is for a newer Gitea, you can not use the newer database for this old Gitea release (%d).", v, minDBVersion+len(migrations))
-		msg += "\nGitea will exit to keep your database safe and unchanged. Please use the correct Gitea release, do not change the migration version manually (incorrect manual operation may lose data)."
-		if !setting.IsProd {
-			msg += fmt.Sprintf("\nIf you are in development and really know what you're doing, you can force changing the migration version by executing: UPDATE version SET version=%d WHERE id=1;", minDBVersion+len(migrations))
-		}
-		log.Fatal("Migration Error: %s", msg)
-		return nil
-	}
 
 	// Some migration tasks depend on the git command
 	if git.DefaultContext == nil {
-		if err = git.InitSimple(context.Background()); err != nil {
+		if err := git.InitSimple(context.Background()); err != nil {
 			return err
 		}
 	}
 
 	// Migrate
-	for i, m := range migrations[v-minDBVersion:] {
-		log.Info("Migration[%d]: %s", v+int64(i), m.Description())
-		// Reset the mapper between each migration - migrations are not supposed to depend on each other
-		x.SetMapper(names.GonicMapper{})
-		if err = m.Migrate(x); err != nil {
-			return fmt.Errorf("migration[%d]: %s failed: %w", v+int64(i), m.Description(), err)
-		}
-		currentVersion.Version = v + int64(i) + 1
-		if _, err = x.ID(1).Update(currentVersion); err != nil {
-			return err
-		}
+	m := xormigrate.New(x, migrations)
+
+	if exist, _ := x.IsTableExist("version"); !exist {
+		// if the version table exists, we still have the old migration system
+		// and the schema init should not run then
+		m.InitSchema(noopMigration)
 	}
-	return nil
+
+	return m.Migrate()
 }