[CHA-1633] - Fix ExtraData double-nesting behavior (#362)

* fix ExtraData double-nesting behavior

* fixing test

* bump major version

* bumped go version

Author: totalimmersion

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       max-parallel: 3
       fail-fast: false
       matrix:
-        goVer: ['1.22', '1.23', '1.24']
+        goVer: ['1.23', '1.24', '1.25']
     steps:
       - uses: actions/checkout@v4
 

.github/workflows/lint.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: "1.22"
+          go-version: "1.25"
 
       - name: Tidy
         run: go mod tidy -v && git diff --no-patch --exit-code || { git status;  echo 'Unchecked diff, did you forget go mod tidy again?' ; false ; };

.github/workflows/reviewdog.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.22'
+          go-version: '1.25'
 
       - name: Install golangci-lint
         run: make install-golangci

.github/workflows/scheduled_test.yml

@@ -14,7 +14,7 @@ jobs:
 
       - uses: actions/setup-go@v3
         with:
-          go-version: "1.22"
+          go-version: "1.25"
 
       - name: Run tests
         env:

README.md

@@ -1,7 +1,7 @@
 # Official Go SDK for [Stream Chat](https://getstream.io/chat/)
 
 [![build](https://github.com/GetStream/stream-chat-go/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-go/actions)
-[![godoc](https://pkg.go.dev/badge/GetStream/stream-chat-go)](https://pkg.go.dev/github.com/GetStream/stream-chat-go/v7?tab=doc)
+[![godoc](https://pkg.go.dev/badge/GetStream/stream-chat-go)](https://pkg.go.dev/github.com/GetStream/stream-chat-go/v8?tab=doc)
 
 <p align="center">
     <img src="./assets/logo.svg" width="50%" height="50%">
@@ -28,7 +28,7 @@ For the client-side integrations (web and mobile) have a look at the JavaScript,
 ## ⚙️ Installation
 
 ```shell
-go get github.com/GetStream/stream-chat-go/v7
+go get github.com/GetStream/stream-chat-go/v8
 ```
 
 ## ✨ Getting started
@@ -39,7 +39,7 @@ package main
 import (
 	"os"
 
-	stream "github.com/GetStream/stream-chat-go/v7"
+	stream "github.com/GetStream/stream-chat-go/v8"
 )
 
 var APIKey = os.Getenv("STREAM_KEY")

channel.go

@@ -70,6 +70,7 @@ func (m *ChannelMember) UnmarshalJSON(data []byte) error {
 	}
 
 	removeFromMap(m.ExtraData, *m)
+	flattenExtraData(m.ExtraData)
 	return nil
 }
 
@@ -144,6 +145,7 @@ func (ch *Channel) UnmarshalJSON(data []byte) error {
 	}
 
 	removeFromMap(ch.ExtraData, *ch)
+	flattenExtraData(ch.ExtraData)
 	return nil
 }
 
@@ -191,6 +193,7 @@ func (c *ChannelRequest) UnmarshalJSON(data []byte) error {
 	}
 
 	removeFromMap(c.ExtraData, *c)
+	flattenExtraData(c.ExtraData)
 	return nil
 }
 

event.go

@@ -108,6 +108,7 @@ func (e *Event) UnmarshalJSON(data []byte) error {
 	}
 
 	removeFromMap(e.ExtraData, *e)
+	flattenExtraData(e.ExtraData)
 	return nil
 }
 
@@ -161,6 +162,7 @@ func (e *UserCustomEvent) UnmarshalJSON(data []byte) error {
 	}
 
 	removeFromMap(e.ExtraData, *e)
+	flattenExtraData(e.ExtraData)
 	return nil
 }
 

go.mod

@@ -1,6 +1,6 @@
-module github.com/GetStream/stream-chat-go/v7
+module github.com/GetStream/stream-chat-go/v8
 
-go 1.22
+go 1.23
 
 require (
 	github.com/golang-jwt/jwt/v4 v4.5.1

json.go

@@ -27,6 +27,22 @@ func removeFromMap(m map[string]interface{}, obj interface{}) {
 	}
 }
 
+// flattenExtraData flattens the nested "extra_data" key if it exists.
+// The API may return custom fields nested under an "extra_data" key,
+// which should be flattened to the root level of the ExtraData map.
+func flattenExtraData(m map[string]interface{}) {
+	if extraData, ok := m["extra_data"]; ok {
+		if extraDataMap, ok := extraData.(map[string]interface{}); ok {
+			// Copy all fields from nested extra_data to root level
+			for k, v := range extraDataMap {
+				m[k] = v
+			}
+			// Remove the nested extra_data key
+			delete(m, "extra_data")
+		}
+	}
+}
+
 func addToMapAndMarshal(m map[string]interface{}, obj interface{}) ([]byte, error) {
 	m2 := copyMap(m)
 

json_test.go

@@ -16,10 +16,8 @@ func randomExtraData(in interface{}) {
 	}
 	f := v.FieldByName("ExtraData")
 	f.Set(reflect.ValueOf(map[string]interface{}{
-		"extra_data": map[string]interface{}{
-			"mystring": randomString(10),
-			"mybool":   rand.Float64() < 0.5,
-		},
+		"mystring":    randomString(10),
+		"mybool":      rand.Float64() < 0.5,
 		"data":        "custom",
 		"custom_data": "really_custom",
 		"extra": map[string]interface{}{
@@ -69,3 +67,65 @@ func TestJSON(t *testing.T) {
 	var r, r2 Reaction
 	testInvariantJSON(t, &r, &r2)
 }
+
+// TestFlattenExtraData tests the flattenExtraData function directly
+func TestFlattenExtraData(t *testing.T) {
+	t.Run("Flatten nested extra_data", func(t *testing.T) {
+		m := map[string]interface{}{
+			"field1": "value1",
+			"extra_data": map[string]interface{}{
+				"custom_field": "custom_value",
+				"another_field": 123,
+			},
+		}
+
+		flattenExtraData(m)
+
+		// Fields should be flattened
+		require.Equal(t, "custom_value", m["custom_field"])
+		require.Equal(t, 123, m["another_field"])
+		require.Equal(t, "value1", m["field1"])
+		// The nested "extra_data" key should not exist
+		require.NotContains(t, m, "extra_data")
+	})
+
+	t.Run("No extra_data key", func(t *testing.T) {
+		m := map[string]interface{}{
+			"field1": "value1",
+			"field2": 123,
+		}
+
+		flattenExtraData(m)
+
+		// Map should be unchanged
+		require.Equal(t, "value1", m["field1"])
+		require.Equal(t, 123, m["field2"])
+		require.Len(t, m, 2)
+	})
+
+	t.Run("extra_data is not a map", func(t *testing.T) {
+		m := map[string]interface{}{
+			"field1":     "value1",
+			"extra_data": "not_a_map",
+		}
+
+		flattenExtraData(m)
+
+		// extra_data should remain unchanged if it's not a map
+		require.Equal(t, "not_a_map", m["extra_data"])
+		require.Equal(t, "value1", m["field1"])
+	})
+
+	t.Run("Empty extra_data map", func(t *testing.T) {
+		m := map[string]interface{}{
+			"field1":     "value1",
+			"extra_data": map[string]interface{}{},
+		}
+
+		flattenExtraData(m)
+
+		// Empty extra_data should be removed
+		require.NotContains(t, m, "extra_data")
+		require.Equal(t, "value1", m["field1"])
+	})
+}