refactor: improve error message and code organization in amigo package

alexisvisco · Oct 31, 2024 · 454dcf5 · 454dcf5
1 parent 818266e
commit 454dcf5
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -2,13 +2,14 @@ package cmd
 
 import (
 	"fmt"
+	"os"
+	"path/filepath"
+
 	"github.com/alexisvisco/amigo/pkg/amigo"
 	"github.com/alexisvisco/amigo/pkg/amigoctx"
 	"github.com/alexisvisco/amigo/pkg/utils/events"
 	"github.com/alexisvisco/amigo/pkg/utils/logger"
 	"github.com/spf13/viper"
-	"os"
-	"path/filepath"
 
 	"github.com/spf13/cobra"
 )

diff --git a/pkg/amigo/setup_slog.go b/pkg/amigo/setup_slog.go
@@ -1,13 +1,17 @@
 package amigo
 
 import (
-	"github.com/alexisvisco/amigo/pkg/utils/logger"
 	"io"
 	"log/slog"
+
+	"github.com/alexisvisco/amigo/pkg/utils/logger"
 )
 
 func (a Amigo) SetupSlog(writer io.Writer) {
 	logger.ShowSQLEvents = a.ctx.ShowSQL
+	if writer == nil {
+		return
+	}
 
 	if a.ctx.JSON {
 		slog.SetDefault(slog.New(slog.NewJSONHandler(writer, nil)))

diff --git a/pkg/schema/migrator.go b/pkg/schema/migrator.go
@@ -3,6 +3,7 @@ package schema
 import (
 	"context"
 	"fmt"
+	"reflect"
 	"regexp"
 	"slices"
 	"time"
@@ -113,8 +114,11 @@ func (m *Migrator[T]) Apply(direction types.MigrationDirection, version *string,
 		case SimpleMigration[T]:
 			migrationFunc = t.Change
 		default:
-			logger.Error(events.MessageEvent{Message: fmt.Sprintf("Migration %s is not a valid migration",
-				migration.Name())})
+			reflectionType := fmt.Sprintf("%T", migration)
+			driverValue := fmt.Sprintf("%v", reflect.TypeOf(new(T)).Elem())
+
+			logger.Error(events.MessageEvent{Message: fmt.Sprintf("Migration %s is not a valid migration type, found %s (driver is %s). Did you set DSN correctly ?",
+				migration.Name(), reflectionType, driverValue)})
 			return false
 		}
 

diff --git a/pkg/schema/sql_migration_impl.go b/pkg/schema/sql_migration_impl.go
@@ -14,8 +14,8 @@ type SQLMigration[T Schema] struct {
 	delimiter string
 }
 
-func NewSQLMigration[T Schema](fs embed.FS, name string, time string, delimiter string) SQLMigration[T] {
-	return SQLMigration[T]{fs: fs, name: name, time: time, delimiter: delimiter}
+func NewSQLMigration[T Schema](fs embed.FS, name string, time string, delimiter string) DetailedMigration[T] {
+	return &SQLMigration[T]{fs: fs, name: name, time: time, delimiter: delimiter}
 }
 
 func (s SQLMigration[T]) Up(x T) {