fix(spanner): SelectAll struct fields match should be case-insensitive (#9417)

rahul2393 · web-flow · commit 7ff535672b86 · 2024-02-13T20:42:19.000+05:30
* fix(spanner): SelectAll struct fields match should be case-insensitive

* fix comment

* fix casing for mock response
diff --git a/spanner/row.go b/spanner/row.go
@@ -19,6 +19,7 @@ package spanner
 import (
 	"fmt"
 	"reflect"
+	"strings"
 
 	sppb "cloud.google.com/go/spanner/apiv1/spannerpb"
 	proto3 "github.com/golang/protobuf/ptypes/struct"
@@ -518,7 +519,7 @@ func structPointers(sliceItem reflect.Value, cols []*sppb.StructType_Field, leni
 		}
 
 		var fieldVal reflect.Value
-		if v, ok := fieldTag[colName.GetName()]; ok {
+		if v, ok := fieldTag[strings.ToLower(colName.GetName())]; ok {
 			fieldVal = v
 		} else {
 			if !lenient {
@@ -565,7 +566,7 @@ func initFieldTag(sliceItem reflect.Value, fieldTagMap *map[string]reflect.Value
 			continue
 		}
 		if name == "" {
-			name = fieldType.Name
+			name = strings.ToLower(fieldType.Name)
 		}
 		(*fieldTagMap)[name] = sliceItem.Field(i)
 	}
diff --git a/spanner/row_test.go b/spanner/row_test.go
@@ -2003,7 +2003,8 @@ func TestSelectAll(t *testing.T) {
 	}
 	type testStruct struct {
 		Col1 int64
-		Col2 float64
+		// declaring second column in upper case here to verify SelectAll does case-insensitive matching
+		COL2 float64
 		Col3 string
 		Col4 time.Time
 	}
@@ -2087,8 +2088,8 @@ func TestSelectAll(t *testing.T) {
 				},
 			},
 			want: &[]testStruct{
-				{Col1: 1, Col2: 1.1, Col3: "value", Col4: tm},
-				{Col1: 2, Col2: 2.2, Col3: "value2", Col4: tm.Add(24 * time.Hour)},
+				{Col1: 1, COL2: 1.1, Col3: "value", Col4: tm},
+				{Col1: 2, COL2: 2.2, Col3: "value2", Col4: tm.Add(24 * time.Hour)},
 			},
 		},
 		{
@@ -2117,8 +2118,8 @@ func TestSelectAll(t *testing.T) {
 				},
 			},
 			want: &[]*testStruct{
-				{Col1: 1, Col2: 1.1, Col3: "value"},
-				{Col1: 2, Col2: 2.2, Col3: "value2"},
+				{Col1: 1, COL2: 1.1, Col3: "value"},
+				{Col1: 2, COL2: 2.2, Col3: "value2"},
 			}},
 		{
 			name: "success: when spanner row contains more columns than declared in Go struct but called WithLenient",
@@ -2142,13 +2143,13 @@ func TestSelectAll(t *testing.T) {
 				options: []DecodeOptions{WithLenient()},
 			},
 			want: &[]*testStruct{
-				{Col1: 1, Col2: 1.1, Col3: "value", Col4: tm},
+				{Col1: 1, COL2: 1.1, Col3: "value", Col4: tm},
 			},
 		},
 		{
 			name: "success: using prefilled destination should append to the destination",
 			args: args{
-				destination: &[]*testStruct{{Col1: 3, Col2: 3.3, Col3: "value3"}},
+				destination: &[]*testStruct{{Col1: 3, COL2: 3.3, Col3: "value3"}},
 				mock: func(mockIterator *mockRowIterator) {
 					mockIterator.On("Next").Once().Return(&Row{
 						[]*sppb.StructType_Field{
@@ -2171,14 +2172,14 @@ func TestSelectAll(t *testing.T) {
 				},
 			},
 			want: &[]*testStruct{
-				{Col1: 3, Col2: 3.3, Col3: "value3"},
-				{Col1: 1, Col2: 1.1, Col3: "value"},
-				{Col1: 2, Col2: 2.2, Col3: "value2"},
+				{Col1: 3, COL2: 3.3, Col3: "value3"},
+				{Col1: 1, COL2: 1.1, Col3: "value"},
+				{Col1: 2, COL2: 2.2, Col3: "value2"},
 			}},
 		{
 			name: "failure: in case of error destination will have the partial result",
 			args: args{
-				destination: &[]*testStruct{{Col1: 3, Col2: 3.3, Col3: "value3"}},
+				destination: &[]*testStruct{{Col1: 3, COL2: 3.3, Col3: "value3"}},
 				mock: func(mockIterator *mockRowIterator) {
 					mockIterator.On("Next").Once().Return(&Row{
 						[]*sppb.StructType_Field{
@@ -2194,15 +2195,15 @@ func TestSelectAll(t *testing.T) {
 				},
 			},
 			want: &[]*testStruct{
-				{Col1: 3, Col2: 3.3, Col3: "value3"},
-				{Col1: 1, Col2: 1.1, Col3: "value"},
+				{Col1: 3, COL2: 3.3, Col3: "value3"},
+				{Col1: 1, COL2: 1.1, Col3: "value"},
 			},
 			wantErr: true,
 		},
 		{
 			name: "failure: when spanner row contains more columns than declared in Go struct",
 			args: args{
-				destination: &[]*testStruct{{Col1: 3, Col2: 3.3, Col3: "value3"}},
+				destination: &[]*testStruct{{Col1: 3, COL2: 3.3, Col3: "value3"}},
 				mock: func(mockIterator *mockRowIterator) {
 					mockIterator.On("Next").Once().Return(&Row{
 						[]*sppb.StructType_Field{
@@ -2219,7 +2220,7 @@ func TestSelectAll(t *testing.T) {
 				},
 			},
 			want: &[]*testStruct{
-				{Col1: 3, Col2: 3.3, Col3: "value3"},
+				{Col1: 3, COL2: 3.3, Col3: "value3"},
 			},
 			wantErr: true,
 		},

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ package spanner`
`19`	`19`	`import (`
`20`	`20`	`"fmt"`
`21`	`21`	`"reflect"`
	`22`	`+ "strings"`
`22`	`23`
`23`	`24`	`sppb "cloud.google.com/go/spanner/apiv1/spannerpb"`
`24`	`25`	`proto3 "github.com/golang/protobuf/ptypes/struct"`
`@@ -518,7 +519,7 @@ func structPointers(sliceItem reflect.Value, cols []*sppb.StructType_Field, leni`
`518`	`519`	`}`
`519`	`520`
`520`	`521`	`var fieldVal reflect.Value`
`521`		`- if v, ok := fieldTag[colName.GetName()]; ok {`
	`522`	`+ if v, ok := fieldTag[strings.ToLower(colName.GetName())]; ok {`
`522`	`523`	`fieldVal = v`
`523`	`524`	`} else {`
`524`	`525`	`if !lenient {`
`@@ -565,7 +566,7 @@ func initFieldTag(sliceItem reflect.Value, fieldTagMap *map[string]reflect.Value`
`565`	`566`	`continue`
`566`	`567`	`}`
`567`	`568`	`if name == "" {`
`568`		`- name = fieldType.Name`
	`569`	`+ name = strings.ToLower(fieldType.Name)`
`569`	`570`	`}`
`570`	`571`	`(*fieldTagMap)[name] = sliceItem.Field(i)`
`571`	`572`	`}`