feat: add scope context API by giortzisg · Pull Request #1371 · getsentry/sentry-go

giortzisg · 2026-07-21T12:36:23Z

Description

Issues

resolves: Refactor scope propagation to rely on context.Context #1367
resolves: GO-154

Changelog Entry Instructions

To add a custom changelog entry, uncomment the section above. Supports:

Single entry: just write text
Multiple entries: use bullet points
Nested bullets: indent 4+ spaces

For more details: custom changelog entries

Reminders

Add GH Issue ID & Linear ID
PR title should use conventional commit style (feat:, fix:, ref:, meta:)
For external contributors: CONTRIBUTING.md, Sentry SDK development docs, Discord community

linear-code · 2026-07-23T07:46:04Z

GO-154

sl0thentr0py · 2026-08-03T10:12:34Z

 }

-// WithScope is a shorthand for CurrentHub().WithScope.
-func WithScope(f func(scope *Scope)) {


why are only these methods removed here and not the others? can you add a short summary of the breaking changes in the PR description?

+1, please also adjust the PR title to feat! so that Craft identifies this as a breaking change

Didn't remove the rest because of test usage. Functionality of the scope propagation on ctx isn't finalized on this PR so can't really swap, but it's a fair argument. I'll re-add this and remove everything with all Hub functionality on the final PR to only have public API breaking changes under a single part of the stack.

szokeasaurusrex

lgtm! Left a few minor comments and a question

szokeasaurusrex · 2026-08-03T11:15:02Z

+		boundClient:     scope.boundClient,
 		eventProcessors: scope.eventProcessors[:len(scope.eventProcessors):len(scope.eventProcessors)],
+		scopeData:       data.clone(),


[question] does the reordering of scopeData after eventProcessors change the code's behavior? Or is it simply a formatting change?

I am just trying to understand why this change is being made here.

Doesn't affect code behavior. This diff is just adding scope.boundClient.

szokeasaurusrex · 2026-08-03T12:09:32Z

+// Clearing or cloning the scope only affects the underlying data. To set a new
+// client or event processor, SetClient or AddEventProcessor should be used.


l: I find this paragraph to be slightly unclear. What is meant by the "underlying data" in this context?

It's everything under scopeData, which is essentially all the data set by the user. Not really sure how to call this.

szokeasaurusrex · 2026-08-03T12:12:59Z

 }

-// WithScope is a shorthand for CurrentHub().WithScope.
-func WithScope(f func(scope *Scope)) {


+1, please also adjust the PR title to feat! so that Craft identifies this as a breaking change

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

Want reviews to match your repository better? Bugbot Learning can learn team-specific rules from PR activity. A team admin can enable Learning in the Cursor dashboard.

^{Reviewed by Cursor Bugbot for commit a32c046. Configure here.}

sentry · 2026-08-13T12:53:41Z

+func (scope *Scope) SetClient(client *Client) {
+	scope.mu.Lock()
+	defer scope.mu.Unlock()
+
+	scope.clientOverride = normalizeClient(client)
+}


Bug: The SetClient documentation says passing nil clears the override, but the implementation sets a non-nil NoopClient, violating the API contract.
_{Severity: LOW}

Suggested Fix

Either update the documentation to reflect the actual behavior, change the implementation to store nil when nil is passed, or create an explicit ClearClient() method instead of using SetClient(nil).

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: scope.go#L105-L110 Potential issue: The documentation for the `SetClient` function at `scope.go:103-104` states that passing `nil` will clear the client override. However, the implementation at line 109 calls `normalizeClient(client)`, which returns a non-nil `NoopClient` when the input is `nil`. This results in `scope.clientOverride` never being set to `nil`. While the runtime behavior correctly falls back to the global scope due to subsequent `IsEnabled()` checks, this discrepancy violates the documented API contract and the principle of least surprise for developers expecting the override to be `nil`.

giortzisg marked this pull request as ready for review July 23, 2026 08:26

cursor Bot reviewed Jul 23, 2026

View reviewed changes

Comment thread scope_context.go Outdated

Comment thread sentry.go

giortzisg force-pushed the scopes/scope-storage branch from 0bb8a70 to 8ce983c Compare July 23, 2026 08:45

giortzisg force-pushed the scopes/scope-storage branch from 8ce983c to 3ce9717 Compare July 30, 2026 20:45

cursor Bot reviewed Jul 30, 2026

View reviewed changes

Comment thread scope_context.go

giortzisg mentioned this pull request Aug 3, 2026

feat: add context capture API #1378

Open

giortzisg requested review from Litarnus, sl0thentr0py and szokeasaurusrex August 3, 2026 10:02

sl0thentr0py approved these changes Aug 3, 2026

View reviewed changes

szokeasaurusrex approved these changes Aug 3, 2026

View reviewed changes

giortzisg changed the title ~~feat: add scope context API~~ feat!: add scope context API Aug 4, 2026

giortzisg force-pushed the scopes/scope-storage branch from 3ce9717 to 24cbd32 Compare August 4, 2026 15:02

sentry Bot reviewed Aug 4, 2026

View reviewed changes

Comment thread scope_context.go

cursor Bot reviewed Aug 4, 2026

View reviewed changes

Comment thread scope_context.go

giortzisg changed the title ~~feat!: add scope context API~~ feat: add scope context API Aug 10, 2026

giortzisg force-pushed the scopes/scope-storage branch from 1ba25e1 to 5ebf737 Compare August 10, 2026 11:28

sentry Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread scope_context.go Outdated

giortzisg force-pushed the scopes/scope-storage branch from 5ebf737 to 14a0bf8 Compare August 10, 2026 11:36

cursor Bot reviewed Aug 10, 2026

View reviewed changes

Comment thread sentry.go

giortzisg force-pushed the scopes/scope-storage branch from 14a0bf8 to 01f70b4 Compare August 10, 2026 13:23

giortzisg force-pushed the scopes/scope-storage branch from 01f70b4 to a32c046 Compare August 13, 2026 11:40

cursor Bot reviewed Aug 13, 2026

View reviewed changes

Comment thread scope_context.go

giortzisg force-pushed the scopes/scope-storage branch from a32c046 to 7c286e0 Compare August 13, 2026 11:48

feat: add scope context API

e747b11

giortzisg force-pushed the scopes/scope-storage branch from 7c286e0 to e747b11 Compare August 13, 2026 12:51

sentry Bot reviewed Aug 13, 2026

View reviewed changes

		// Clearing or cloning the scope only affects the underlying data. To set a new
		// client or event processor, SetClient or AddEventProcessor should be used.

Uh oh!

Conversation

giortzisg commented Jul 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues

Uh oh!

linear-code Bot commented Jul 23, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sentry Bot Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

giortzisg commented Jul 21, 2026 •

edited

Loading