Skip to content

Commit

Permalink
revert go migration changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@ori-shalom
ori-shalom committed Jun 10, 2023
1 parent a2c6375 commit ff8f849
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 105 deletions.
7 changes: 3 additions & 4 deletions create.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,21 +99,20 @@ SELECT 'down SQL query';
var goSQLMigrationTemplate = template.Must(template.New("goose.go-migration").Parse(`package migrations
import (
"context"
"database/sql"
"github.com/pressly/goose/v3"
)
func init() {
goose.AddMigrationContext(up{{.CamelName}}, down{{.CamelName}})
goose.AddMigration(up{{.CamelName}}, down{{.CamelName}})
}
func up{{.CamelName}}(ctx context.Context, tx *sql.Tx) error {
func up{{.CamelName}}(tx *sql.Tx) error {
// This code is executed when the migration is applied.
return nil
}
func down{{.CamelName}}(ctx context.Context, tx *sql.Tx) error {
func down{{.CamelName}}(tx *sql.Tx) error {
// This code is executed when the migration is rolled back.
return nil
}
Expand Down
93 changes: 15 additions & 78 deletions migrate.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,86 +128,30 @@ func (ms Migrations) String() string {
// GoMigration is a Go migration func that is run within a transaction.
type GoMigration func(tx *sql.Tx) error

// GoMigrationContext is a Go migration func that is run within a transaction and receives a context.
type GoMigrationContext func(ctx context.Context, tx *sql.Tx) error

// GoMigrationNoTx is a Go migration func that is run outside a transaction.
type GoMigrationNoTx func(db *sql.DB) error

// GoMigrationNoTxContext is a Go migration func that is run outside a transaction and receives a context.
type GoMigrationNoTxContext func(ctx context.Context, db *sql.DB) error

// withoutContext wraps a GoMigration to make it a GoMigrationContext.
func (gm GoMigrationContext) withoutContext() GoMigration {
return func(tx *sql.Tx) error {
return gm(context.Background(), tx)
}
}

// withContext wraps a GoMigration to make it a GoMigrationContext.
func (gm GoMigrationNoTxContext) withoutContext() GoMigrationNoTx {
return func(db *sql.DB) error {
return gm(context.Background(), db)
}
}

// withContext wraps a GoMigration to make it a GoMigrationContext.
func (gm GoMigration) withContext() GoMigrationContext {
return func(_ context.Context, tx *sql.Tx) error {
return gm(tx)
}
}

// withContext wraps a GoMigrationNoTx to make it a GoMigrationNoTxContext.
func (gm GoMigrationNoTx) withContext() GoMigrationNoTxContext {
return func(_ context.Context, db *sql.DB) error {
return gm(db)
}
}

// AddMigration adds Go migrations.
func AddMigration(up, down GoMigration) {
_, filename, _, _ := runtime.Caller(1)
// intentionally don't call to AddMigrationContext so each of these functions can calculate the filename correctly
AddNamedMigrationContext(filename, up.withContext(), down.withContext())
}

// AddMigration adds Go migrations.
func AddMigrationContext(up, down GoMigrationContext) {
_, filename, _, _ := runtime.Caller(1)
AddNamedMigrationContext(filename, up, down)
AddNamedMigration(filename, up, down)
}

// AddNamedMigration adds named Go migrations.
func AddNamedMigration(filename string, up, down GoMigration) {
AddNamedMigrationContext(filename, up.withContext(), down.withContext())
}

// AddNamedMigrationContext adds named Go migrations.
func AddNamedMigrationContext(filename string, up, down GoMigrationContext) {
if err := register(filename, true, up, down, nil, nil); err != nil {
panic(err)
}
}

// AddMigrationNoTx adds Go migrations that will be run outside transaction.
func AddMigrationNoTx(up, down GoMigrationNoTx) {
AddMigrationNoTxContext(up.withContext(), down.withContext())
}

// AddMigrationNoTxContext adds Go migrations that will be run outside transaction.
func AddMigrationNoTxContext(up, down GoMigrationNoTxContext) {
_, filename, _, _ := runtime.Caller(2)
AddNamedMigrationNoTxContext(filename, up, down)
_, filename, _, _ := runtime.Caller(1)
AddNamedMigrationNoTx(filename, up, down)
}

// AddNamedMigrationNoTx adds named Go migrations that will be run outside transaction.
func AddNamedMigrationNoTx(filename string, up, down GoMigrationNoTx) {
AddNamedMigrationNoTxContext(filename, up.withContext(), down.withContext())
}

// AddNamedMigrationNoTxContext adds named Go migrations that will be run outside transaction.
func AddNamedMigrationNoTxContext(filename string, up, down GoMigrationNoTxContext) {
if err := register(filename, false, nil, nil, up, down); err != nil {
panic(err)
}
Expand All @@ -216,8 +160,8 @@ func AddNamedMigrationNoTxContext(filename string, up, down GoMigrationNoTxConte
func register(
filename string,
useTx bool,
up, down GoMigrationContext,
upNoTx, downNoTx GoMigrationNoTxContext,
up, down GoMigration,
upNoTx, downNoTx GoMigrationNoTx,
) error {
// Sanity check caller did not mix tx and non-tx based functions.
if (up != nil || down != nil) && (upNoTx != nil || downNoTx != nil) {
Expand All @@ -233,23 +177,16 @@ func register(
}
// Add to global as a registered migration.
registeredGoMigrations[v] = &Migration{
Version: v,
Next: -1,
Previous: -1,
Registered: true,
Source: filename,
UseTx: useTx,
UpFnContext: up,
DownFnContext: down,
UpFnNoTxContext: upNoTx,
DownFnNoTxContext: downNoTx,
// These are deprecated and will be removed in the future.
// For backwards compatibility we still save the non-context versions in the struct in case someone is using them.
// Goose does not use these internally anymore and instead uses the context versions.
UpFn: up.withoutContext(),
DownFn: down.withoutContext(),
UpFnNoTx: upNoTx.withoutContext(),
DownFnNoTx: downNoTx.withoutContext(),
Version: v,
Next: -1,
Previous: -1,
Registered: true,
Source: filename,
UseTx: useTx,
UpFn: up,
DownFn: down,
UpFnNoTx: upNoTx,
DownFnNoTx: downNoTx,
}
return nil
}
Expand Down
38 changes: 15 additions & 23 deletions migration.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,15 @@ type MigrationRecord struct {

// Migration struct.
type Migration struct {
Version int64
Next int64 // next version, or -1 if none
Previous int64 // previous version, -1 if none
Source string // path to .sql script or go file
Registered bool
UseTx bool

// These are deprecated and will be removed in the future.
// For backwards compatibility we still save the non-context versions in the struct in case someone is using them.
// Goose does not use these internally anymore and instead uses the context versions.
Version int64
Next int64 // next version, or -1 if none
Previous int64 // previous version, -1 if none
Source string // path to .sql script or go file
Registered bool
UseTx bool
UpFn, DownFn GoMigration
UpFnNoTx, DownFnNoTx GoMigrationNoTx

// New functions with context
UpFnContext, DownFnContext GoMigrationContext
UpFnNoTxContext, DownFnNoTxContext GoMigrationNoTxContext
noVersioning bool
noVersioning bool
}

func (m *Migration) String() string {
Expand Down Expand Up @@ -107,9 +99,9 @@ func (m *Migration) run(ctx context.Context, db *sql.DB, direction bool) error {
var empty bool
if m.UseTx {
// Run go-based migration inside a tx.
fn := m.DownFnContext
fn := m.DownFn
if direction {
fn = m.UpFnContext
fn = m.UpFn
}
empty = (fn == nil)
if err := runGoMigration(
Expand All @@ -124,9 +116,9 @@ func (m *Migration) run(ctx context.Context, db *sql.DB, direction bool) error {
}
} else {
// Run go-based migration outside a tx.
fn := m.DownFnNoTxContext
fn := m.DownFnNoTx
if direction {
fn = m.UpFnNoTxContext
fn = m.UpFnNoTx
}
empty = (fn == nil)
if err := runGoMigrationNoTx(
Expand All @@ -153,14 +145,14 @@ func (m *Migration) run(ctx context.Context, db *sql.DB, direction bool) error {
func runGoMigrationNoTx(
ctx context.Context,
db *sql.DB,
fn GoMigrationNoTxContext,
fn GoMigrationNoTx,
version int64,
direction bool,
recordVersion bool,
) error {
if fn != nil {
// Run go migration function.
if err := fn(ctx, db); err != nil {
if err := fn(db); err != nil {
return fmt.Errorf("failed to run go migration: %w", err)
}
}
Expand All @@ -173,7 +165,7 @@ func runGoMigrationNoTx(
func runGoMigration(
ctx context.Context,
db *sql.DB,
fn GoMigrationContext,
fn GoMigration,
version int64,
direction bool,
recordVersion bool,
Expand All @@ -187,7 +179,7 @@ func runGoMigration(
}
if fn != nil {
// Run go migration function.
if err := fn(ctx, tx); err != nil {
if err := fn(tx); err != nil {
_ = tx.Rollback()
return fmt.Errorf("failed to run go migration: %w", err)
}
Expand Down

0 comments on commit ff8f849

Please sign in to comment.