fine tune

Author: wxiaoguang

modules/json/json_test.go

@@ -4,6 +4,7 @@
 package json
 
 import (
+	"bytes"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -16,3 +17,12 @@ func TestGiteaDBJSONUnmarshal(t *testing.T) {
 	err = UnmarshalHandleDoubleEncode([]byte(""), &m)
 	assert.NoError(t, err)
 }
+
+func TestIndent(t *testing.T) {
+	buf := &bytes.Buffer{}
+	err := Indent(buf, []byte(`{"a":1}`), ">", "  ")
+	assert.NoError(t, err)
+	assert.Equal(t, `{
+>  "a": 1
+>}`, buf.String())
+}

modules/json/jsonlegacy.go

@@ -5,12 +5,20 @@
 
 package json
 
-import jsoniter "github.com/json-iterator/go"
+import (
+	"io"
+
+	jsoniter "github.com/json-iterator/go"
+)
 
 func getDefaultJSONHandler() Interface {
 	return JSONiter{jsoniter.ConfigCompatibleWithStandardLibrary}
 }
 
-func MarshalKeepOptionalEmpty(v any) ([]byte, error) {
-	return DefaultJSONHandler.Marshal(v)
+func NewEncoderOptionalEmpty(writer io.Writer) Encoder {
+	return DefaultJSONHandler.NewEncoder(writer)
+}
+
+func NewDecoderCaseInsensitive(reader io.Reader) Decoder {
+	return DefaultJSONHandler.NewDecoder(reader)
 }

modules/json/jsonv2.go

@@ -16,8 +16,9 @@ import (
 // Requires GOEXPERIMENT=jsonv2 to be set at build time
 type JSONv2 struct {
 	marshalOptions                  jsonv2.Options
-	marshalKeepOptionalEmptyOptions jsonv2.Options
+	marshalOptionalEmptyOptions     jsonv2.Options
 	unmarshalOptions                jsonv2.Options
+	unmarshalCaseInsensitiveOptions jsonv2.Options
 }
 
 var jsonV2 JSONv2
@@ -28,58 +29,63 @@ func init() {
 		jsonv2.FormatNilMapAsNull(true),
 	}
 	jsonV2.marshalOptions = jsonv2.JoinOptions(commonMarshalOptions...)
+	jsonV2.unmarshalOptions = jsonv2.DefaultOptionsV2()
 
-	// Some JSON structs like oci.ImageConfig uses case-insensitive matching
-	jsonV2.unmarshalOptions = jsonv2.JoinOptions(jsonv2.MatchCaseInsensitiveNames(true))
-
-	// by default, "json/v2" omitempty removes all `""` empty strings, no matter where it comes from.
+	// By default, "json/v2" omitempty removes all `""` empty strings, no matter where it comes from.
 	// v1 has a different behavior: if the `""` is from a null pointer, or a Marshal function, it is kept.
-	jsonV2.marshalKeepOptionalEmptyOptions = jsonv2.JoinOptions(append(commonMarshalOptions, jsonv1.OmitEmptyWithLegacySemantics(true))...)
+	jsonV2.marshalOptionalEmptyOptions = jsonv2.JoinOptions(append(commonMarshalOptions, jsonv1.OmitEmptyWithLegacySemantics(true))...)
+
+	// Some legacy code uses case-insensitive matching (for example: parsing oci.ImageConfig)
+	jsonV2.unmarshalCaseInsensitiveOptions = jsonv2.JoinOptions(jsonv2.MatchCaseInsensitiveNames(true))
 }
 
 func getDefaultJSONHandler() Interface {
 	return &jsonV2
 }
 
-func MarshalKeepOptionalEmpty(v any) ([]byte, error) {
-	return jsonv2.Marshal(v, jsonV2.marshalKeepOptionalEmptyOptions)
-}
-
-func (j JSONv2) Marshal(v any) ([]byte, error) {
+func (j *JSONv2) Marshal(v any) ([]byte, error) {
 	return jsonv2.Marshal(v, j.marshalOptions)
 }
 
-func (j JSONv2) Unmarshal(data []byte, v any) error {
+func (j *JSONv2) Unmarshal(data []byte, v any) error {
 	return jsonv2.Unmarshal(data, v, j.unmarshalOptions)
 }
 
-func (j JSONv2) NewEncoder(writer io.Writer) Encoder {
-	return &encoderV2{writer: writer, opts: j.marshalOptions}
+func (j *JSONv2) NewEncoder(writer io.Writer) Encoder {
+	return &jsonV2Encoder{writer: writer, opts: j.marshalOptions}
 }
 
-func (j JSONv2) NewDecoder(reader io.Reader) Decoder {
-	return &decoderV2{reader: reader, opts: j.unmarshalOptions}
+func (j *JSONv2) NewDecoder(reader io.Reader) Decoder {
+	return &jsonV2Decoder{reader: reader, opts: j.unmarshalOptions}
 }
 
 // Indent implements Interface using standard library (JSON v2 doesn't have Indent yet)
-func (JSONv2) Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error {
+func (*JSONv2) Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error {
 	return jsonv1.Indent(dst, src, prefix, indent)
 }
 
-type encoderV2 struct {
+type jsonV2Encoder struct {
 	writer io.Writer
 	opts   jsonv2.Options
 }
 
-func (e *encoderV2) Encode(v any) error {
+func (e *jsonV2Encoder) Encode(v any) error {
 	return jsonv2.MarshalWrite(e.writer, v, e.opts)
 }
 
-type decoderV2 struct {
+type jsonV2Decoder struct {
 	reader io.Reader
 	opts   jsonv2.Options
 }
 
-func (d *decoderV2) Decode(v any) error {
+func (d *jsonV2Decoder) Decode(v any) error {
 	return jsonv2.UnmarshalRead(d.reader, v, d.opts)
 }
+
+func NewEncoderOptionalEmpty(writer io.Writer) Encoder {
+	return &jsonV2Encoder{writer: writer, opts: jsonV2.marshalOptionalEmptyOptions}
+}
+
+func NewDecoderCaseInsensitive(reader io.Reader) Decoder {
+	return &jsonV2Decoder{reader: reader, opts: jsonV2.unmarshalCaseInsensitiveOptions}
+}

modules/optional/serialization_test.go

@@ -5,6 +5,7 @@ package optional_test
 
 import (
 	std_json "encoding/json" //nolint:depguard // for testing purpose
+	"strings"
 	"testing"
 
 	"code.gitea.io/gitea/modules/json"
@@ -54,11 +55,12 @@ func TestOptionalToJson(t *testing.T) {
 	}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
-			b, err := json.MarshalKeepOptionalEmpty(tc.obj)
+			buf := &strings.Builder{}
+			err := json.NewEncoderOptionalEmpty(buf).Encode(tc.obj)
 			assert.NoError(t, err)
-			assert.Equal(t, tc.want, string(b), "gitea json module returned unexpected")
+			assert.Equal(t, tc.want, buf.String(), "gitea json module returned unexpected")
 
-			b, err = std_json.Marshal(tc.obj)
+			b, err := std_json.Marshal(tc.obj)
 			assert.NoError(t, err)
 			assert.Equal(t, tc.want, string(b), "std json module returned unexpected")
 		})

modules/packages/container/metadata.go

@@ -103,7 +103,9 @@ func ParseImageConfig(mediaType string, r io.Reader) (*Metadata, error) {
 
 func parseOCIImageConfig(r io.Reader) (*Metadata, error) {
 	var image oci.Image
-	if err := json.NewDecoder(r).Decode(&image); err != nil {
+	// FIXME: JSON-KEY-CASE: here seems a abuse of the case-insensitive decoding feature, spec is case-sensitive
+	// https://github.com/opencontainers/image-spec/blob/main/schema/config-schema.json
+	if err := json.NewDecoderCaseInsensitive(r).Decode(&image); err != nil {
 		return nil, err
 	}
 

modules/packages/container/metadata_test.go

@@ -22,7 +22,7 @@ func TestParseImageConfig(t *testing.T) {
 	repositoryURL := "https://gitea.com/gitea"
 	documentationURL := "https://docs.gitea.com"
 
-	// FIXME: the test case is not right, the config fields are capitalized in the spec
+	// FIXME: JSON-KEY-CASE: the test case is not right, the config fields are capitalized in the spec
 	// https://github.com/opencontainers/image-spec/blob/main/schema/config-schema.json
 	configOCI := `{"config": {"labels": {"` + labelAuthors + `": "` + author + `", "` + labelLicenses + `": "` + license + `", "` + labelURL + `": "` + projectURL + `", "` + labelSource + `": "` + repositoryURL + `", "` + labelDocumentation + `": "` + documentationURL + `", "` + labelDescription + `": "` + description + `"}}, "history": [{"created_by": "do it 1"}, {"created_by": "dummy #(nop) do it 2"}]}`
 

tests/integration/integration_test.go

@@ -413,7 +413,8 @@ func logUnexpectedResponse(t testing.TB, recorder *httptest.ResponseRecorder) {
 func DecodeJSON(t testing.TB, resp *httptest.ResponseRecorder, v any) {
 	t.Helper()
 
-	decoder := json.NewDecoder(resp.Body)
+	// FIXME: JSON-KEY-CASE: for testing purpose only, because many structs don't provide `json` tags, they just use capitalized field names
+	decoder := json.NewDecoderCaseInsensitive(resp.Body)
 	require.NoError(t, decoder.Decode(v))
 }