From 24afee20ba54978ba40ade36fcd1e2cc91d06568 Mon Sep 17 00:00:00 2001 From: Michael Hoffmann Date: Wed, 7 Feb 2024 16:04:20 +0100 Subject: [PATCH] Export `Event.Attachments` --- client_test.go | 8 ++++---- fasthttp/sentryfasthttp_test.go | 2 +- gin/sentrygin_test.go | 4 ++-- http/sentryhttp_test.go | 2 +- interfaces.go | 2 +- logrus/logrusentry_test.go | 2 +- scope.go | 2 +- scope_test.go | 8 ++++---- tracing_test.go | 6 +++--- transport.go | 2 +- transport_test.go | 2 +- 11 files changed, 20 insertions(+), 20 deletions(-) diff --git a/client_test.go b/client_test.go index 7f3f12d01..ac24361f0 100644 --- a/client_test.go +++ b/client_test.go @@ -80,7 +80,7 @@ func TestCaptureMessageEmptyString(t *testing.T) { } got := transport.lastEvent opts := cmp.Options{ - cmpopts.IgnoreFields(Event{}, "sdkMetaData", "attachments"), + cmpopts.IgnoreFields(Event{}, "sdkMetaData"), cmp.Transformer("SimplifiedEvent", func(e *Event) *Event { return &Event{ Exception: e.Exception, @@ -287,7 +287,7 @@ func TestCaptureEvent(t *testing.T) { }, } got := transport.lastEvent - opts := cmp.Options{cmpopts.IgnoreFields(Event{}, "Release", "sdkMetaData", "attachments")} + opts := cmp.Options{cmpopts.IgnoreFields(Event{}, "Release", "sdkMetaData")} if diff := cmp.Diff(want, got, opts); diff != "" { t.Errorf("Event mismatch (-want +got):\n%s", diff) } @@ -315,7 +315,7 @@ func TestCaptureEventNil(t *testing.T) { } got := transport.lastEvent opts := cmp.Options{ - cmpopts.IgnoreFields(Event{}, "sdkMetaData", "attachments"), + cmpopts.IgnoreFields(Event{}, "sdkMetaData"), cmp.Transformer("SimplifiedEvent", func(e *Event) *Event { return &Event{ Exception: e.Exception, @@ -763,7 +763,7 @@ func TestRecover(t *testing.T) { } got := events[0] opts := cmp.Options{ - cmpopts.IgnoreFields(Event{}, "sdkMetaData", "attachments"), + cmpopts.IgnoreFields(Event{}, "sdkMetaData"), cmp.Transformer("SimplifiedEvent", func(e *Event) *Event { return &Event{ Message: e.Message, diff --git a/fasthttp/sentryfasthttp_test.go b/fasthttp/sentryfasthttp_test.go index 25187acb9..c6dc923c2 100644 --- a/fasthttp/sentryfasthttp_test.go +++ b/fasthttp/sentryfasthttp_test.go @@ -208,7 +208,7 @@ func TestIntegration(t *testing.T) { sentry.Event{}, "Contexts", "EventID", "Extra", "Platform", "Modules", "Release", "Sdk", "ServerName", "Tags", "Timestamp", - "sdkMetaData", "attachments", + "sdkMetaData", ), cmpopts.IgnoreMapEntries(func(k string, v string) bool { // fasthttp changed Content-Length behavior in diff --git a/gin/sentrygin_test.go b/gin/sentrygin_test.go index b75e0f1f0..e959716d5 100644 --- a/gin/sentrygin_test.go +++ b/gin/sentrygin_test.go @@ -363,7 +363,7 @@ func TestIntegration(t *testing.T) { sentry.Event{}, "Contexts", "EventID", "Extra", "Platform", "Modules", "Release", "Sdk", "ServerName", "Tags", "Timestamp", - "sdkMetaData", "attachments", + "sdkMetaData", ), cmpopts.IgnoreFields( sentry.Request{}, @@ -387,7 +387,7 @@ func TestIntegration(t *testing.T) { sentry.Event{}, "Contexts", "EventID", "Platform", "Modules", "Release", "Sdk", "ServerName", "Timestamp", - "sdkMetaData", "StartTime", "Spans", "attachments", + "sdkMetaData", "StartTime", "Spans", ), cmpopts.IgnoreFields( sentry.Request{}, diff --git a/http/sentryhttp_test.go b/http/sentryhttp_test.go index 45c3eb039..b58245f59 100644 --- a/http/sentryhttp_test.go +++ b/http/sentryhttp_test.go @@ -211,7 +211,7 @@ func TestIntegration(t *testing.T) { sentry.Event{}, "Contexts", "EventID", "Extra", "Platform", "Modules", "Release", "Sdk", "ServerName", "Tags", "Timestamp", - "sdkMetaData", "attachments", + "sdkMetaData", ), cmpopts.IgnoreFields( sentry.Request{}, diff --git a/interfaces.go b/interfaces.go index 13517f647..6ea6d43b8 100644 --- a/interfaces.go +++ b/interfaces.go @@ -317,6 +317,7 @@ type Event struct { Request *Request `json:"request,omitempty"` Exception []Exception `json:"exception,omitempty"` DebugMeta *DebugMeta `json:"debug_meta,omitempty"` + Attachments []*Attachment `json:"-"` // The fields below are only relevant for transactions. @@ -333,7 +334,6 @@ type Event struct { // The fields below are not part of the final JSON payload. sdkMetaData SDKMetaData - attachments []*Attachment } // SetException appends the unwrapped errors to the event's exception list. diff --git a/logrus/logrusentry_test.go b/logrus/logrusentry_test.go index f36250ac9..afa532deb 100644 --- a/logrus/logrusentry_test.go +++ b/logrus/logrusentry_test.go @@ -250,7 +250,7 @@ func Test_entryToEvent(t *testing.T) { got := h.entryToEvent(tt.entry) opts := cmp.Options{ cmpopts.IgnoreFields(sentry.Event{}, - "sdkMetaData", "attachments", + "sdkMetaData", ), } if d := cmp.Diff(tt.want, got, opts); d != "" { diff --git a/scope.go b/scope.go index 2f961bad8..374010b67 100644 --- a/scope.go +++ b/scope.go @@ -344,7 +344,7 @@ func (scope *Scope) ApplyToEvent(event *Event, hint *EventHint) *Event { } if len(scope.attachments) > 0 { - event.attachments = append(event.attachments, scope.attachments...) + event.Attachments = append(event.Attachments, scope.attachments...) } if len(scope.tags) > 0 { diff --git a/scope_test.go b/scope_test.go index 9656c1801..c855a22e2 100644 --- a/scope_test.go +++ b/scope_test.go @@ -34,7 +34,7 @@ func fillScopeWithData(scope *Scope) *Scope { func fillEventWithData(event *Event) *Event { event.Breadcrumbs = []*Breadcrumb{{Timestamp: testNow, Message: "eventBreadcrumbMessage"}} - event.attachments = []*Attachment{ + event.Attachments = []*Attachment{ { Filename: "event-attachment.txt", Payload: []byte("Event attachment contents."), @@ -573,7 +573,7 @@ func TestApplyToEventWithCorrectScopeAndEvent(t *testing.T) { processedEvent := scope.ApplyToEvent(event, nil) assertEqual(t, len(processedEvent.Breadcrumbs), 2, "should merge breadcrumbs") - assertEqual(t, len(processedEvent.attachments), 2, "should merge attachments") + assertEqual(t, len(processedEvent.Attachments), 2, "should merge attachments") assertEqual(t, len(processedEvent.Tags), 2, "should merge tags") assertEqual(t, len(processedEvent.Contexts), 3, "should merge contexts") assertEqual(t, event.Contexts[sharedContextsKey], event.Contexts[sharedContextsKey], "should not override event context") @@ -591,7 +591,7 @@ func TestApplyToEventUsingEmptyScope(t *testing.T) { processedEvent := scope.ApplyToEvent(event, nil) assertEqual(t, len(processedEvent.Breadcrumbs), 1, "should use event breadcrumbs") - assertEqual(t, len(processedEvent.attachments), 1, "should use event attachments") + assertEqual(t, len(processedEvent.Attachments), 1, "should use event attachments") assertEqual(t, len(processedEvent.Tags), 1, "should use event tags") assertEqual(t, len(processedEvent.Contexts), 2, "should use event contexts") assertEqual(t, len(processedEvent.Extra), 1, "should use event extra") @@ -608,7 +608,7 @@ func TestApplyToEventUsingEmptyEvent(t *testing.T) { processedEvent := scope.ApplyToEvent(event, nil) assertEqual(t, len(processedEvent.Breadcrumbs), 1, "should use scope breadcrumbs") - assertEqual(t, len(processedEvent.attachments), 1, "should use scope attachments") + assertEqual(t, len(processedEvent.Attachments), 1, "should use scope attachments") assertEqual(t, len(processedEvent.Tags), 1, "should use scope tags") assertEqual(t, len(processedEvent.Contexts), 2, "should use scope contexts") assertEqual(t, len(processedEvent.Extra), 1, "should use scope extra") diff --git a/tracing_test.go b/tracing_test.go index dcced2c34..505513608 100644 --- a/tracing_test.go +++ b/tracing_test.go @@ -157,7 +157,7 @@ func TestStartSpan(t *testing.T) { cmpopts.IgnoreFields(Event{}, "Contexts", "EventID", "Level", "Platform", "Release", "Sdk", "ServerName", "Modules", - "sdkMetaData", "attachments", + "sdkMetaData", ), cmpopts.EquateEmpty(), } @@ -221,7 +221,7 @@ func TestStartChild(t *testing.T) { cmpopts.IgnoreFields(Event{}, "EventID", "Level", "Platform", "Modules", "Release", "Sdk", "ServerName", "Timestamp", "StartTime", - "sdkMetaData", "attachments", + "sdkMetaData", ), cmpopts.IgnoreMapEntries(func(k string, v interface{}) bool { return k != "trace" @@ -302,7 +302,7 @@ func TestStartTransaction(t *testing.T) { cmpopts.IgnoreFields(Event{}, "Contexts", "EventID", "Level", "Platform", "Release", "Sdk", "ServerName", "Modules", - "sdkMetaData", "attachments", + "sdkMetaData", ), cmpopts.EquateEmpty(), } diff --git a/transport.go b/transport.go index 3eee45845..0d034622d 100644 --- a/transport.go +++ b/transport.go @@ -185,7 +185,7 @@ func envelopeFromBody(event *Event, dsn *Dsn, sentAt time.Time, body json.RawMes } // Attachments - for _, attachment := range event.attachments { + for _, attachment := range event.Attachments { if err := encodeAttachment(enc, &b, attachment); err != nil { return nil, err } diff --git a/transport_test.go b/transport_test.go index 112bc6130..74bd2ea45 100644 --- a/transport_test.go +++ b/transport_test.go @@ -194,7 +194,7 @@ func TestEnvelopeFromTransactionBody(t *testing.T) { func TestEnvelopeFromEventWithAttachments(t *testing.T) { event := newTestEvent(eventType) - event.attachments = []*Attachment{ + event.Attachments = []*Attachment{ // Empty content-type and payload { Filename: "empty.txt",