fix: remove schema name from t.Name during bun-schema inspection

uptrace · Nov 10, 2024 · 31ed582 · 31ed582
1 parent 6b0ddc1
commit 31ed582
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 8 deletions.
diff --git a/internal/dbtest/inspect_test.go b/internal/dbtest/inspect_test.go
@@ -626,5 +626,26 @@ func TestBunModelInspector_Inspect(t *testing.T) {
 				return
 			}
 		})
+
+		t.Run("separates schema and table name", func(t *testing.T) {
+			type Model struct {
+				bun.BaseModel `bun:"table:custom_schema.model"`
+			}
+
+			tables := schema.NewTables(dialect)
+			tables.Register((*Model)(nil))
+			inspector := sqlschema.NewBunModelInspector(tables)
+
+			got, err := inspector.Inspect(context.Background())
+			require.NoError(t, err)
+
+			gotTables := got.GetTables()
+			require.Equal(t, 1, gotTables.Len())
+			for _, table := range gotTables.FromOldest() {
+				require.Equal(t, "custom_schema", table.GetSchema(), "wrong schema name")
+				require.Equal(t, "model", table.GetName(), "wrong table name")
+				return
+			}
+		})
 	})
 }
diff --git a/internal/dbtest/migrate_test.go b/internal/dbtest/migrate_test.go
@@ -857,7 +857,7 @@ func testUnique(t *testing.T, db *bun.DB) {
 
 func testUniqueRenamedTable(t *testing.T, db *bun.DB) {
 	type TableBefore struct {
-		bun.BaseModel `bun:"table:before"`
+		bun.BaseModel `bun:"table:automigrate.before"`
 		FirstName     string `bun:"first_name,unique:full_name"`
 		LastName      string `bun:"last_name,unique:full_name"`
 		Birthday      string `bun:"birthday,unique"`
@@ -866,7 +866,7 @@ func testUniqueRenamedTable(t *testing.T, db *bun.DB) {
 	}
 
 	type TableAfter struct {
-		bun.BaseModel `bun:"table:after"`
+		bun.BaseModel `bun:"table:automigrate.after"`
 		// Expand full_name unique group and rename it.
 		FirstName string `bun:"first_name,unique:birth_certificate"`
 		LastName  string `bun:"last_name,unique:birth_certificate"`
@@ -881,7 +881,7 @@ func testUniqueRenamedTable(t *testing.T, db *bun.DB) {
 		orderedmap.Pair[string, sqlschema.Table]{
 			Key: "after",
 			Value: &sqlschema.BaseTable{
-				Schema: db.Dialect().DefaultSchema(),
+				Schema: "automigrate",
 				Name:   "after",
 				Columns: orderedmap.New[string, sqlschema.Column](orderedmap.WithInitialData(
 					orderedmap.Pair[string, sqlschema.Column]{
@@ -931,6 +931,7 @@ func testUniqueRenamedTable(t *testing.T, db *bun.DB) {
 
 	ctx := context.Background()
 	inspect := inspectDbOrSkip(t, db)
+	mustCreateSchema(t, ctx, db, "automigrate")
 	mustResetModel(t, ctx, db, (*TableBefore)(nil))
 	mustDropTableOnCleanup(t, ctx, db, (*TableAfter)(nil))
 	m := newAutoMigratorOrSkip(t, db, migrate.WithModel((*TableAfter)(nil)))
@@ -946,7 +947,7 @@ func testUniqueRenamedTable(t *testing.T, db *bun.DB) {
 func testUpdatePrimaryKeys(t *testing.T, db *bun.DB) {
 	// Has a composite primary key.
 	type DropPKBefore struct {
-		bun.BaseModel `bun:"table:drop_your_pks"`
+		bun.BaseModel `bun:"table:please.drop_your_pks"`
 		FirstName     string `bun:"first_name,pk"`
 		LastName      string `bun:"last_name,pk"`
 	}
@@ -970,7 +971,7 @@ func testUpdatePrimaryKeys(t *testing.T, db *bun.DB) {
 
 	// Doesn't have any primary keys.
 	type DropPKAfter struct {
-		bun.BaseModel `bun:"table:drop_your_pks"`
+		bun.BaseModel `bun:"table:please.drop_your_pks"`
 		FirstName     string `bun:"first_name,notnull"`
 		LastName      string `bun:"last_name,notnull"`
 	}
@@ -994,7 +995,7 @@ func testUpdatePrimaryKeys(t *testing.T, db *bun.DB) {
 		orderedmap.Pair[string, sqlschema.Table]{
 			Key: "drop_your_pks",
 			Value: &sqlschema.BaseTable{
-				Schema: db.Dialect().DefaultSchema(),
+				Schema: "please",
 				Name:   "drop_your_pks",
 				Columns: orderedmap.New[string, sqlschema.Column](orderedmap.WithInitialData(
 					orderedmap.Pair[string, sqlschema.Column]{
@@ -1074,6 +1075,7 @@ func testUpdatePrimaryKeys(t *testing.T, db *bun.DB) {
 
 	ctx := context.Background()
 	inspect := inspectDbOrSkip(t, db)
+	mustCreateSchema(t, ctx, db, "please")
 	mustResetModel(t, ctx, db,
 		(*DropPKBefore)(nil),
 		(*AddNewPKBefore)(nil),

diff --git a/migrate/sqlschema/inspector.go b/migrate/sqlschema/inspector.go
@@ -129,10 +129,17 @@ func (bmi *BunModelInspector) Inspect(ctx context.Context) (Database, error) {
 			pk = &PrimaryKey{Columns: NewColumns(columns...)}
 		}
 
-		state.Tables.Set(t.Name, &BunTable{
+		// In cases where a table is defined in a non-default schema in the `bun:table` tag,
+		// schema.Table only extracts the name of the schema, but passes the entire tag value to t.Name
+		// for backwads-compatibility. For example, a bun model like this:
+		// 	type Model struct { bun.BaseModel `bun:"table:favourite.books` }
+		// produces
+		// 	schema.Table{ Schema: "favourite", Name: "favourite.books" }
+		tableName := strings.TrimPrefix(t.Name, t.Schema+".")
+		state.Tables.Set(tableName, &BunTable{
 			BaseTable: BaseTable{
 				Schema:            t.Schema,
-				Name:              t.Name,
+				Name:              tableName,
 				Columns:           columns,
 				UniqueConstraints: unique,
 				PrimaryKey:        pk,