fix: sort the incoming keys from the log output (#116)

Skarlso · web-flow · commit cc5a0fb57ffb · 2025-05-20T11:14:18.000+02:00
Signed-off-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com> On-behalf-of: @SAP gergely.brautigam@sap.com
diff --git a/bindings/go/plugin/manager/registries/plugins/log_streamer.go b/bindings/go/plugin/manager/registries/plugins/log_streamer.go
@@ -6,6 +6,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log/slog"
+	"sort"
 
 	"ocm.software/open-component-model/bindings/go/plugin/manager/types"
 )
@@ -118,8 +119,17 @@ func parseLine(line string) (record, error) {
 	delete(parsed, "msg")
 	delete(parsed, "level")
 
-	for k, v := range parsed {
-		result.args = append(result.args, k, v)
+	var keys []string
+
+	for k := range parsed {
+		keys = append(keys, k)
+	}
+
+	// make the output determinable
+	sort.Strings(keys)
+
+	for _, k := range keys {
+		result.args = append(result.args, k, parsed[k])
 	}
 
 	return result, nil
diff --git a/bindings/go/plugin/manager/registries/plugins/log_streamer_test.go b/bindings/go/plugin/manager/registries/plugins/log_streamer_test.go
@@ -28,6 +28,19 @@ func TestParseLine(t *testing.T) {
 			},
 			wantErr: false,
 		},
+		{
+			name: "make sure args are sorted",
+			// notice that order is key2, key1 but the output should be key1, key2
+			// this is unlikely as slog also orders, but the result is parsed into a map
+			// so that would fail from time to time on the other end
+			input: `{"level":"info","msg":"test message","key2":42,"key1":"value1"}`,
+			want: record{
+				level: "info",
+				msg:   "test message",
+				args:  []any{"key1", "value1", "key2", float64(42)},
+			},
+			wantErr: false,
+		},
 		{
 			name:    "invalid JSON",
 			input:   `{"level":"info","msg":"test message"`,
