Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Scope values should not override Event values #446

Merged
merged 3 commits into from Oct 31, 2022
Merged

fix: Scope values should not override Event values #446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c16f7de
fix: Scope values should not override Event values
Jun 1, 2022
088f9c5
Merge branch 'master' into scope-not-override-event
cleptric Oct 30, 2022
380799f
Merge branch 'master' into scope-not-override-event
cleptric Oct 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion scope.go
View file
Open in desktop
Expand Up @@ -365,7 +365,11 @@ func (scope *Scope) ApplyToEvent(event *Event, hint *EventHint) *Event {
// to link errors and traces/spans in Sentry.
continue
}
event.Contexts[key] = value

// Ensure we are not overwriting event fields
if _, ok := event.Contexts[key]; !ok {
event.Contexts[key] = value
}
}
}

Expand Down
19 changes: 14 additions & 5 deletions scope_test.go
View file
Open in desktop
Expand Up @@ -7,13 +7,18 @@ import (
"time"
)

const sharedContextsKey = "sharedContextsKey"

var testNow = time.Now().UTC()

func fillScopeWithData(scope *Scope) *Scope {
scope.breadcrumbs = []*Breadcrumb{{Timestamp: testNow, Message: "scopeBreadcrumbMessage"}}
scope.user = User{ID: "1337"}
scope.tags = map[string]string{"scopeTagKey": "scopeTagValue"}
scope.contexts = map[string]Context{"scopeContextsKey": {"scopeContextKey": "scopeContextValue"}}
scope.contexts = map[string]Context{
"scopeContextsKey": {"scopeContextKey": "scopeContextValue"},
sharedContextsKey: {"scopeContextKey": "scopeContextValue"},
}
scope.extra = map[string]interface{}{"scopeExtraKey": "scopeExtraValue"}
scope.fingerprint = []string{"scopeFingerprintOne", "scopeFingerprintTwo"}
scope.level = LevelDebug
Expand All @@ -26,7 +31,10 @@ func fillEventWithData(event *Event) *Event {
event.Breadcrumbs = []*Breadcrumb{{Timestamp: testNow, Message: "eventBreadcrumbMessage"}}
event.User = User{ID: "42"}
event.Tags = map[string]string{"eventTagKey": "eventTagValue"}
event.Contexts = map[string]Context{"eventContextsKey": {"eventContextKey": "eventContextValue"}}
event.Contexts = map[string]Context{
"eventContextsKey": {"eventContextKey": "eventContextValue"},
sharedContextsKey: {"eventContextKey": "eventContextKey"},
}
event.Extra = map[string]interface{}{"eventExtraKey": "eventExtraValue"}
event.Fingerprint = []string{"eventFingerprintOne", "eventFingerprintTwo"}
event.Level = LevelInfo
Expand Down Expand Up @@ -541,7 +549,8 @@ func TestApplyToEventWithCorrectScopeAndEvent(t *testing.T) {

assertEqual(t, len(processedEvent.Breadcrumbs), 2, "should merge breadcrumbs")
assertEqual(t, len(processedEvent.Tags), 2, "should merge tags")
assertEqual(t, len(processedEvent.Contexts), 2, "should merge contexts")
assertEqual(t, len(processedEvent.Contexts), 3, "should merge contexts")
assertEqual(t, event.Contexts[sharedContextsKey], event.Contexts[sharedContextsKey], "should not override event context")
assertEqual(t, len(processedEvent.Extra), 2, "should merge extra")
assertEqual(t, processedEvent.Level, scope.level, "should use scope level if its set")
assertEqual(t, processedEvent.Transaction, scope.transaction, "should use scope transaction if its set")
Expand All @@ -558,7 +567,7 @@ func TestApplyToEventUsingEmptyScope(t *testing.T) {

assertEqual(t, len(processedEvent.Breadcrumbs), 1, "should use event breadcrumbs")
assertEqual(t, len(processedEvent.Tags), 1, "should use event tags")
assertEqual(t, len(processedEvent.Contexts), 1, "should use event contexts")
assertEqual(t, len(processedEvent.Contexts), 2, "should use event contexts")
assertEqual(t, len(processedEvent.Extra), 1, "should use event extra")
assertNotEqual(t, processedEvent.User, scope.user, "should use event user")
assertNotEqual(t, processedEvent.Fingerprint, scope.fingerprint, "should use event fingerprint")
Expand All @@ -575,7 +584,7 @@ func TestApplyToEventUsingEmptyEvent(t *testing.T) {

assertEqual(t, len(processedEvent.Breadcrumbs), 1, "should use scope breadcrumbs")
assertEqual(t, len(processedEvent.Tags), 1, "should use scope tags")
assertEqual(t, len(processedEvent.Contexts), 1, "should use scope contexts")
assertEqual(t, len(processedEvent.Contexts), 2, "should use scope contexts")
assertEqual(t, len(processedEvent.Extra), 1, "should use scope extra")
assertEqual(t, processedEvent.User, scope.user, "should use scope user")
assertEqual(t, processedEvent.Fingerprint, scope.fingerprint, "should use scope fingerprint")
Expand Down