use path for PK check

candiduslynx · candiduslynx · commit 99e2a2efa21a · 2023-03-29T12:24:13.000+03:00
diff --git a/transformers/struct.go b/transformers/struct.go
@@ -272,9 +272,12 @@ func (t *structTransformer) addColumnFromField(field reflect.StructField, parent
 	}
 
 	for _, pk := range t.pkFields {
-		if pk == field.Name {
+		if pk == path {
+			// use path to allow the following
+			// 1. Don't duplicate the PK fields if the unwrapped struct contains a fields with the same name
+			// 2. Allow specifying the nested unwrapped field as part of the PK.
 			column.CreationOptions.PrimaryKey = true
-			t.pkFieldsFound = append(t.pkFieldsFound, field.Name)
+			t.pkFieldsFound = append(t.pkFieldsFound, pk)
 		}
 	}
 
diff --git a/transformers/struct_test.go b/transformers/struct_test.go
@@ -13,6 +13,7 @@ import (
 type (
 	embeddedStruct struct {
 		EmbeddedString string
+		IntCol         int `json:"int_col,omitempty"`
 	}
 
 	testStruct struct {
@@ -140,14 +141,29 @@ var (
 		Columns: expectedColumns,
 	}
 	expectedTestTableEmbeddedStruct = schema.Table{
+		Name:    "test_struct",
+		Columns: append(expectedColumns, schema.Column{Name: "embedded_string", Type: schema.TypeString}),
+	}
+	expectedTestTableEmbeddedStructWithPK = schema.Table{
 		Name: "test_struct",
 		Columns: append(
 			expectedColumns, schema.Column{
-				Name: "embedded_string",
-				Type: schema.TypeString,
+				Name:            "embedded_string",
+				Type:            schema.TypeString,
+				CreationOptions: schema.ColumnCreationOptions{PrimaryKey: true},
 			}),
 	}
 	expectedTestTableNonEmbeddedStruct = schema.Table{
+		Name: "test_struct",
+		Columns: schema.ColumnList{
+			// Should not be unwrapped
+			schema.Column{Name: "test_struct", Type: schema.TypeJSON},
+			// Should be unwrapped
+			schema.Column{Name: "non_embedded_embedded_string", Type: schema.TypeString},
+			schema.Column{Name: "non_embedded_int_col", Type: schema.TypeInt},
+		},
+	}
+	expectedTestTableNonEmbeddedStructWithPK = schema.Table{
 		Name: "test_struct",
 		Columns: schema.ColumnList{
 			// Should not be unwrapped
@@ -157,6 +173,11 @@ var (
 				Name: "non_embedded_embedded_string",
 				Type: schema.TypeString,
 			},
+			schema.Column{
+				Name:            "non_embedded_int_col",
+				Type:            schema.TypeInt,
+				CreationOptions: schema.ColumnCreationOptions{PrimaryKey: true},
+			},
 		},
 	}
 	expectedTestSliceStruct = schema.Table{
@@ -219,6 +240,17 @@ func TestTableFromGoStruct(t *testing.T) {
 			},
 			want: expectedTestTableEmbeddedStruct,
 		},
+		{
+			name: "should unwrap all embedded structs when option is set and use its field as PK",
+			args: args{
+				testStruct: testStructWithEmbeddedStruct{},
+				options: []StructTransformerOption{
+					WithUnwrapAllEmbeddedStructs(),
+					WithPrimaryKeys("EmbeddedString"),
+				},
+			},
+			want: expectedTestTableEmbeddedStructWithPK,
+		},
 		{
 			name: "should unwrap specific structs when option is set",
 			args: args{
@@ -229,6 +261,17 @@ func TestTableFromGoStruct(t *testing.T) {
 			},
 			want: expectedTestTableNonEmbeddedStruct,
 		},
+		{
+			name: "should unwrap specific structs when option is set and use its field as PK",
+			args: args{
+				testStruct: testStructWithNonEmbeddedStruct{},
+				options: []StructTransformerOption{
+					WithUnwrapStructFields("NonEmbedded"),
+					WithPrimaryKeys("NonEmbedded.IntCol"),
+				},
+			},
+			want: expectedTestTableNonEmbeddedStructWithPK,
+		},
 		{
 			name: "should generate table from slice struct",
 			args: args{

Original file line number	Diff line number	Diff line change
`@@ -272,9 +272,12 @@ func (t *structTransformer) addColumnFromField(field reflect.StructField, parent`
`272`	`272`	`}`
`273`	`273`
`274`	`274`	`for _, pk := range t.pkFields {`
`275`		`- if pk == field.Name {`
	`275`	`+ if pk == path {`
	`276`	`+ // use path to allow the following`
	`277`	`+ // 1. Don't duplicate the PK fields if the unwrapped struct contains a fields with the same name`
	`278`	`+ // 2. Allow specifying the nested unwrapped field as part of the PK.`
`276`	`279`	`column.CreationOptions.PrimaryKey = true`
`277`		`- t.pkFieldsFound = append(t.pkFieldsFound, field.Name)`
	`280`	`+ t.pkFieldsFound = append(t.pkFieldsFound, pk)`
`278`	`281`	`}`
`279`	`282`	`}`
`280`	`283`