Merge pull request #1117 from sargas/deterministic-json-serialization

Sort extensions during JSON serialization

v2/event/event_marshal.go

@@ -10,6 +10,7 @@ import (
 	"encoding/base64"
 	"fmt"
 	"io"
+	"slices"
 	"strings"
 
 	jsoniter "github.com/json-iterator/go"
@@ -179,10 +180,16 @@ func WriteJson(in *Event, writer io.Writer) error {
 		return fmt.Errorf("error while writing the event data: %w", stream.Error)
 	}
 
-	for k, v := range ext {
+	// Add extensions in a deterministic predictable order, similar to how Go maps are serialized in a predictable order.
+	extensionNames := make([]string, 0, len(ext))
+	for extName := range ext {
+		extensionNames = append(extensionNames, extName)
+	}
+	slices.Sort(extensionNames)
+	for _, extName := range extensionNames {
 		stream.WriteMore()
-		stream.WriteObjectField(k)
-		stream.WriteVal(v)
+		stream.WriteObjectField(extName)
+		stream.WriteVal(ext[extName])
 	}
 
 	stream.WriteObjectEnd()

v2/event/event_marshal_test.go

@@ -6,9 +6,12 @@
 package event_test
 
 import (
+	"bytes"
 	"encoding/base64"
 	"encoding/json"
 	"net/url"
+	"slices"
+	"strings"
 	"testing"
 	"time"
 
@@ -384,20 +387,21 @@ func TestMarshal(t *testing.T) {
 	}
 	for n, tc := range testCases {
 		t.Run(n, func(t *testing.T) {
-			event := tc.event
+			testEvent := tc.event
 
 			for k, v := range tc.eventExtensions {
-				event.SetExtension(k, v)
+				testEvent.SetExtension(k, v)
 			}
 
-			gotBytes, err := json.Marshal(event)
+			gotBytes, err := json.Marshal(testEvent)
 
 			if tc.wantErr != nil {
 				require.Error(t, err, *tc.wantErr)
 				return
 			}
 
 			assertJsonEquals(t, tc.want, gotBytes)
+			assertExtensionsAreOrdered(t, tc.eventExtensions, gotBytes)
 		})
 	}
 }
@@ -420,3 +424,28 @@ func assertJsonEquals(t *testing.T, want map[string]interface{}, got []byte) {
 
 	require.Equal(t, wantToCompare, gotToCompare)
 }
+
+func assertExtensionsAreOrdered(t *testing.T, extensions map[string]any, got []byte) {
+	type extensionLocation struct {
+		extension string
+		idx       int
+	}
+	extensionLocations := make([]extensionLocation, 0, len(extensions))
+	for ext := range extensions {
+		extensionLocations = append(extensionLocations, extensionLocation{
+			extension: ext,
+			idx:       bytes.Index(got, []byte(ext)),
+		})
+	}
+
+	// Sort by extension name
+	slices.SortFunc(extensionLocations, func(i, j extensionLocation) int {
+		return strings.Compare(i.extension, j.extension)
+	})
+	indexes := make([]int, 0, len(extensions))
+	for ext := range extensionLocations {
+		indexes = append(indexes, extensionLocations[ext].idx)
+	}
+
+	require.IsIncreasingf(t, indexes, "Expected ordered extensions, found extensions at: %+v", extensionLocations)
+}