adjust jsonv2 output to become similar to v1

Author: junoberryferry

models/webhook/webhook.go

@@ -150,7 +150,14 @@ func init() {
 // AfterLoad updates the webhook object upon setting a column
 func (w *Webhook) AfterLoad() {
 	w.HookEvent = &webhook_module.HookEvent{}
-	if err := json.Unmarshal([]byte(w.Events), w.HookEvent); err != nil {
+
+	events := w.Events
+	if events == "" {
+		// jsonv2 is unable to unmarshal an empty string
+		return
+	}
+
+	if err := json.Unmarshal([]byte(events), w.HookEvent); err != nil {
 		log.Error("Unmarshal[%d]: %v", w.ID, err)
 	}
 }

modules/json/json.go

@@ -174,7 +174,7 @@ func Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error {
 
 // MarshalIndent copied from encoding/json
 func MarshalIndent(v any, prefix, indent string) ([]byte, error) {
-	b, err := Marshal(v)
+	b, err := DefaultJSONHandler.Marshal(v)
 	if err != nil {
 		return nil, err
 	}
@@ -200,6 +200,12 @@ func UnmarshalHandleDoubleEncode(bs []byte, v any) error {
 		// To be consistent, we should treat all empty inputs as success
 		return nil
 	}
+
+	trimmed := bytes.TrimSpace(bs)
+	if len(trimmed) == 0 {
+		return nil
+	}
+
 	err := DefaultJSONHandler.Unmarshal(bs, v)
 	if err != nil {
 		ok := true

modules/json/jsonv2.go

@@ -6,6 +6,7 @@
 package json
 
 import (
+	"bytes"
 	jsonv2 "encoding/json/v2" //nolint:depguard // this package wraps it
 	"io"
 )
@@ -15,18 +16,38 @@ func isJSONv2Available() bool {
 	return true
 }
 
-// marshalV2 uses JSON v2 marshal with v1 compatibility options
-func marshalV2(v any) ([]byte, error) {
+// marshalV2Internal uses JSON v2 marshal with v1 compatibility options (no trailing newline)
+func marshalV2Internal(v any) ([]byte, error) {
 	opts := jsonv2.JoinOptions(
 		jsonv2.MatchCaseInsensitiveNames(true),
 		jsonv2.FormatNilSliceAsNull(true),
 		jsonv2.FormatNilMapAsNull(true),
+		jsonv2.Deterministic(true),
 	)
 	return jsonv2.Marshal(v, opts)
 }
 
+// marshalV2 uses JSON v2 marshal with v1 compatibility options (with trailing newline for compatibility with standard library)
+func marshalV2(v any) ([]byte, error) {
+	result, err := marshalV2Internal(v)
+	if err != nil {
+		return nil, err
+	}
+
+	return append(result, '\n'), nil
+}
+
 // unmarshalV2 uses JSON v2 unmarshal with v1 compatibility options
 func unmarshalV2(data []byte, v any) error {
+	if len(data) == 0 {
+		return nil
+	}
+
+	data = bytes.TrimSpace(data)
+	if len(data) == 0 {
+		return nil
+	}
+
 	opts := jsonv2.JoinOptions(
 		jsonv2.MatchCaseInsensitiveNames(true),
 	)
@@ -40,7 +61,13 @@ type encoderV2 struct {
 }
 
 func (e *encoderV2) Encode(v any) error {
-	return jsonv2.MarshalWrite(e.writer, v, e.opts)
+	err := jsonv2.MarshalWrite(e.writer, v, e.opts)
+	if err != nil {
+		return err
+	}
+
+	_, err = e.writer.Write([]byte{'\n'})
+	return err
 }
 
 // newEncoderV2 creates a new JSON v2 streaming encoder
@@ -49,6 +76,7 @@ func newEncoderV2(writer io.Writer) Encoder {
 		jsonv2.MatchCaseInsensitiveNames(true),
 		jsonv2.FormatNilSliceAsNull(true),
 		jsonv2.FormatNilMapAsNull(true),
+		jsonv2.Deterministic(true),
 	)
 	return &encoderV2{writer: writer, opts: opts}
 }
@@ -60,7 +88,12 @@ type decoderV2 struct {
 }
 
 func (d *decoderV2) Decode(v any) error {
-	return jsonv2.UnmarshalRead(d.reader, v, d.opts)
+	err := jsonv2.UnmarshalRead(d.reader, v, d.opts)
+	// Handle EOF more gracefully to match standard library behavior
+	if err != nil && err.Error() == "unexpected EOF" {
+		return io.EOF
+	}
+	return err
 }
 
 // newDecoderV2 creates a new JSON v2 streaming decoder

services/webhook/deliver_test.go

@@ -142,13 +142,13 @@ func TestWebhookDeliverHookTask(t *testing.T) {
 			assert.NoError(t, err)
 			assert.Equal(t, `{"data": 42}`, string(body))
 
-		case "/webhook/6db5dc1e282529a8c162c7fe93dd2667494eeb51":
+		case "/webhook/4ddf3b1533e54f082ae6eadfc1b5530be36c8893":
 			// Version 2
 			assert.Equal(t, "push", r.Header.Get("X-GitHub-Event"))
 			assert.Equal(t, "application/json", r.Header.Get("Content-Type"))
 			body, err := io.ReadAll(r.Body)
 			assert.NoError(t, err)
-			assert.Len(t, body, 2147)
+			assert.Len(t, body, 2047)
 
 		default:
 			w.WriteHeader(http.StatusNotFound)

services/webhook/matrix_test.go

@@ -216,7 +216,7 @@ func TestMatrixJSONPayload(t *testing.T) {
 	require.NoError(t, err)
 
 	assert.Equal(t, "PUT", req.Method)
-	assert.Equal(t, "/_matrix/client/r0/rooms/ROOM_ID/send/m.room.message/6db5dc1e282529a8c162c7fe93dd2667494eeb51", req.URL.Path)
+	assert.Equal(t, "/_matrix/client/r0/rooms/ROOM_ID/send/m.room.message/4ddf3b1533e54f082ae6eadfc1b5530be36c8893", req.URL.Path)
 	assert.Equal(t, "sha256=", req.Header.Get("X-Hub-Signature-256"))
 	assert.Equal(t, "application/json", req.Header.Get("Content-Type"))
 	var body MatrixPayload