feat!: pass SentryHint to IScopeObserver

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Spans and Transactions now implement `IDisposable` so that they can be used with `using` statements/declarations that will automatically finish the span with a status of OK when it passes out of scope, if it has not already been finished, to be consistent with `Activity` classes when using OpenTelemetry ([#4627](https://github.com/getsentry/sentry-dotnet/pull/4627))
 - SpanTracer and TransactionTracer are still public but these are now `sealed` (see also [#4627](https://github.com/getsentry/sentry-dotnet/pull/4627))
 - CaptureFeedback now returns a `SentryId` and a `CaptureFeedbackResult` out parameter that indicate whether feedback was captured successfully and what the reason for failure was otherwise ([#4613](https://github.com/getsentry/sentry-dotnet/pull/4613))
+- `IScopeObserver.AddBreadcrumb` now takes a `SentryHint` as a second parameter ([#4694](https://github.com/getsentry/sentry-dotnet/pull/4694))
 
 ### Features
 

src/Sentry/IScopeObserver.cs

@@ -8,7 +8,7 @@ public interface IScopeObserver
     /// <summary>
     /// Adds a breadcrumb.
     /// </summary>
-    public void AddBreadcrumb(Breadcrumb breadcrumb);
+    public void AddBreadcrumb(Breadcrumb breadcrumb, SentryHint hint);
 
     /// <summary>
     /// Sets an extra.

src/Sentry/Internal/ScopeObserver.cs

@@ -17,15 +17,15 @@ public ScopeObserver(
         _options = options;
     }
 
-    public void AddBreadcrumb(Breadcrumb breadcrumb)
+    public void AddBreadcrumb(Breadcrumb breadcrumb, SentryHint hint)
     {
         _options.DiagnosticLogger?.Log(SentryLevel.Debug,
             "{0} Scope Sync - Adding breadcrumb m:\"{1}\" l:\"{2}\"", null, _name,
             breadcrumb.Message, breadcrumb.Level);
-        AddBreadcrumbImpl(breadcrumb);
+        AddBreadcrumbImpl(breadcrumb, hint);
     }
 
-    public abstract void AddBreadcrumbImpl(Breadcrumb breadcrumb);
+    public abstract void AddBreadcrumbImpl(Breadcrumb breadcrumb, SentryHint hint);
 
     public void SetExtra(string key, object? value)
     {

src/Sentry/Platforms/Android/AndroidScopeObserver.cs

@@ -18,16 +18,17 @@ public AndroidScopeObserver(SentryOptions options)
         _innerObserver = observer is AndroidScopeObserver ? null : observer;
     }
 
-    public void AddBreadcrumb(Breadcrumb breadcrumb)
+    public void AddBreadcrumb(Breadcrumb breadcrumb, SentryHint hint)
     {
         try
         {
             var b = breadcrumb.ToJavaBreadcrumb();
-            JavaSdk.Sentry.AddBreadcrumb(b);
+            var h = hint.ToJavaHint();
+            JavaSdk.Sentry.AddBreadcrumb(b, h);
         }
         finally
         {
-            _innerObserver?.AddBreadcrumb(breadcrumb);
+            _innerObserver?.AddBreadcrumb(breadcrumb, hint);
         }
     }
 

src/Sentry/Platforms/Cocoa/CocoaScopeObserver.cs

@@ -18,7 +18,7 @@ public CocoaScopeObserver(SentryOptions options)
         _innerObserver = observer is CocoaScopeObserver ? null : observer;
     }
 
-    public void AddBreadcrumb(Breadcrumb breadcrumb)
+    public void AddBreadcrumb(Breadcrumb breadcrumb, SentryHint hint)
     {
         try
         {
@@ -27,7 +27,7 @@ public void AddBreadcrumb(Breadcrumb breadcrumb)
         }
         finally
         {
-            _innerObserver?.AddBreadcrumb(breadcrumb);
+            _innerObserver?.AddBreadcrumb(breadcrumb, hint);
         }
     }
 

src/Sentry/Platforms/Native/NativeScopeObserver.cs

@@ -10,7 +10,7 @@ internal class NativeScopeObserver : ScopeObserver
 {
     public NativeScopeObserver(SentryOptions options) : base("Native", options) { }
 
-    public override void AddBreadcrumbImpl(Breadcrumb breadcrumb)
+    public override void AddBreadcrumbImpl(Breadcrumb breadcrumb, SentryHint hint)
     {
         // see https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/
         var crumb = C.sentry_value_new_breadcrumb(breadcrumb.Type, breadcrumb.Message);

src/Sentry/Scope.cs

@@ -348,7 +348,7 @@ public void AddBreadcrumb(Breadcrumb breadcrumb, SentryHint hint)
         _breadcrumbs.Enqueue(breadcrumb);
         if (Options.EnableScopeSync)
         {
-            Options.ScopeObserver?.AddBreadcrumb(breadcrumb);
+            Options.ScopeObserver?.AddBreadcrumb(breadcrumb, hint);
         }
     }
 

test/Sentry.Tests/ApiApprovalTests.Run.DotNet10_0.verified.txt

@@ -215,7 +215,7 @@ namespace Sentry
     }
     public interface IScopeObserver
     {
-        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb);
+        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb, Sentry.SentryHint hint);
         void SetExtra(string key, object? value);
         void SetTag(string key, string value);
         void SetTrace(Sentry.SentryId traceId, Sentry.SpanId parentSpanId);

test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -215,7 +215,7 @@ namespace Sentry
     }
     public interface IScopeObserver
     {
-        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb);
+        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb, Sentry.SentryHint hint);
         void SetExtra(string key, object? value);
         void SetTag(string key, string value);
         void SetTrace(Sentry.SentryId traceId, Sentry.SpanId parentSpanId);

test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt

@@ -215,7 +215,7 @@ namespace Sentry
     }
     public interface IScopeObserver
     {
-        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb);
+        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb, Sentry.SentryHint hint);
         void SetExtra(string key, object? value);
         void SetTag(string key, string value);
         void SetTrace(Sentry.SentryId traceId, Sentry.SpanId parentSpanId);

test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt

@@ -203,7 +203,7 @@ namespace Sentry
     }
     public interface IScopeObserver
     {
-        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb);
+        void AddBreadcrumb(Sentry.Breadcrumb breadcrumb, Sentry.SentryHint hint);
         void SetExtra(string key, object? value);
         void SetTag(string key, string value);
         void SetTrace(Sentry.SentryId traceId, Sentry.SpanId parentSpanId);

test/Sentry.Tests/ScopeTests.cs

@@ -686,14 +686,15 @@ public void AddBreadcrumb_ObserverExist_ObserverAddsBreadcrumbIfEnabled(bool obs
             EnableScopeSync = observerEnable
         });
         var breadcrumb = new Breadcrumb(message: "1234");
+        var hint = new SentryHint(key: "k", value: "v");
         var expectedCount = observerEnable ? 2 : 0;
 
         // Act
-        scope.AddBreadcrumb(breadcrumb);
-        scope.AddBreadcrumb(breadcrumb);
+        scope.AddBreadcrumb(breadcrumb, hint);
+        scope.AddBreadcrumb(breadcrumb, hint);
 
         // Assert
-        observer.Received(expectedCount).AddBreadcrumb(Arg.Is(breadcrumb));
+        observer.Received(expectedCount).AddBreadcrumb(Arg.Is(breadcrumb), Arg.Is(hint));
     }
 
     [Fact]