Merge pull request #228 from bugsnag/next

## 2.4.0 (2024-04-15) ### Enhancements * Sanitize for metadata should also handler json and []byte [#226](#226) [Chris Duncan](https://github.com/veqryn)
bugsnag · Apr 15, 2024 · 4ae0bc0 · 4ae0bc0
2 parents c17eb96 + 245bce0
commit 4ae0bc0
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.4.0 (2024-04-15)
+
+### Enhancements
+
+* Sanitize for metadata should also handler json and []byte
+  [#226](https://github.com/bugsnag/bugsnag-go/pull/226)
+  [Chris Duncan](https://github.com/veqryn)
+
 ## 2.3.1 (2024-03-18)
 
 ### Bug fixes

diff --git a/v2/bugsnag.go b/v2/bugsnag.go
@@ -21,7 +21,7 @@ import (
 )
 
 // Version defines the version of this Bugsnag notifier
-const Version = "2.3.1"
+const Version = "2.4.0"
 
 var panicHandlerOnce sync.Once
 var sessionTrackerOnce sync.Once

diff --git a/v2/metadata.go b/v2/metadata.go
@@ -2,6 +2,7 @@ package bugsnag
 
 import (
 	"encoding"
+	"encoding/json"
 	"fmt"
 	"reflect"
 	"strings"
@@ -98,7 +99,7 @@ func (s sanitizer) Sanitize(data interface{}) interface{} {
 		}
 	}
 
-	// Handle certain well known interfaces and types
+	// Handle certain well known interfaces and types, in preferred order
 	switch dataT := data.(type) {
 	case error:
 		return dataT.Error()
@@ -114,6 +115,14 @@ func (s sanitizer) Sanitize(data interface{}) interface{} {
 		if b, err := dataT.MarshalText(); err == nil {
 			return string(b)
 		}
+
+	case json.Marshaler:
+		if b, err := dataT.MarshalJSON(); err == nil {
+			return string(b)
+		}
+
+	case []byte:
+		return string(dataT)
 	}
 
 	switch t.Kind() {

diff --git a/v2/metadata_test.go b/v2/metadata_test.go
@@ -1,6 +1,7 @@
 package bugsnag
 
 import (
+	"encoding/json"
 	stderrors "errors"
 	"reflect"
 	"testing"
@@ -112,13 +113,13 @@ func TestMetadataAddPointer(t *testing.T) {
 
 func TestMetadataAddNil(t *testing.T) {
 	md := MetaData{}
-	md.AddStruct("map", map[string]interface{}{
-		"data": _testStruct{Name: nil},
-	})
 
 	var nilMap map[string]interface{}
 	md.AddStruct("nilmap", nilMap)
 
+	var nilSlice []interface{}
+	md.AddStruct("nilSlice", nilSlice)
+
 	var nilError _testError
 	md.AddStruct("error", nilError)
 
@@ -137,20 +138,77 @@ func TestMetadataAddNil(t *testing.T) {
 	var marshalFullPtr = &_textMarshaller{}
 	md.AddStruct("marshalFullPtr", marshalFullPtr)
 
+	var nullJsonMarshaller json.RawMessage
+	md.AddStruct("nullJsonMarshaller", nullJsonMarshaller)
+
+	var nullJsonMarshallerPtr *json.RawMessage
+	md.AddStruct("nullJsonMarshallerPtr", nullJsonMarshallerPtr)
+
+	var emptyJsonMarshaller = &json.RawMessage{}
+	md.AddStruct("emptyJsonMarshaller", emptyJsonMarshaller)
+
+	var nilBytes []byte
+	md.AddStruct("nilBytes", nilBytes)
+
+	var nilBytesPtr *[]byte
+	md.AddStruct("nilBytesPtr", nilBytesPtr)
+
+	var emptyBytes = []byte{}
+	md.AddStruct("emptyBytes", emptyBytes)
+
+	md.AddStruct("map", map[string]interface{}{
+		"data":                  _testStruct{Name: nil},
+		"nilmap":                nilMap,
+		"nilSlice":              nilSlice,
+		"error":                 nilError,
+		"errorNilPtr":           nilErrorPtr,
+		"timeUnset":             timeVar,
+		"durationUnset":         duration,
+		"marshalNilPtr":         marshalNilPtr,
+		"marshalFullPtr":        marshalFullPtr,
+		"nullJsonMarshaller":    nullJsonMarshaller,
+		"nullJsonMarshallerPtr": nullJsonMarshallerPtr,
+		"emptyJsonMarshaller":   emptyJsonMarshaller,
+		"nilBytes":              nilBytes,
+		"nilBytesPtr":           nilBytesPtr,
+		"emptyBytes":            emptyBytes,
+	})
+
 	if !reflect.DeepEqual(md, MetaData{
 		"map": {
 			"data": map[string]interface{}{
 				"Name": "<nil>",
 			},
+			"nilmap":                map[string]interface{}{},
+			"nilSlice":              []interface{}{},
+			"error":                 "errorstr",
+			"errorNilPtr":           "<nil>",
+			"timeUnset":             "0001-01-01T00:00:00Z",
+			"durationUnset":         "0s",
+			"marshalFullPtr":        "marshalled text",
+			"marshalNilPtr":         "<nil>",
+			"nullJsonMarshaller":    "null",
+			"nullJsonMarshallerPtr": "<nil>",
+			"emptyJsonMarshaller":   "",
+			"nilBytes":              "",
+			"nilBytesPtr":           "<nil>",
+			"emptyBytes":            "",
 		},
 		"nilmap": map[string]interface{}{},
 		"Extra data": {
-			"error":          "errorstr",
-			"errorNilPtr":    "<nil>",
-			"timeUnset":      "0001-01-01T00:00:00Z",
-			"durationUnset":  "0s",
-			"marshalFullPtr": "marshalled text",
-			"marshalNilPtr":  "<nil>",
+			"nilSlice":              []interface{}{},
+			"error":                 "errorstr",
+			"errorNilPtr":           "<nil>",
+			"timeUnset":             "0001-01-01T00:00:00Z",
+			"durationUnset":         "0s",
+			"marshalFullPtr":        "marshalled text",
+			"marshalNilPtr":         "<nil>",
+			"nullJsonMarshaller":    "null",
+			"nullJsonMarshallerPtr": "<nil>",
+			"emptyJsonMarshaller":   "",
+			"nilBytes":              "",
+			"nilBytesPtr":           "<nil>",
+			"emptyBytes":            "",
 		},
 	}) {
 		t.Errorf("metadata.AddStruct didn't work: %#v", md)
@@ -215,6 +273,8 @@ func TestMetaDataSanitize(t *testing.T) {
 			"time":     time.Date(2023, 12, 5, 23, 59, 59, 123456789, time.UTC),
 			"duration": 105567462 * time.Millisecond,
 			"text":     _textMarshaller{},
+			"json":     json.RawMessage(`{"json_property": "json_value"}`),
+			"bytes":    []byte(`lots of bytes`),
 			"array": []hash{{
 				"creditcard": "1234567812345678",
 				"broken":     broken,
@@ -240,6 +300,8 @@ func TestMetaDataSanitize(t *testing.T) {
 			"time":     "2023-12-05T23:59:59.123456789Z",
 			"duration": "29h19m27.462s",
 			"text":     "marshalled text",
+			"json":     `{"json_property": "json_value"}`,
+			"bytes":    "lots of bytes",
 			"array": []interface{}{map[string]interface{}{
 				"creditcard": "[FILTERED]",
 				"broken": map[string]interface{}{