🩹fix: restrict supported types in SetValWithStruct

ksw2000 · ksw2000 · commit fecef5e43b22 · 2024-12-06T05:06:45.000Z
diff --git a/client/request.go b/client/request.go
@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"context"
 	"errors"
-	"fmt"
 	"io"
 	"path/filepath"
 	"reflect"
@@ -930,11 +929,14 @@ func ReleaseFile(f *File) {
 	filePool.Put(f)
 }
 
-// SetValWithStruct sets values using a struct.
-// `p` is a structure that implements the WithStruct interface.
-// The field name is specified by `tagName`.
-// `v` is a struct containing some data.
-// Note: This method supports all values that can be converted to an interface.
+// SetValWithStruct stores the fields of `v` into `p`.
+// `tagName` specifies the key used to store into `p`. If not specified,
+// the field name is used by default.
+// `v` is a struct or a pointer to a struct containing some data.
+// Fields in `v` should be string, int, int8, int16, int32, int64, uint,
+// uint8, uint16, uint32, uint64, float32, float64, complex64,
+// complex128 or bool. Arrays or slices are inserted sequentially with the
+// same key. Other types are ignored.
 func SetValWithStruct(p WithStruct, tagName string, v any) {
 	valueOfV := reflect.ValueOf(v)
 	typeOfV := reflect.TypeOf(v)
@@ -955,7 +957,9 @@ func SetValWithStruct(p WithStruct, tagName string, v any) {
 			p.Add(name, strconv.Itoa(int(val.Int())))
 		case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
 			p.Add(name, strconv.FormatUint(val.Uint(), 10))
-		case reflect.Complex128, reflect.Complex64:
+		case reflect.Float32, reflect.Float64:
+			p.Add(name, strconv.FormatFloat(val.Float(), 'f', -1, 64))
+		case reflect.Complex64, reflect.Complex128:
 			p.Add(name, strconv.FormatComplex(val.Complex(), 'f', -1, 128))
 		case reflect.Bool:
 			if val.Bool() {
@@ -965,16 +969,10 @@ func SetValWithStruct(p WithStruct, tagName string, v any) {
 			}
 		case reflect.String:
 			p.Add(name, val.String())
-		case reflect.Float32, reflect.Float64:
-			p.Add(name, strconv.FormatFloat(val.Float(), 'f', -1, 64))
 		case reflect.Slice, reflect.Array:
 			for i := 0; i < val.Len(); i++ {
 				setVal(name, val.Index(i))
 			}
-		default:
-			if val.CanInterface() {
-				p.Add(name, fmt.Sprintf("%#v", val.Interface()))
-			}
 		}
 	}
 
diff --git a/client/request_test.go b/client/request_test.go
@@ -1327,9 +1327,7 @@ func Test_SetValWithStruct(t *testing.T) {
 		TUint     uint
 		TFloat    float64
 		TComplex  complex128
-		TFunc     func()
 		TBool     bool
-		TMap      map[int]int
 	}
 
 	t.Run("the struct should be applied", func(t *testing.T) {
@@ -1348,8 +1346,6 @@ func Test_SetValWithStruct(t *testing.T) {
 			TBool:     false,
 			TSlice:    []string{"foo", "bar"},
 			TIntSlice: []int{0, 1, 2},
-			TFunc:     func() {},
-			TMap:      map[int]int{1: 2},
 		})
 
 		require.Equal(t, "", string(p.Peek("unexport")))
@@ -1359,8 +1355,6 @@ func Test_SetValWithStruct(t *testing.T) {
 		require.Equal(t, []byte("3.1"), p.Peek("TFloat"))
 		require.Equal(t, []byte("(3+4i)"), p.Peek("TComplex"))
 		require.Equal(t, []byte("false"), p.Peek("TBool"))
-		require.Contains(t, string(p.Peek("TFunc")), "(func())")
-		require.Equal(t, []byte("map[int]int{1:2}"), p.Peek("TMap"))
 		require.True(t, func() bool {
 			for _, v := range p.PeekMulti("TSlice") {
 				if string(v) == "foo" {
@@ -1485,8 +1479,6 @@ func Benchmark_SetValWithStruct(b *testing.B) {
 		TFloat    float64
 		TComplex  complex128
 		TBool     bool
-		TFunc     func()
-		TMap      map[int]int
 	}
 
 	b.Run("the struct should be applied", func(b *testing.B) {
@@ -1508,8 +1500,6 @@ func Benchmark_SetValWithStruct(b *testing.B) {
 				TBool:     false,
 				TSlice:    []string{"foo", "bar"},
 				TIntSlice: []int{0, 1, 2},
-				TFunc:     func() {},
-				TMap:      map[int]int{1: 2},
 			})
 		}
 
@@ -1520,8 +1510,6 @@ func Benchmark_SetValWithStruct(b *testing.B) {
 		require.Equal(b, []byte("3.1"), p.Peek("TFloat"))
 		require.Equal(b, []byte("(3+4i)"), p.Peek("TComplex"))
 		require.Equal(b, []byte("false"), p.Peek("TBool"))
-		require.Contains(b, string(p.Peek("TFunc")), "(func())")
-		require.Equal(b, []byte("map[int]int{1:2}"), p.Peek("TMap"))
 		require.True(b, func() bool {
 			for _, v := range p.PeekMulti("TSlice") {
 				if string(v) == "foo" {
