feat!: pass SentryHint to IScopeObserver

[jpnurmi]

Note

BREAKING CHANGE

This would allow us to associate hints with breadcrumbs originating from the native layer so that we could sync certain native breadcrumbs to .NET without pushing them back.

For example, the following proposal currently disables the Android activity lifecycle breadcrumbs from the Java SDK. With the hints available, it could selectively sync Android ui.lifecycle breadcrumbs to .NET instead of reimplementing the logic with MAUI lifecycle callbacks:

• feat(maui): add missing lifecycle events on Android #4688

[Flash0ver]

question: nullability

Do we always have a Hint ... or are Hint optional?
I'm wondering whether this is OK to be non-nullable ... or it could/should be nullable.

[jpnurmi]

We always have a hint at the call site because the other overload creates an empty hint:

sentry-dotnet/src/Sentry/Scope.cs

Line 313 in 18ca31b

public void AddBreadcrumb(Breadcrumb breadcrumb) => AddBreadcrumb(breadcrumb, new SentryHint());

[codecov]

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (version6@d95347e). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
src/Sentry/Internal/ScopeObserver.cs	0.00%	1 Missing ⚠️
src/Sentry/Scope.cs	0.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             version6    #4694   +/-   ##
===========================================
  Coverage            ?   73.18%           
===========================================
  Files               ?      480           
  Lines               ?    17422           
  Branches            ?     3437           
===========================================
  Hits                ?    12750           
  Misses              ?     3821           
  Partials            ?      851           

☔ 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.

[jpnurmi]

I'm having second thoughts about this.

This was inspired by the use of hints to keep track of hybrid SDKs in the Java SDK, but I realized they are not passing hints to IScopeObserver.addBreadcrumb either.

I had a prototype that associated Android Activity lifecycle breadcrumbs with a "native" hint in BeforeBreadcrumbCallback, synced them to .NET, and then checked the hint in AndroidScopeObserver to avoid syncing duplicates back to Java. However, the same can be achieved one level up in the scope, and instead of passing hints to the observer, one could simply not call the observer for breadcrumbs with such a "native" hint.