Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(migrate): use initialized pgx driver #1473

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/balance-worker/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ func main() {

entClient := entPostgresDriver.Client()

if err := startup.DB(ctx, conf.Postgres, entClient); err != nil {
if err := startup.DB(ctx, conf.Postgres, entClient, postgresDriver.DB()); err != nil {
logger.Error("failed to initialize database", "error", err)
os.Exit(1)
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/notification-service/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ func main() {
entClient := entPostgresDriver.Client()

// Run database schema creation
if err := startup.DB(ctx, conf.Postgres, entClient); err != nil {
if err := startup.DB(ctx, conf.Postgres, entClient, postgresDriver.DB()); err != nil {
logger.Error("failed to initialize database", "error", err)
os.Exit(1)
}
Expand Down
2 changes: 1 addition & 1 deletion cmd/server/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ func main() {

entClient := entPostgresDriver.Client()

if err := startup.DB(ctx, conf.Postgres, entClient); err != nil {
if err := startup.DB(ctx, conf.Postgres, entClient, postgresDriver.DB()); err != nil {
logger.Error("failed to initialize database", "error", err)
os.Exit(1)
}
Expand Down
8 changes: 6 additions & 2 deletions openmeter/entitlement/metered/utils_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,12 @@ func setupConnector(t *testing.T) (meteredentitlement.Connector, *dependencies)
m.Lock()
defer m.Unlock()
// migrate db
if err := migrate.Up(testdb.URL); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
if m, err := migrate.Default(testdb.SQLDriver); err == nil {
if err := m.Up(); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
}
} else {
t.Fatalf("failed to create migrate instance: %s", err.Error())
}

mockPublisher := eventbus.NewMock(t)
Expand Down
16 changes: 12 additions & 4 deletions openmeter/productcatalog/adapter/feature_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,12 @@ func TestCreateFeature(t *testing.T) {
dbClient := testdb.EntDriver.Client()
defer dbClient.Close()

if err := migrate.Up(testdb.URL); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
if m, err := migrate.Default(testdb.SQLDriver); err == nil {
if err := m.Up(); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
}
} else {
t.Fatalf("failed to create migrate instance: %s", err.Error())
}

dbConnector := adapter.NewPostgresFeatureRepo(dbClient, testutils.NewLogger(t))
Expand All @@ -239,8 +243,12 @@ func TestCreateFeature(t *testing.T) {
dbClient := testdb.EntDriver.Client()
defer dbClient.Close()

if err := migrate.Up(testdb.URL); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
if m, err := migrate.Default(testdb.SQLDriver); err == nil {
if err := m.Up(); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
}
} else {
t.Fatalf("failed to create migrate instance: %s", err.Error())
}

dbConnector := adapter.NewPostgresFeatureRepo(dbClient, testutils.NewLogger(t))
Expand Down
13 changes: 9 additions & 4 deletions openmeter/registry/startup/db.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,31 @@ package startup

import (
"context"
"database/sql"
"fmt"

"github.com/openmeterio/openmeter/config"
"github.com/openmeterio/openmeter/openmeter/ent/db"
"github.com/openmeterio/openmeter/tools/migrate"
)

func DB(ctx context.Context, cfg config.PostgresConfig, db *db.Client) error {
func DB(ctx context.Context, cfg config.PostgresConfig, client *db.Client, db *sql.DB) error {
if !cfg.AutoMigrate.Enabled() {
return nil
}

switch cfg.AutoMigrate {
case config.AutoMigrateEnt:
if err := db.Schema.Create(ctx); err != nil {
if err := client.Schema.Create(ctx); err != nil {
return fmt.Errorf("failed to migrate db: %w", err)
}
case config.AutoMigrateMigration:
if err := migrate.Up(cfg.URL); err != nil {
return fmt.Errorf("failed to migrate db: %w", err)
if m, err := migrate.Default(db); err == nil {
if err := m.Up(); err != nil {
return fmt.Errorf("failed to migrate db: %w", err)
}
} else {
return fmt.Errorf("failed to create migrate instance: %w", err)
}
}

Expand Down
1 change: 1 addition & 0 deletions openmeter/testutils/pg_driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ func InitPostgresDB(t *testing.T) *TestDB {

return &TestDB{
PGDriver: postgresDriver,
SQLDriver: postgresDriver.DB(),
EntDriver: entDriver,
URL: dbConf.URL(),
}
Expand Down
10 changes: 8 additions & 2 deletions test/entitlement/regression/framework_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,14 @@ func setupDependencies(t *testing.T) Dependencies {
driver := testutils.InitPostgresDB(t)
// init db
dbClient := db.NewClient(db.Driver(driver.EntDriver.Driver()))
if err := migrate.Up(driver.URL); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())

// Migrate
if m, err := migrate.Default(driver.SQLDriver); err == nil {
if err := m.Up(); err != nil {
t.Fatalf("failed to migrate db: %s", err.Error())
}
} else {
t.Fatalf("failed to create migrate instance: %s", err.Error())
}

// Init product catalog
Expand Down
60 changes: 37 additions & 23 deletions tools/migrate/migrate.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
package migrate

import (
"database/sql"
"embed"
"io/fs"
"net/url"

"github.com/golang-migrate/migrate/v4"
_ "github.com/golang-migrate/migrate/v4/database/postgres"
"github.com/golang-migrate/migrate/v4/database/postgres"
GAlexIHU marked this conversation as resolved.
Show resolved Hide resolved
"github.com/golang-migrate/migrate/v4/source/iofs"
)

Expand All @@ -20,21 +20,48 @@ type Migrate = migrate.Migrate
//go:embed migrations
var OMMigrations embed.FS

type Options struct {
DB *sql.DB
FS fs.FS
FSPath string
PGConfig *postgres.Config
}

// NewMigrate creates a new migrate instance.
func NewMigrate(conn string, fs fs.FS, fsPath string) (*Migrate, error) {
d, err := iofs.New(fs, fsPath)
func NewMigrate(opt Options) (*Migrate, error) {
d, err := iofs.New(opt.FS, opt.FSPath)
if err != nil {
return nil, err
}
return migrate.NewWithSourceInstance("iofs", d, conn)
}

func Up(conn string) error {
conn, err := SetMigrationTableName(conn, MigrationsTable)
driver, err := postgres.WithInstance(opt.DB, opt.PGConfig)
if err != nil {
return err
return nil, err
}
m, err := NewMigrate(conn, OMMigrations, "migrations")

return migrate.NewWithInstance("iofs", d, "postgres", driver)
}

func Default(db *sql.DB) (*Migrate, error) {
return NewMigrate(Options{
DB: db,
FS: OMMigrations,
FSPath: "migrations",
PGConfig: &postgres.Config{
MigrationsTable: MigrationsTable,
},
})
}

func Up(db *sql.DB) error {
m, err := NewMigrate(Options{
DB: db,
FS: OMMigrations,
FSPath: "migrations",
PGConfig: &postgres.Config{
MigrationsTable: MigrationsTable,
},
})
if err != nil {
return err
}
Expand All @@ -46,16 +73,3 @@ func Up(conn string) error {
}
return nil
}

func SetMigrationTableName(conn, tableName string) (string, error) {
parsedURL, err := url.Parse(conn)
if err != nil {
return "", err
}

values := parsedURL.Query()
values.Set("x-migrations-table", tableName)
parsedURL.RawQuery = values.Encode()

return parsedURL.String(), nil
}
2 changes: 1 addition & 1 deletion tools/migrate/migrate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ func TestUpDownUp(t *testing.T) {
testDB := testutils.InitPostgresDB(t)
defer testDB.PGDriver.Close()

migrator, err := migrate.NewMigrate(testDB.URL, migrate.OMMigrations, "migrations")
migrator, err := migrate.Default(testDB.SQLDriver)
if err != nil {
t.Fatal(err)
}
Expand Down
Loading