Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support filter and optimize json #33

Merged
merged 8 commits into from
Nov 23, 2023
Merged

feat: support filter and optimize json #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d52b081
feat: support filter and optimize json
devhaozi Nov 17, 2023
f6d5397
feat: remove go releaser and optimize view load
devhaozi Nov 17, 2023
eb7bbe0
fix: tests
devhaozi Nov 17, 2023
7370d48
feat: make All support path param and optimize validate init
devhaozi Nov 20, 2023
ea9dea1
feat: support setting body limit
devhaozi Nov 20, 2023
1969854
Merge remote-tracking branch 'origin/master' into haozi/filter
devhaozi Nov 20, 2023
6801139
feat: update body limit use KB and remove SetContext
devhaozi Nov 21, 2023
fda0fab
revert: view load
devhaozi Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .goreleaser.yaml
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ import (

"drivers": map[string]any{
"gin": map[string]any{
// Optional, default is 4096 KB
"body_limit": 4096,
"route": func() (route.Route, error) {
return ginfacades.Route(), nil
},
Expand Down
45 changes: 28 additions & 17 deletions context_request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ import (
"fmt"
"io"
"net/http"
"reflect"
"strings"
"sync"

"github.com/bytedance/sonic"
"github.com/gin-gonic/gin"
"github.com/gookit/validate"
"github.com/spf13/cast"

contractsfilesystem "github.com/goravel/framework/contracts/filesystem"
contractshttp "github.com/goravel/framework/contracts/http"
"github.com/goravel/framework/contracts/log"
contractsvalidate "github.com/goravel/framework/contracts/validation"
"github.com/goravel/framework/filesystem"
"github.com/goravel/framework/support/json"
"github.com/goravel/framework/validation"
"github.com/spf13/cast"
)

type ContextRequest struct {
Expand Down Expand Up @@ -58,6 +58,11 @@ func (r *ContextRequest) All() map[string]any {
}

var mu sync.RWMutex
for _, param := range r.instance.Params {
mu.Lock()
dataMap[param.Key] = param.Value
mu.Unlock()
}
for k, v := range queryMap {
mu.Lock()
dataMap[k] = v
Expand Down Expand Up @@ -356,18 +361,7 @@ func (r *ContextRequest) Validate(rules map[string]string, options ...contractsv
generateOptions := validation.GenerateOptions(options)

var v *validate.Validation
dataFace, err := validate.FromRequest(r.Origin())
if err != nil {
return nil, err
}

for _, param := range r.instance.Params {
if _, exist := dataFace.Get(param.Key); !exist {
if _, err := dataFace.Set(param.Key, param.Value); err != nil {
return nil, err
}
}
}
dataFace := validate.FromMap(r.ctx.Request().All())

if generateOptions["prepareForValidation"] != nil {
if err := generateOptions["prepareForValidation"].(func(ctx contractshttp.Context, data contractsvalidate.Data) error)(r.ctx, validation.NewData(dataFace)); err != nil {
Expand All @@ -376,18 +370,35 @@ func (r *ContextRequest) Validate(rules map[string]string, options ...contractsv
}

v = dataFace.Create()

if generateOptions["filters"] != nil {
v.FilterRules(generateOptions["filters"].(map[string]string))
}

validation.AppendOptions(v, generateOptions)

return validation.NewValidator(v, dataFace), nil
return validation.NewValidator(v), nil
}

func (r *ContextRequest) ValidateRequest(request contractshttp.FormRequest) (contractsvalidate.Errors, error) {
if err := request.Authorize(r.ctx); err != nil {
return nil, err
}

filters := make(map[string]string)
val := reflect.Indirect(reflect.ValueOf(request))
for i := 0; i < val.Type().NumField(); i++ {
field := val.Type().Field(i)
form := field.Tag.Get("form")
filter := field.Tag.Get("filter")
if len(form) > 0 && len(filter) > 0 {
filters[form] = filter
}
}

validator, err := r.Validate(request.Rules(r.ctx), validation.Messages(request.Messages(r.ctx)), validation.Attributes(request.Attributes(r.ctx)), func(options map[string]any) {
options["prepareForValidation"] = request.PrepareForValidation
options["filters"] = filters
})
if err != nil {
return nil, err
Expand Down Expand Up @@ -415,7 +426,7 @@ func getPostData(ctx *Context) (map[string]any, error) {
return nil, fmt.Errorf("retrieve json error: %v", err)
}

if err := sonic.Unmarshal(bodyBytes, &data); err != nil {
if err := json.Unmarshal(bodyBytes, &data); err != nil {
return nil, fmt.Errorf("decode json [%v] error: %v", string(bodyBytes), err)
}

Expand Down
82 changes: 76 additions & 6 deletions context_request_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ import (
"strings"
"testing"

"github.com/bytedance/sonic"
configmocks "github.com/goravel/framework/contracts/config/mocks"
filesystemmocks "github.com/goravel/framework/contracts/filesystem/mocks"
contractshttp "github.com/goravel/framework/contracts/http"
logmocks "github.com/goravel/framework/contracts/log/mocks"
"github.com/goravel/framework/contracts/validation"
validationmocks "github.com/goravel/framework/contracts/validation/mocks"
frameworkfilesystem "github.com/goravel/framework/filesystem"
configmocks "github.com/goravel/framework/mocks/config"
filesystemmocks "github.com/goravel/framework/mocks/filesystem"
logmocks "github.com/goravel/framework/mocks/log"
validationmocks "github.com/goravel/framework/mocks/validation"
"github.com/goravel/framework/support/json"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
)
Expand All @@ -34,6 +34,7 @@ func TestRequest(t *testing.T) {
beforeEach := func() {
mockConfig = &configmocks.Config{}
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
}
tests := []struct {
name string
Expand Down Expand Up @@ -350,7 +351,7 @@ func TestRequest(t *testing.T) {
url: "/headers",
setup: func(method, url string) error {
gin.Get("/headers", func(ctx contractshttp.Context) contractshttp.Response {
str, _ := sonic.Marshal(ctx.Request().Headers())
str, _ := json.Marshal(ctx.Request().Headers())
return ctx.Response().Success().String(string(str))
})

Expand Down Expand Up @@ -1228,6 +1229,41 @@ func TestRequest(t *testing.T) {
expectCode: http.StatusBadRequest,
expectBody: "Validate fail: map[name:map[required:name is required to not be empty]]",
},
{
name: "GET with validator use filter and validate request pass",
method: "GET",
url: "/validator/filter/success?name= Goravel ",
setup: func(method, url string) error {
gin.Get("/validator/filter/success", func(ctx contractshttp.Context) contractshttp.Response {
mockValidation := &validationmocks.Validation{}
mockValidation.On("Rules").Return([]validation.Rule{}).Once()
ValidationFacade = mockValidation

var createUser CreateUser
validateErrors, err := ctx.Request().ValidateRequest(&createUser)
if err != nil {
return ctx.Response().String(http.StatusBadRequest, "Validate error: "+err.Error())
}
if validateErrors != nil {
return ctx.Response().String(http.StatusBadRequest, fmt.Sprintf("Validate fail: %+v", validateErrors.All()))
}

return ctx.Response().Success().Json(contractshttp.Json{
"name": createUser.Name,
})
})

var err error
req, err = http.NewRequest(method, url, nil)
if err != nil {
return err
}

return nil
},
expectCode: http.StatusOK,
expectBody: "{\"name\":\"Goravel 1\"}",
},
{
name: "POST with validator and validate pass",
method: "POST",
Expand Down Expand Up @@ -1393,6 +1429,40 @@ func TestRequest(t *testing.T) {
expectCode: http.StatusBadRequest,
expectBody: "Validate fail: map[name:map[required:name is required to not be empty]]",
},
{name: "POST with validator use filter and validate request pass",
method: "POST",
url: "/validator/filter/success",
setup: func(method, url string) error {
gin.Post("/validator/filter/success", func(ctx contractshttp.Context) contractshttp.Response {
mockValidation := &validationmocks.Validation{}
mockValidation.On("Rules").Return([]validation.Rule{}).Once()
ValidationFacade = mockValidation

var createUser CreateUser
validateErrors, err := ctx.Request().ValidateRequest(&createUser)
if err != nil {
return ctx.Response().String(http.StatusBadRequest, "Validate error: "+err.Error())
}
if validateErrors != nil {
return ctx.Response().String(http.StatusBadRequest, fmt.Sprintf("Validate fail: %+v", validateErrors.All()))
}

return ctx.Response().Success().Json(contractshttp.Json{
"name": createUser.Name,
})
})

payload := strings.NewReader(`{
"name": " Goravel "
}`)
req, _ = http.NewRequest(method, url, payload)
req.Header.Set("Content-Type", "application/json")

return nil
},
expectCode: http.StatusOK,
expectBody: "{\"name\":\"Goravel 1\"}",
},
{
name: "POST with validator and validate request unauthorize",
method: "POST",
Expand Down
15 changes: 9 additions & 6 deletions context_response_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import (
"strings"
"testing"

"github.com/bytedance/sonic"
configmocks "github.com/goravel/framework/contracts/config/mocks"
contractshttp "github.com/goravel/framework/contracts/http"
configmocks "github.com/goravel/framework/mocks/config"
"github.com/goravel/framework/support/json"
"github.com/stretchr/testify/assert"
)

Expand All @@ -22,6 +22,7 @@ func TestResponse(t *testing.T) {
beforeEach := func() {
mockConfig = &configmocks.Config{}
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
}
tests := []struct {
name string
Expand Down Expand Up @@ -308,6 +309,7 @@ func TestResponse_Success(t *testing.T) {
beforeEach := func() {
mockConfig = &configmocks.Config{}
mockConfig.On("GetBool", "app.debug").Return(false).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
ConfigFacade = mockConfig
}
tests := []struct {
Expand Down Expand Up @@ -402,9 +404,9 @@ func TestResponse_Success(t *testing.T) {
bodyMap := make(map[string]any)
exceptBodyMap := make(map[string]any)

err = sonic.Unmarshal(w.Body.Bytes(), &bodyMap)
err = json.Unmarshal(w.Body.Bytes(), &bodyMap)
assert.Nil(t, err)
err = sonic.UnmarshalString(test.expectBodyJson, &exceptBodyMap)
err = json.UnmarshalString(test.expectBodyJson, &exceptBodyMap)
assert.Nil(t, err)

assert.Equal(t, exceptBodyMap, bodyMap)
Expand All @@ -427,6 +429,7 @@ func TestResponse_Status(t *testing.T) {
beforeEach := func() {
mockConfig = &configmocks.Config{}
mockConfig.On("GetBool", "app.debug").Return(false).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
ConfigFacade = mockConfig
}
tests := []struct {
Expand Down Expand Up @@ -521,9 +524,9 @@ func TestResponse_Status(t *testing.T) {
bodyMap := make(map[string]any)
exceptBodyMap := make(map[string]any)

err = sonic.Unmarshal(w.Body.Bytes(), &bodyMap)
err = json.Unmarshal(w.Body.Bytes(), &bodyMap)
assert.Nil(t, err)
err = sonic.UnmarshalString(test.expectBodyJson, &exceptBodyMap)
err = json.UnmarshalString(test.expectBodyJson, &exceptBodyMap)
assert.Nil(t, err)

assert.Equal(t, exceptBodyMap, bodyMap)
Expand Down
10 changes: 9 additions & 1 deletion cors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import (
"net/http/httptest"
"testing"

configmocks "github.com/goravel/framework/contracts/config/mocks"
contractshttp "github.com/goravel/framework/contracts/http"
configmocks "github.com/goravel/framework/mocks/config"
"github.com/stretchr/testify/assert"
)

Expand All @@ -29,6 +29,7 @@ func TestCors(t *testing.T) {
name: "allow all paths",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"*"}).Once()
Expand All @@ -50,6 +51,7 @@ func TestCors(t *testing.T) {
name: "not allow path",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"api"}).Once()
mockConfig.On("GetString", "http.tls.host").Return("").Once()
mockConfig.On("GetString", "http.tls.port").Return("").Once()
Expand All @@ -69,6 +71,7 @@ func TestCors(t *testing.T) {
name: "allow path with *",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"any/*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"*"}).Once()
Expand All @@ -90,6 +93,7 @@ func TestCors(t *testing.T) {
name: "only allow POST",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"POST"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"*"}).Once()
Expand All @@ -111,6 +115,7 @@ func TestCors(t *testing.T) {
name: "not allow POST",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"GET"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"*"}).Once()
Expand All @@ -132,6 +137,7 @@ func TestCors(t *testing.T) {
name: "not allow origin",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"https://goravel.com"}).Once()
Expand All @@ -153,6 +159,7 @@ func TestCors(t *testing.T) {
name: "allow specific origin",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"https://goravel.dev"}).Once()
Expand All @@ -174,6 +181,7 @@ func TestCors(t *testing.T) {
name: "not allow exposed headers",
setup: func() {
mockConfig.On("GetBool", "app.debug").Return(true).Once()
mockConfig.On("GetInt", "http.drivers.gin.body_limit", 4096).Return(4096).Once()
mockConfig.On("Get", "cors.paths").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_methods").Return([]string{"*"}).Once()
mockConfig.On("Get", "cors.allowed_origins").Return([]string{"*"}).Once()
Expand Down
Loading