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

Jump to bottom

Add a config option to allow erroring out on invalid RawMessages #584

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a config option to allow erroring out on invalid RawMessages #584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 17 additions & 6 deletions config.go
View file
Open in desktop
Expand Up @@ -23,6 +23,7 @@ type Config struct {
TagKey string
OnlyTaggedField bool
ValidateJsonRawMessage bool
ErrorOnInvalidJsonRawMessage bool
ObjectFieldMustBeSimpleString bool
CaseSensitive bool
}
Expand Down Expand Up @@ -53,9 +54,10 @@ var ConfigDefault = Config{

// ConfigCompatibleWithStandardLibrary tries to be 100% compatible with standard library behavior
var ConfigCompatibleWithStandardLibrary = Config{
EscapeHTML: true,
SortMapKeys: true,
ValidateJsonRawMessage: true,
EscapeHTML: true,
SortMapKeys: true,
ValidateJsonRawMessage: true,
ErrorOnInvalidJsonRawMessage: true,
}.Froze()

// ConfigFastest marshals float with only 6 digits precision
Expand Down Expand Up @@ -158,7 +160,7 @@ func (cfg Config) Froze() API {
api.useNumber(decoderExtension)
}
if cfg.ValidateJsonRawMessage {
api.validateJsonRawMessage(encoderExtension)
api.validateJsonRawMessage(encoderExtension, cfg.ErrorOnInvalidJsonRawMessage)
}
api.encoderExtension = encoderExtension
api.decoderExtension = decoderExtension
Expand All @@ -179,14 +181,23 @@ func (cfg Config) frozeWithCacheReuse(extraExtensions []Extension) *frozenConfig
return api
}

func (cfg *frozenConfig) validateJsonRawMessage(extension EncoderExtension) {
func (cfg *frozenConfig) validateJsonRawMessage(extension EncoderExtension, errorOnInvalid bool) {
encoder := &funcEncoder{func(ptr unsafe.Pointer, stream *Stream) {
rawMessage := *(*json.RawMessage)(ptr)
if rawMessage == nil {
stream.WriteRaw("null")
return
}

iter := cfg.BorrowIterator([]byte(rawMessage))
defer cfg.ReturnIterator(iter)
iter.Read()
if iter.Error != nil && iter.Error != io.EOF {
stream.WriteRaw("null")
if errorOnInvalid {
stream.Error = iter.Error
} else {
stream.WriteRaw("null")
}
} else {
stream.WriteRaw(string(rawMessage))
}
Expand Down
32 changes: 28 additions & 4 deletions misc_tests/jsoniter_raw_message_test.go
View file
Open in desktop
Expand Up @@ -2,10 +2,11 @@ package misc_tests

import (
"encoding/json"
"github.com/json-iterator/go"
"github.com/stretchr/testify/require"
"strings"
"testing"

jsoniter "github.com/json-iterator/go"
"github.com/stretchr/testify/require"
)

func Test_jsoniter_RawMessage(t *testing.T) {
Expand All @@ -28,7 +29,7 @@ func Test_encode_map_of_jsoniter_raw_message(t *testing.T) {
should.Equal(`{"hello":[]}`, output)
}

func Test_marshal_invalid_json_raw_message(t *testing.T) {
func Test_marshal_nil_json_raw_message(t *testing.T) {
type A struct {
Raw json.RawMessage `json:"raw"`
}
Expand All @@ -42,7 +43,7 @@ func Test_marshal_invalid_json_raw_message(t *testing.T) {
should.Nil(aouterr)
}

func Test_marshal_nil_json_raw_message(t *testing.T) {
func Test_marshal_invalid_json_raw_message_default(t *testing.T) {
type A struct {
Nil1 jsoniter.RawMessage `json:"raw1"`
Nil2 json.RawMessage `json:"raw2"`
Expand All @@ -61,6 +62,29 @@ func Test_marshal_nil_json_raw_message(t *testing.T) {
should.Nil(a.Nil2)
}

func Test_marshal_invalid_json_raw_message_stdcompat(t *testing.T) {
type A struct {
Nil1 jsoniter.RawMessage `json:"raw1"`
Nil2 json.RawMessage `json:"raw2"`
}

a := A{}
should := require.New(t)
aout, aouterr := jsoniter.ConfigCompatibleWithStandardLibrary.Marshal(&a)
should.Equal(`{"raw1":null,"raw2":null}`, string(aout))
should.Nil(aouterr)

a.Nil1 = []byte(`Any`)
a.Nil2 = []byte(`Any`)
aout, aouterr = jsoniter.ConfigCompatibleWithStandardLibrary.Marshal(&a)
should.Error(aouterr)

aout = []byte(`{"raw1":null,"raw2":null}`)
should.NoError(jsoniter.ConfigCompatibleWithStandardLibrary.Unmarshal(aout, &a))
should.Nil(a.Nil1)
should.Nil(a.Nil2)
}

func Test_raw_message_memory_not_copied_issue(t *testing.T) {
jsonStream := `{"name":"xxxxx","bundle_id":"com.zonst.majiang","app_platform":"ios","app_category":"100103", "budget_day":1000,"bidding_min":1,"bidding_max":2,"bidding_type":"CPM", "freq":{"open":true,"type":"day","num":100},"speed":1, "targeting":{"vendor":{"open":true,"list":["zonst"]}, "geo_code":{"open":true,"list":["156110100"]},"app_category":{"open":true,"list":["100101"]}, "day_parting":{"open":true,"list":["100409","100410"]},"device_type":{"open":true,"list":["ipad"]}, "os_version":{"open":true,"list":[10]},"carrier":{"open":true,"list":["mobile"]}, "network":{"open":true,"list":["4G"]}},"url":{"tracking_imp_url":"http://www.baidu.com", "tracking_clk_url":"http://www.baidu.com","jump_url":"http://www.baidu.com","deep_link_url":"http://www.baidu.com"}}`
type IteratorObject struct {
Expand Down