refactor: validate tag config

cloudwego · Sep 22, 2023 · f694ddd · f694ddd
1 parent dbaf4a1
commit f694ddd
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 11 deletions.
diff --git a/pkg/app/context_test.go b/pkg/app/context_test.go
@@ -884,11 +884,15 @@ func (m *mockValidator) Engine() interface{} {
 	return nil
 }
 
+func (m *mockValidator) ValidateTag() string {
+	return "vt"
+}
+
 func TestSetValidator(t *testing.T) {
 	m := &mockValidator{}
 	c := NewContext(0)
 	c.SetValidator(m)
-	c.SetBinder(binding.NewDefaultBinder(&binding.BindConfig{ValidateTag: "vt"}))
+	c.SetBinder(binding.NewDefaultBinder(&binding.BindConfig{Validator: m}))
 	type User struct {
 		Age int `vt:"$>=0&&$<=130"`
 	}

diff --git a/pkg/app/server/binding/config.go b/pkg/app/server/binding/config.go
@@ -63,10 +63,6 @@ type BindConfig struct {
 	// The default is false.
 	// It is used for BindJSON().
 	EnableDecoderDisallowUnknownFields bool
-	// ValidateTag is used to determine if a filed needs to be validated.
-	// NOTE:
-	// The default is "vd".
-	ValidateTag string
 	// TypeUnmarshalFuncs registers customized type unmarshaler.
 	// NOTE:
 	// time.Time is registered by default
@@ -82,7 +78,6 @@ func NewBindConfig() *BindConfig {
 		DisableStructFieldResolve:          false,
 		EnableDecoderUseNumber:             false,
 		EnableDecoderDisallowUnknownFields: false,
-		ValidateTag:                        "vd",
 		TypeUnmarshalFuncs:                 make(map[reflect.Type]inDecoder.CustomizeDecodeFunc),
 		Validator:                          defaultValidate,
 	}

diff --git a/pkg/app/server/binding/default.go b/pkg/app/server/binding/default.go
@@ -185,14 +185,17 @@ func (b *defaultBinder) bindTag(req *protocol.Request, v interface{}, params par
 		decoder := cached.(decoderInfo)
 		return decoder.decoder(req, params, rv.Elem())
 	}
-
+	validateTag := "vd"
+	if len(b.config.Validator.ValidateTag()) != 0 {
+		validateTag = b.config.Validator.ValidateTag()
+	}
 	decodeConfig := &inDecoder.DecodeConfig{
 		LooseZeroMode:                      b.config.LooseZeroMode,
 		DisableDefaultTag:                  b.config.DisableDefaultTag,
 		DisableStructFieldResolve:          b.config.DisableStructFieldResolve,
 		EnableDecoderUseNumber:             b.config.EnableDecoderUseNumber,
 		EnableDecoderDisallowUnknownFields: b.config.EnableDecoderDisallowUnknownFields,
-		ValidateTag:                        b.config.ValidateTag,
+		ValidateTag:                        validateTag,
 		TypeUnmarshalFuncs:                 b.config.TypeUnmarshalFuncs,
 	}
 	decoder, needValidate, err := inDecoder.GetReqDecoder(rv.Type(), tag, decodeConfig)
@@ -232,13 +235,17 @@ func (b *defaultBinder) bindTagWithValidate(req *protocol.Request, v interface{}
 		}
 		return err
 	}
+	validateTag := "vd"
+	if len(b.config.Validator.ValidateTag()) != 0 {
+		validateTag = b.config.Validator.ValidateTag()
+	}
 	decodeConfig := &inDecoder.DecodeConfig{
 		LooseZeroMode:                      b.config.LooseZeroMode,
 		DisableDefaultTag:                  b.config.DisableDefaultTag,
 		DisableStructFieldResolve:          b.config.DisableStructFieldResolve,
 		EnableDecoderUseNumber:             b.config.EnableDecoderUseNumber,
 		EnableDecoderDisallowUnknownFields: b.config.EnableDecoderDisallowUnknownFields,
-		ValidateTag:                        b.config.ValidateTag,
+		ValidateTag:                        validateTag,
 		TypeUnmarshalFuncs:                 b.config.TypeUnmarshalFuncs,
 	}
 	decoder, needValidate, err := inDecoder.GetReqDecoder(rv.Type(), tag, decodeConfig)
@@ -374,7 +381,8 @@ func (b *defaultBinder) bindNonStruct(req *protocol.Request, v interface{}) (err
 var _ StructValidator = (*defaultValidator)(nil)
 
 type defaultValidator struct {
-	validate *validator.Validator
+	validateTag string
+	validate    *validator.Validator
 }
 
 func NewDefaultValidator(config *ValidateConfig) StructValidator {
@@ -387,7 +395,8 @@ func NewDefaultValidator(config *ValidateConfig) StructValidator {
 		vd.SetErrorFactory(config.ErrFactory)
 	}
 	return &defaultValidator{
-		validate: vd,
+		validateTag: validateTag,
+		validate:    vd,
 	}
 }
 
@@ -424,6 +433,10 @@ func (v *defaultValidator) Engine() interface{} {
 	return v.validate
 }
 
+func (v *defaultValidator) ValidateTag() string {
+	return v.validateTag
+}
+
 var defaultValidate = NewDefaultValidator(NewValidateConfig())
 
 func DefaultValidator() StructValidator {

diff --git a/pkg/app/server/binding/validator.go b/pkg/app/server/binding/validator.go
@@ -43,4 +43,5 @@ package binding
 type StructValidator interface {
 	ValidateStruct(interface{}) error
 	Engine() interface{}
+	ValidateTag() string
 }
diff --git a/pkg/app/server/binding/validator_test.go b/pkg/app/server/binding/validator_test.go
@@ -33,3 +33,32 @@ func Test_ValidateStruct(t *testing.T) {
 		t.Fatalf("expected an error, but got nil")
 	}
 }
+
+func Test_ValidateTag(t *testing.T) {
+	type User struct {
+		Age int `query:"age" vt:"$>=0&&$<=130"`
+	}
+
+	user := &User{
+		Age: 135,
+	}
+	validateConfig := NewValidateConfig()
+	validateConfig.ValidateTag = "vt"
+	vd := NewDefaultValidator(validateConfig)
+	err := vd.ValidateStruct(user)
+	if err == nil {
+		t.Fatalf("expected an error, but got nil")
+	}
+
+	bindConfig := NewBindConfig()
+	bindConfig.Validator = vd
+	binder := NewDefaultBinder(bindConfig)
+	user = &User{}
+	req := newMockRequest().
+		SetRequestURI("http://foobar.com?age=135").
+		SetHeaders("h", "header")
+	err = binder.BindAndValidate(req.Req, user, nil)
+	if err == nil {
+		t.Fatalf("expected an error, but got nil")
+	}
+}
diff --git a/pkg/app/server/hertz_test.go b/pkg/app/server/hertz_test.go
@@ -966,6 +966,10 @@ func (m *mockValidator) Engine() interface{} {
 	return nil
 }
 
+func (m *mockValidator) ValidateTag() string {
+	return "vd"
+}
+
 func TestCustomValidator(t *testing.T) {
 	type Req struct {
 		A int `query:"a" vd:"f($)"`
@@ -1036,3 +1040,29 @@ func TestValidateConfigSetSetErrorFactory(t *testing.T) {
 	assert.Nil(t, err)
 	time.Sleep(100 * time.Millisecond)
 }
+
+func TestValidateConfigAndBindConfig(t *testing.T) {
+	type Req struct {
+		A int `query:"a" vt:"$>=0&&$<=130"`
+	}
+	validateConfig := binding.NewValidateConfig()
+	validateConfig.ValidateTag = "vt"
+	h := New(
+		WithHostPorts("localhost:9876"),
+		WithValidateConfig(validateConfig))
+	h.GET("/bind", func(c context.Context, ctx *app.RequestContext) {
+		var req Req
+		err := ctx.BindAndValidate(&req)
+		if err == nil {
+			t.Fatal("expect an error")
+		}
+		t.Log(err)
+	})
+
+	go h.Spin()
+	time.Sleep(100 * time.Millisecond)
+	hc := http.Client{Timeout: time.Second}
+	_, err := hc.Get("http://127.0.0.1:9876/bind?a=135")
+	assert.Nil(t, err)
+	time.Sleep(100 * time.Millisecond)
+}
diff --git a/pkg/route/engine_test.go b/pkg/route/engine_test.go
@@ -675,6 +675,10 @@ func (m *mockValidator) Engine() interface{} {
 	return nil
 }
 
+func (m *mockValidator) ValidateTag() string {
+	return "vd"
+}
+
 type mockNonValidator struct{}
 
 func (m *mockNonValidator) ValidateStruct(interface{}) error {