fix: Remove required Close from database.Migrate (#25)

kylecarbs · web-flow · commit 5c49f1f15ff4 · 2022-01-14T10:30:26.000-06:00
* fix: Remove required Close from database.Migrate

* Remove dbName from Migrate function arguments

* Fix func call
diff --git a/database/dump/main.go b/database/dump/main.go
@@ -25,7 +25,7 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
-	err = database.Migrate(context.Background(), "postgres", db)
+	err = database.Migrate(context.Background(), db)
 	if err != nil {
 		panic(err)
 	}
diff --git a/database/migrate.go b/database/migrate.go
@@ -16,7 +16,7 @@ import (
 var migrations embed.FS
 
 // Migrate runs SQL migrations to ensure the database schema is up-to-date.
-func Migrate(ctx context.Context, dbName string, db *sql.DB) error {
+func Migrate(ctx context.Context, db *sql.DB) error {
 	sourceDriver, err := iofs.New(migrations, "migrations")
 	if err != nil {
 		return xerrors.Errorf("create iofs: %w", err)
@@ -25,7 +25,7 @@ func Migrate(ctx context.Context, dbName string, db *sql.DB) error {
 	if err != nil {
 		return xerrors.Errorf("wrap postgres connection: %w", err)
 	}
-	m, err := migrate.NewWithInstance("", sourceDriver, dbName, dbDriver)
+	m, err := migrate.NewWithInstance("", sourceDriver, "", dbDriver)
 	if err != nil {
 		return xerrors.Errorf("migrate: %w", err)
 	}
@@ -37,12 +37,5 @@ func Migrate(ctx context.Context, dbName string, db *sql.DB) error {
 		}
 		return xerrors.Errorf("up: %w", err)
 	}
-	srcErr, dbErr := m.Close()
-	if srcErr != nil {
-		return xerrors.Errorf("close source: %w", err)
-	}
-	if dbErr != nil {
-		return xerrors.Errorf("close database: %w", err)
-	}
 	return nil
 }
diff --git a/database/migrate_test.go b/database/migrate_test.go
@@ -7,10 +7,11 @@ import (
 	"database/sql"
 	"testing"
 
-	"github.com/coder/coder/database"
-	"github.com/coder/coder/database/postgres"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/goleak"
+
+	"github.com/coder/coder/database"
+	"github.com/coder/coder/database/postgres"
 )
 
 func TestMain(m *testing.M) {
@@ -25,6 +26,7 @@ func TestMigrate(t *testing.T) {
 	defer closeFn()
 	db, err := sql.Open("postgres", connection)
 	require.NoError(t, err)
-	err = database.Migrate(context.Background(), "postgres", db)
+	defer db.Close()
+	err = database.Migrate(context.Background(), db)
 	require.NoError(t, err)
 }
diff --git a/database/pubsub_memory_test.go b/database/pubsub_memory_test.go
@@ -4,9 +4,10 @@ import (
 	"context"
 	"testing"
 
-	"github.com/coder/coder/database"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/database"
 )
 
 func TestPubsubMemory(t *testing.T) {
diff --git a/database/pubsub_test.go b/database/pubsub_test.go
@@ -7,10 +7,11 @@ import (
 	"database/sql"
 	"testing"
 
-	"github.com/coder/coder/database"
-	"github.com/coder/coder/database/postgres"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/coder/coder/database"
+	"github.com/coder/coder/database/postgres"
 )
 
 func TestPubsub(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ func main() {`
`25`	`25`	`if err != nil {`
`26`	`26`	`panic(err)`
`27`	`27`	`}`
`28`		`- err = database.Migrate(context.Background(), "postgres", db)`
	`28`	`+ err = database.Migrate(context.Background(), db)`
`29`	`29`	`if err != nil {`
`30`	`30`	`panic(err)`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ import (`
`16`	`16`	`var migrations embed.FS`
`17`	`17`
`18`	`18`	`// Migrate runs SQL migrations to ensure the database schema is up-to-date.`
`19`		`-func Migrate(ctx context.Context, dbName string, db *sql.DB) error {`
	`19`	`+func Migrate(ctx context.Context, db *sql.DB) error {`
`20`	`20`	`sourceDriver, err := iofs.New(migrations, "migrations")`
`21`	`21`	`if err != nil {`
`22`	`22`	`return xerrors.Errorf("create iofs: %w", err)`
`@@ -25,7 +25,7 @@ func Migrate(ctx context.Context, dbName string, db *sql.DB) error {`
`25`	`25`	`if err != nil {`
`26`	`26`	`return xerrors.Errorf("wrap postgres connection: %w", err)`
`27`	`27`	`}`
`28`		`- m, err := migrate.NewWithInstance("", sourceDriver, dbName, dbDriver)`
	`28`	`+ m, err := migrate.NewWithInstance("", sourceDriver, "", dbDriver)`
`29`	`29`	`if err != nil {`
`30`	`30`	`return xerrors.Errorf("migrate: %w", err)`
`31`	`31`	`}`
`@@ -37,12 +37,5 @@ func Migrate(ctx context.Context, dbName string, db *sql.DB) error {`
`37`	`37`	`}`
`38`	`38`	`return xerrors.Errorf("up: %w", err)`
`39`	`39`	`}`
`40`		`- srcErr, dbErr := m.Close()`
`41`		`- if srcErr != nil {`
`42`		`- return xerrors.Errorf("close source: %w", err)`
`43`		`- }`
`44`		`- if dbErr != nil {`
`45`		`- return xerrors.Errorf("close database: %w", err)`
`46`		`- }`
`47`	`40`	`return nil`
`48`	`41`	`}`