shiori/internal/database/migrations.go
Felipe Martin 31767f75e6
feat: new migrations system (#876)
* feat: new migration system

* use newFuncMigration

* database version -> database schema version

* column name

* use path instead of filepath for goembed

* simplified migrations, added backwards compatible migrations
2024-04-27 07:46:36 +02:00

97 lines
2.6 KiB
Go

package database
import (
"context"
"database/sql"
"embed"
"fmt"
"path"
"github.com/blang/semver"
)
//go:embed migrations/*
var migrationFiles embed.FS
type migration struct {
fromVersion semver.Version
toVersion semver.Version
migrationFunc func(db *sql.DB) error
}
// txFunc is a function that runs in a transaction.
type txFn func(tx *sql.Tx) error
// runInTransaction runs the given function in a transaction.
func runInTransaction(db *sql.DB, fn txFn) error {
tx, err := db.Begin()
if err != nil {
return fmt.Errorf("failed to start transaction: %w", err)
}
defer tx.Rollback()
if err := fn(tx); err != nil {
return fmt.Errorf("failed to run transaction: %w", err)
}
if err := tx.Commit(); err != nil {
return fmt.Errorf("failed to commit transaction: %w", err)
}
return nil
}
// newFuncMigration creates a new migration from a function.
func newFuncMigration(fromVersion, toVersion string, migrationFunc func(db *sql.DB) error) migration {
return migration{
fromVersion: semver.MustParse(fromVersion),
toVersion: semver.MustParse(toVersion),
migrationFunc: migrationFunc,
}
}
// newFileMigration creates a new migration from a file.
func newFileMigration(fromVersion, toVersion, filename string) migration {
return newFuncMigration(fromVersion, toVersion, func(db *sql.DB) error {
return runInTransaction(db, func(tx *sql.Tx) error {
migrationSQL, err := migrationFiles.ReadFile(path.Join("migrations", filename+".up.sql"))
if err != nil {
return fmt.Errorf("failed to read migration file: %w", err)
}
if _, err := tx.Exec(string(migrationSQL)); err != nil {
return fmt.Errorf("failed to execute migration %s to %s: %w", fromVersion, toVersion, err)
}
return nil
})
})
}
// runMigrations runs the given migrations.
func runMigrations(ctx context.Context, db DB, migrations []migration) error {
currentVersion := semver.Version{}
// Get current database version
dbVersion, err := db.GetDatabaseSchemaVersion(ctx)
if err == nil && dbVersion != "" {
currentVersion = semver.MustParse(dbVersion)
}
for _, migration := range migrations {
if !currentVersion.EQ(migration.fromVersion) {
continue
}
if err := migration.migrationFunc(db.DBx().DB); err != nil {
return fmt.Errorf("failed to run migration from %s to %s: %w", migration.fromVersion, migration.toVersion, err)
}
currentVersion = migration.toVersion
if err := db.SetDatabaseSchemaVersion(ctx, currentVersion.String()); err != nil {
return fmt.Errorf("failed to store database version %s from %s to %s: %w", currentVersion.String(), migration.fromVersion, migration.toVersion, err)
}
}
return nil
}