feat(fxsql): Provided migration logger (#227)

Author: ekkinox

docs/modules/fxsql.md

@@ -64,18 +64,20 @@ modules:
   sql:
     driver: mysql                                               # database driver
     dsn: "user:password@tcp(localhost:3306)/db?parseTime=true"  # database DSN
-    migrations: db/migrations                                   # migrations path
+    migrations:
+      path: db/migrations  # migrations path (empty by default)
+      stdout: true         # to print in stdout the migration logs (disabled by default)
     log:
-      enabled: true    # to enable SQL queries logging (disabled by default)
-      level: debug     # to configure SQL queries logs level (debug by default)
-      arguments: true  # to add SQL queries arguments to logs (disabled by default)
-      exclude:         # to exclude SQL operations from logging (empty by default)
+      enabled: true        # to enable SQL queries logging (disabled by default)
+      level: debug         # to configure SQL queries logs level (debug by default)
+      arguments: true      # to add SQL queries arguments to logs (disabled by default)
+      exclude:             # to exclude SQL operations from logging (empty by default)
         - "connection:ping"
         - "connection:reset-session"
     trace:
-      enabled: true    # to enable SQL queries tracing (disabled by default)
-      arguments: true  # to add SQL queries arguments to trace spans (disabled by default)
-      exclude:         # to exclude SQL operations from tracing (empty by default)
+      enabled: true        # to enable SQL queries tracing (disabled by default)
+      arguments: true      # to add SQL queries arguments to trace spans (disabled by default)
+      exclude:             # to exclude SQL operations from tracing (empty by default)
         - "connection:ping"
         - "connection:reset-session"
 ```

fxsql/README.md

@@ -98,7 +98,9 @@ modules:
   sql:
     driver: mysql                                               # database driver (empty by default)
     dsn: "user:password@tcp(localhost:3306)/db?parseTime=true"  # database DSN (empty by default)
-    migrations: db/migrations                                   # migrations path (empty by default)
+    migrations: 
+      path: db/migrations       # migrations path (empty by default)
+      stdout: true              # to print in stdout the migration logs (disabled by default)
     log:
       enabled: true             # to enable SQL queries logging (disabled by default)
       level: debug              # to configure SQL queries logs level (debug by default)

fxsql/logger.go

@@ -0,0 +1,44 @@
+package fxsql
+
+import (
+	"fmt"
+
+	"github.com/ankorstore/yokai/log"
+	"github.com/rs/zerolog"
+)
+
+// MigratorLogger is a logger compatible with [Goose].
+//
+// [Goose]: https://github.com/pressly/goose.
+type MigratorLogger struct {
+	logger *log.Logger
+	stdout bool
+}
+
+// NewMigratorLogger returns a new MigratorLogger instance.
+func NewMigratorLogger(logger *log.Logger, stdout bool) *MigratorLogger {
+	return &MigratorLogger{
+		logger: logger,
+		stdout: stdout,
+	}
+}
+
+// Printf logs with info level, and prints to stdout if configured to do so.
+func (l *MigratorLogger) Printf(format string, v ...interface{}) {
+	l.logger.Info().Msgf(format, v...)
+
+	if l.stdout {
+		//nolint:forbidigo
+		fmt.Printf(format, v...)
+	}
+}
+
+// Fatalf logs with fatal level, and prints to stdout if configured to do so.
+func (l *MigratorLogger) Fatalf(format string, v ...interface{}) {
+	l.logger.WithLevel(zerolog.FatalLevel).Msgf(format, v...)
+
+	if l.stdout {
+		//nolint:forbidigo
+		fmt.Printf("[FATAL] "+format, v...)
+	}
+}

fxsql/logger_test.go

@@ -0,0 +1,53 @@
+package fxsql_test
+
+import (
+	"testing"
+
+	"github.com/ankorstore/yokai/fxsql"
+	"github.com/ankorstore/yokai/log"
+	"github.com/ankorstore/yokai/log/logtest"
+	"github.com/rs/zerolog"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMigratorLoggerPrintf(t *testing.T) {
+	t.Parallel()
+
+	logBuffer := logtest.NewDefaultTestLogBuffer()
+
+	migratorLogger := createTestMigratorLogger(t, logBuffer)
+
+	migratorLogger.Printf("test %s %d", "foo", 42)
+
+	logtest.AssertHasLogRecord(t, logBuffer, map[string]interface{}{
+		"level":   "info",
+		"message": "test foo 42",
+	})
+}
+
+func TestMigratorLoggerFatalf(t *testing.T) {
+	t.Parallel()
+
+	logBuffer := logtest.NewDefaultTestLogBuffer()
+
+	migratorLogger := createTestMigratorLogger(t, logBuffer)
+
+	migratorLogger.Fatalf("test %s %d", "foo", 42)
+
+	logtest.AssertHasLogRecord(t, logBuffer, map[string]interface{}{
+		"level":   "fatal",
+		"message": "test foo 42",
+	})
+}
+
+func createTestMigratorLogger(t *testing.T, buffer logtest.TestLogBuffer) *fxsql.MigratorLogger {
+	t.Helper()
+
+	logger, err := log.NewDefaultLoggerFactory().Create(
+		log.WithLevel(zerolog.DebugLevel),
+		log.WithOutputWriter(buffer),
+	)
+	assert.NoError(t, err)
+
+	return fxsql.NewMigratorLogger(logger, true)
+}

fxsql/migrator.go

@@ -10,7 +10,7 @@ import (
 
 // Migrator is a database migrator based on [Goose].
 //
-// [Fx]: https://github.com/pressly/goose
+// [Goose]: https://github.com/pressly/goose
 type Migrator struct {
 	db     *sql.DB
 	logger *log.Logger

fxsql/module.go

@@ -3,15 +3,19 @@ package fxsql
 import (
 	"context"
 	"database/sql"
+	"sync"
 
 	"github.com/ankorstore/yokai/config"
 	"github.com/ankorstore/yokai/log"
 	yokaisql "github.com/ankorstore/yokai/sql"
 	yokaisqllog "github.com/ankorstore/yokai/sql/hook/log"
 	yokaisqltrace "github.com/ankorstore/yokai/sql/hook/trace"
+	"github.com/pressly/goose/v3"
 	"go.uber.org/fx"
 )
 
+var once sync.Once
+
 // ModuleName is the module name.
 const ModuleName = "sql"
 
@@ -98,11 +102,18 @@ func NewFxSQLDatabase(p FxSQLDatabaseParam) (*sql.DB, error) {
 type FxSQLMigratorParam struct {
 	fx.In
 	Db     *sql.DB
+	Config *config.Config
 	Logger *log.Logger
 }
 
 // NewFxSQLMigrator returns a Migrator instance.
 func NewFxSQLMigrator(p FxSQLMigratorParam) *Migrator {
+	// set once migrator the logger
+	once.Do(func() {
+		goose.SetLogger(NewMigratorLogger(p.Logger, p.Config.GetBool("modules.sql.migrations.stdout")))
+	})
+
+	// migrator
 	return NewMigrator(p.Db, p.Logger)
 }
 
@@ -126,7 +137,7 @@ func RunFxSQLMigration(command string, args ...string) fx.Option {
 			return migrator.Run(
 				ctx,
 				config.GetString("modules.sql.driver"),
-				config.GetString("modules.sql.migrations"),
+				config.GetString("modules.sql.migrations.path"),
 				command,
 				args...,
 			)
@@ -144,7 +155,7 @@ func RunFxSQLMigrationAndShutdown(command string, args ...string) fx.Option {
 			return migrator.Run(
 				ctx,
 				config.GetString("modules.sql.driver"),
-				config.GetString("modules.sql.migrations"),
+				config.GetString("modules.sql.migrations.path"),
 				command,
 				args...,
 			)

fxsql/testdata/config/config.yaml

@@ -11,7 +11,9 @@ modules:
   sql:
     driver: ${SQL_DRIVER}
     dsn: ${SQL_DSN}
-    migrations: testdata/migrations
+    migrations:
+      path: testdata/migrations
+      stdout: false
     log:
       enabled: true
       level: debug