From 2c22cd4a77f6ac230bff49b3fc67737161d45cec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Tue, 5 Dec 2023 14:19:33 +0800 Subject: [PATCH] contextjson: Add context to decode error message --- common/json/internal/contextjson/README.md | 3 ++ common/json/internal/contextjson/decode.go | 40 +++++++++++++-- .../internal/contextjson/decode_context.go | 49 +++++++++++++++++++ 3 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 common/json/internal/contextjson/README.md create mode 100644 common/json/internal/contextjson/decode_context.go diff --git a/common/json/internal/contextjson/README.md b/common/json/internal/contextjson/README.md new file mode 100644 index 0000000..da656b7 --- /dev/null +++ b/common/json/internal/contextjson/README.md @@ -0,0 +1,3 @@ +# contextjson + +mod from go1.21.4 diff --git a/common/json/internal/contextjson/decode.go b/common/json/internal/contextjson/decode.go index c222bec..8457171 100644 --- a/common/json/internal/contextjson/decode.go +++ b/common/json/internal/contextjson/decode.go @@ -217,6 +217,7 @@ type decodeState struct { savedError error useNumber bool disallowUnknownFields bool + context *decodeContext } // readIndex returns the position of the last byte read. @@ -245,7 +246,11 @@ func (d *decodeState) init(data []byte) *decodeState { // for reporting at the end of the unmarshal. func (d *decodeState) saveError(err error) { if d.savedError == nil { - d.savedError = d.addErrorContext(err) + if d.context != nil { + d.savedError = d.addErrorContext(&contextError{err, d.formatContext(), d.context.key == ""}) + } else { + d.savedError = d.addErrorContext(err) + } } } @@ -504,7 +509,11 @@ func (d *decodeState) array(v reflect.Value) error { if u != nil { start := d.readIndex() d.skip() - return u.UnmarshalJSON(d.data[start:d.off]) + err := u.UnmarshalJSON(d.data[start:d.off]) + if err != nil { + d.saveError(err) + } + return nil } if ut != nil { d.saveError(&UnmarshalTypeError{Value: "array", Type: v.Type(), Offset: int64(d.off)}) @@ -533,6 +542,7 @@ func (d *decodeState) array(v reflect.Value) error { } i := 0 + d.context = &decodeContext{parent: d.context} for { // Look ahead for ] - can only happen on first iteration. d.scanWhile(scanSkipSpace) @@ -573,8 +583,11 @@ func (d *decodeState) array(v reflect.Value) error { if d.opcode != scanArrayValue { panic(phasePanicMsg) } + d.context.index++ } + d.context = d.context.parent + if i < v.Len() { if v.Kind() == reflect.Array { for ; i < v.Len(); i++ { @@ -603,7 +616,11 @@ func (d *decodeState) object(v reflect.Value) error { if u != nil { start := d.readIndex() d.skip() - return u.UnmarshalJSON(d.data[start:d.off]) + err := u.UnmarshalJSON(d.data[start:d.off]) + if err != nil { + d.saveError(err) + } + return nil } if ut != nil { d.saveError(&UnmarshalTypeError{Value: "object", Type: v.Type(), Offset: int64(d.off)}) @@ -659,6 +676,7 @@ func (d *decodeState) object(v reflect.Value) error { origErrorContext = *d.errorContext } + d.context = &decodeContext{parent: d.context} for { // Read opening " of string key or closing }. d.scanWhile(scanSkipSpace) @@ -678,6 +696,7 @@ func (d *decodeState) object(v reflect.Value) error { if !ok { panic(phasePanicMsg) } + d.context.key = string(key) // Figure out field corresponding to key. var subv reflect.Value @@ -729,6 +748,7 @@ func (d *decodeState) object(v reflect.Value) error { } else if d.disallowUnknownFields { d.saveError(fmt.Errorf("json: unknown field %q", key)) } + d.context.index++ } // Read : before value. @@ -818,6 +838,7 @@ func (d *decodeState) object(v reflect.Value) error { panic(phasePanicMsg) } } + d.context = d.context.parent return nil } @@ -851,7 +872,11 @@ func (d *decodeState) literalStore(item []byte, v reflect.Value, fromQuoted bool isNull := item[0] == 'n' // null u, ut, pv := indirect(v, isNull) if u != nil { - return u.UnmarshalJSON(item) + err := u.UnmarshalJSON(item) + if err != nil { + d.saveError(err) + } + return nil } if ut != nil { if item[0] != '"' { @@ -1039,6 +1064,7 @@ func (d *decodeState) valueInterface() (val any) { // arrayInterface is like array but returns []interface{}. func (d *decodeState) arrayInterface() []any { v := make([]any, 0) + d.context = &decodeContext{parent: d.context} for { // Look ahead for ] - can only happen on first iteration. d.scanWhile(scanSkipSpace) @@ -1058,13 +1084,16 @@ func (d *decodeState) arrayInterface() []any { if d.opcode != scanArrayValue { panic(phasePanicMsg) } + d.context.index++ } + d.context = d.context.parent return v } // objectInterface is like object but returns map[string]interface{}. func (d *decodeState) objectInterface() map[string]any { m := make(map[string]any) + d.context = &decodeContext{parent: d.context} for { // Read opening " of string key or closing }. d.scanWhile(scanSkipSpace) @@ -1084,6 +1113,7 @@ func (d *decodeState) objectInterface() map[string]any { if !ok { panic(phasePanicMsg) } + d.context.key = key // Read : before value. if d.opcode == scanSkipSpace { @@ -1107,7 +1137,9 @@ func (d *decodeState) objectInterface() map[string]any { if d.opcode != scanObjectValue { panic(phasePanicMsg) } + d.context.index++ } + d.context = d.context.parent return m } diff --git a/common/json/internal/contextjson/decode_context.go b/common/json/internal/contextjson/decode_context.go new file mode 100644 index 0000000..3000926 --- /dev/null +++ b/common/json/internal/contextjson/decode_context.go @@ -0,0 +1,49 @@ +package json + +import "strconv" + +type decodeContext struct { + parent *decodeContext + index int + key string +} + +func (d *decodeState) formatContext() string { + var description string + context := d.context + var appendDot bool + for context != nil { + if appendDot { + description = "." + description + } + if context.key != "" { + description = context.key + description + appendDot = true + } else { + description = "[" + strconv.Itoa(context.index) + "]" + description + appendDot = false + } + context = context.parent + } + return description +} + +type contextError struct { + parent error + context string + index bool +} + +func (c *contextError) Unwrap() error { + return c.parent +} + +func (c *contextError) Error() string { + //goland:noinspection GoTypeAssertionOnErrors + switch c.parent.(type) { + case *contextError: + return c.context + "." + c.parent.Error() + default: + return c.context + ": " + c.parent.Error() + } +}