feat: User.Id can now be overriden (set to null) in Global mode by jamescrosswell · Pull Request #5039 · getsentry/sentry-dotnet

jamescrosswell · 2026-03-18T23:02:48Z

Resolves #4172

(MAUI) user.id is always set and can't remove it with SendDefaultPii or null #4172

github-actions · 2026-03-18T23:03:10Z

Semver Impact of This PR

⚪ None (no version bump detected)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

Breaking Changes 🛠

The _Metrics_ APIs are now stable: removed Experimental from SentrySdk, SentryOptions and IHub by Flash0ver in #5023

Features ✨

Report a new _Diagnostic_ (SENTRY1001) when a Metrics-API is invoked with an unsupported numeric type by Flash0ver in #4840

feat: User.Id can now be overriden (set to null) in Global mode by jamescrosswell in #5039

Fixes 🐛

fix: include Data set via ITransactionTracer in SentryTransaction by Flash0ver in #4148
fix: CaptureFeedback now applies event processors by jamescrosswell in #4942

Dependencies ⬆️

Deps

chore(deps): update Native SDK to v0.13.3 by github-actions in #5045
chore(deps): update Cocoa SDK to v9.7.0 by github-actions in #5015
chore(deps): update Java SDK to v8.35.0 by github-actions in #5017
chore(deps): replaced the heavy protobuf-javalite 3.25.8 dependency with a light-weight epitaph 0.1.0 alternative on Android (getsentry/sentry-java#5157) by github-actions in #5017
chore(deps): update CLI to v3.3.3 by github-actions in #5002
chore(deps): update Cocoa SDK to v9.6.0 by github-actions in #4958

Other

ref: Use .NET 6.0 ArgumentNullException throw helpers by copilot-swe-agent in #4985

_{🤖 This preview updates automatically when you update the PR.}

jamescrosswell · 2026-03-18T23:04:17Z

src/Sentry/Internal/Enricher.cs

        }
-        eventLike.User.Id ??= _options.InstallationId;
+        // Set by the GlobalRootScopeIntegration In global mode so that it can be overridden by the user.
+        // In non-global mode (e.g. ASP.NET Core) the enricher sets it here as a fallback.


@Flash0ver arguably we could remove this code entirely... not sure if we actually want to set the same user id for all ASP.NET requests (where no user was logged in).

@bruno-garcia any thoughts from your side?

jamescrosswell · 2026-03-19T01:27:21Z

...ptionsTests.Integrations_default_ones_are_properly_registered.DotNet10_0.DotNet.verified.txt

-    ]
-  },
-  {
-    Message: Starting BackpressureMonitor.


These were never really part of the test anyway (which is to ensure all the default integrations get registered)

jamescrosswell · 2026-03-19T01:30:11Z

src/Sentry/Integrations/GlobalRootScopeIntegration.cs

We could potentially set more stuff here. There are lots of scope properties that never change and which we currently set on the scope every time we capture an event. These are all candidates, I think:

sentry-dotnet/src/Sentry/Scope.cs

Lines 498 to 517 in f50b360

Contexts.CopyTo(other.Contexts);

Request.CopyTo(other.Request);

User.CopyTo(other.User);

other.Release ??= Release;

other.Distribution ??= Distribution;

other.Environment ??= Environment;

other.TransactionName ??= TransactionName;

other.Level ??= Level;

if (Sdk.Name is not null && Sdk.Version is not null)

{

other.Sdk.Name = Sdk.Name;

other.Sdk.Version = Sdk.Version;

}

foreach (var package in Sdk.InternalPackages)

{

other.Sdk.AddPackage(package);

}

More of a performance improvement but might result in a subtle behavioural change for some users (perhaps code that checks/expects things to not be set in certain circumstances and sets them conditionally on this basis ). To be safe, perhaps we delay a change like that until the next major release.

codecov · 2026-03-19T02:36:33Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.01%. Comparing base (a4a8ded) to head (8c2d66b).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5039      +/-   ##
==========================================
- Coverage   74.03%   74.01%   -0.02%     
==========================================
  Files         499      500       +1     
  Lines       18044    18057      +13     
  Branches     3510     3516       +6     
==========================================
+ Hits        13358    13365       +7     
- Misses       3830     3834       +4     
- Partials      856      858       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR adjusts how User.Id is populated from InstallationId when Global Mode is enabled, so that applications can explicitly clear/override the value (e.g., set it to null) without it being re-applied during event enrichment.

Changes:

Add a new GlobalRootScopeIntegration default integration that sets scope.User.Id from options.InstallationId at startup (Global Mode only).
Update Enricher to not apply the InstallationId fallback in Global Mode (so user overrides aren’t re-written).
Update/extend tests and Verify snapshots to account for the new default integration and changed behavior.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`src/Sentry/Integrations/GlobalRootScopeIntegration.cs`	New integration to set `User.Id` on the root scope in Global Mode.
`src/Sentry/Internal/Enricher.cs`	Stops applying `InstallationId` fallback when Global Mode is enabled.
`src/Sentry/SentryOptions.cs`	Registers the new integration as a default integration.
`test/Sentry.Tests/Integrations/GlobalRootScopeIntegrationTests.cs`	Adds tests covering the new integration and updated enricher behavior.
`test/Sentry.Tests/SentryClientTests.cs`	Adjusts tests around fallback `User.Id` behavior.
`test/Sentry.Tests/SentryOptionsTests.verify.cs` + `*.verified.txt`	Narrows snapshot scope to integration-registration logs and updates expected output.
`src/Sentry/PlatformAbstractions/FrameworkInfo.cs`	Adds an additional .NET Framework release key mapping for 4.8.1.

Copilot · 2026-03-23T06:50:51Z

src/Sentry/SentryOptions.cs

 #if NET8_0_OR_GREATER
                               | DefaultIntegrations.SystemDiagnosticsMetricsIntegration
 #endif
+                               | DefaultIntegrations.GlobalRootScopeIntegration
                               ;


GlobalRootScopeIntegration is now enabled by default, but unlike the other default integrations there’s no public Disable* method to let consumers turn it off. Consider adding a DisableGlobalRootScopeIntegration() (or similar) for parity and to give users a supported opt-out.

Arguably it's not an 'integration'... it's just some behaviour we want on all global root scopes (there's no need for an opt-out). We could move it out of the integrations list and bake the logic into the Hub constructor instead.

Otherwise I think it's OK to simply omit the disable integration method for this one. @Flash0ver thoughts?

test/Sentry.Tests/SentryClientTests.cs

Copilot · 2026-03-23T06:50:51Z

test/Sentry.Tests/Integrations/GlobalRootScopeIntegrationTests.cs

+        integration.Register(hub, options);
+
+        // Assert
+        hub.Received(1).ConfigureScope(Arg.Any<Action<Scope>>());


Test name says it “SetsInstallationIdOnRootScope”, but the assertion only verifies that ConfigureScope is called. Either update the assertion to validate the configured action sets User.Id from InstallationId (similar to the later test), or rename this test to reflect what it actually checks.

Suggested change

hub.Received(1).ConfigureScope(Arg.Any<Action<Scope>>());

hub.Received(1).ConfigureScope(Arg.Do<Action<Scope>>(configure =>

{

var scope = new Scope(options);

configure(scope);

Assert.Equal(options.InstallationId, scope.User?.Id);

}));

Copilot · 2026-03-23T06:50:51Z

src/Sentry/Internal/Enricher.cs

+        // Set by the GlobalRootScopeIntegration In global mode so that it can be overridden by the user.
+        // In non-global mode (e.g. ASP.NET Core) the enricher sets it here as a fallback.
+        if (!_options.IsGlobalModeEnabled)
+        {
+            eventLike.User.Id ??= _options.InstallationId;
+        }



With this change, the InstallationId fallback for User.Id is no longer applied when IsGlobalModeEnabled is true. That means scenarios that rely on Enricher without going through Hub initialization/integrations (e.g., apps constructing SentryClient directly) will no longer get the previous default User.Id behavior in global mode. If that behavior needs to remain, consider an alternative that still allows explicit clearing (e.g., apply the fallback when creating the initial Scope/root scope, or introduce an explicit option/flag indicating whether the fallback should be applied).

Suggested change

// Set by the GlobalRootScopeIntegration In global mode so that it can be overridden by the user.

// In non-global mode (e.g. ASP.NET Core) the enricher sets it here as a fallback.

if (!_options.IsGlobalModeEnabled)

{

eventLike.User.Id ??= _options.InstallationId;

}

// User.Id can be set by the GlobalRootScopeIntegration in global mode or by user code.

// The enricher still provides the InstallationId-based fallback here, but it will not override

// any value that was already set.

eventLike.User.Id ??= _options.InstallationId;

I don't think there's a scenario where someone uses a SentryClient independent of the Hub... so this isn't a real concern.

src/Sentry/Internal/Enricher.cs

src/Sentry/Integrations/GlobalRootScopeIntegration.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

feat: User.Id can now be overriden (set to null) in Global mode

28e9845

Resolves #4172 - #4172

jamescrosswell commented Mar 18, 2026

View reviewed changes

jamescrosswell requested a review from lucas-zimerman March 18, 2026 23:05

jamescrosswell and others added 4 commits March 19, 2026 12:14

additional core verify tests

1b15d0f

Windows verify files

7b2e38d

Fix verify files

7a7d0f6

Windows verify files

9907a6c

jamescrosswell commented Mar 19, 2026

View reviewed changes

Skip tests on mobile

2663ae0

jamescrosswell mentioned this pull request Mar 22, 2026

feat: add Attributes APIs #4882

Open

Fixed build on NetFX/Standard

abca943

jamescrosswell marked this pull request as ready for review March 23, 2026 06:42

jamescrosswell requested a review from Flash0ver as a code owner March 23, 2026 06:42

jamescrosswell requested a review from Copilot March 23, 2026 06:43

Copilot started reviewing on behalf of jamescrosswell March 23, 2026 06:43 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

Update src/Sentry/Internal/Enricher.cs

8c2d66b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

	Contexts.CopyTo(other.Contexts);
	Request.CopyTo(other.Request);
	User.CopyTo(other.User);

	other.Release ??= Release;
	other.Distribution ??= Distribution;
	other.Environment ??= Environment;
	other.TransactionName ??= TransactionName;
	other.Level ??= Level;

	if (Sdk.Name is not null && Sdk.Version is not null)
	{
	other.Sdk.Name = Sdk.Name;
	other.Sdk.Version = Sdk.Version;
	}

	foreach (var package in Sdk.InternalPackages)
	{
	other.Sdk.AddPackage(package);
	}

-        hub.Received(1).ConfigureScope(Arg.Any<Action<Scope>>());
+        hub.Received(1).ConfigureScope(Arg.Do<Action<Scope>>(configure =>
+        {
+            var scope = new Scope(options);
+            configure(scope);
+            Assert.Equal(options.InstallationId, scope.User?.Id);
+        }));

Uh oh!

Conversation

jamescrosswell commented Mar 18, 2026

Uh oh!

github-actions bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

Breaking Changes 🛠

Features ✨

Fixes 🐛

Dependencies ⬆️

Deps

Other

Uh oh!

jamescrosswell Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

jamescrosswell Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Mar 18, 2026 •

edited

Loading

jamescrosswell Mar 19, 2026 •

edited

Loading

codecov bot commented Mar 19, 2026 •

edited

Loading

jamescrosswell Mar 23, 2026 •

edited

Loading