Merge branch 'version6' into ios-replay

Author: jamescrosswell

CHANGELOG.md

@@ -4,6 +4,20 @@
 
 ### BREAKING CHANGES
 
+- 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))
+
+### Features
+
+- The SDK now makes use of the new SessionEndStatus `Unhandled` when capturing an unhandled but non-terminal exception, i.e. through the UnobservedTaskExceptionIntegration ([#4633](https://github.com/getsentry/sentry-dotnet/pull/4633), [#4653](https://github.com/getsentry/sentry-dotnet/pull/4653))
+- The SDK now provides a `IsSessionActive` to allow checking the session state ([#4662](https://github.com/getsentry/sentry-dotnet/pull/4662))
+- The SDK now makes use of the new SessionEndStatus `Unhandled` when capturing an unhandled but non-terminal exception, i.e. through the UnobservedTaskExceptionIntegration ([#4633](https://github.com/getsentry/sentry-dotnet/pull/4633))
+
+## 6.0.0-preview.2
+
+### BREAKING CHANGES
+
 - `BreadcrumbLevel.Critical` has been renamed to `BreadcrumbLevel.Fatal` for consistency with the other Sentry SDKs ([#4605](https://github.com/getsentry/sentry-dotnet/pull/4605))
 - SentryOptions.IsEnvironmentUser now defaults to false on MAUI. The means the User.Name will no longer be set, by default, to the name of the device ([#4606](https://github.com/getsentry/sentry-dotnet/pull/4606))
 - Remove unnecessary files from SentryCocoaFramework before packing ([#4602](https://github.com/getsentry/sentry-dotnet/pull/4602))

Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <VersionPrefix>6.0.0-preview.1</VersionPrefix>
+    <VersionPrefix>6.0.0-preview.2</VersionPrefix>
     <VersionSuffix>prerelease</VersionSuffix>
     <LangVersion>13</LangVersion>
     <AccelerateBuildsInVisualStudio>true</AccelerateBuildsInVisualStudio>

samples/Sentry.Samples.Console.Basic/Program.cs

@@ -63,7 +63,7 @@
 
 // Always try to finish the transaction successfully.
 // Unhandled exceptions will fail the transaction automatically.
-// Optionally, you can try/catch the exception, and call transaction.Finish(exception) on failure.
+// Optionally, you can try/catch the exception and call transaction.Finish(exception) on failure.
 transaction.Finish();
 
 async Task FirstFunction()
@@ -79,7 +79,6 @@ async Task FirstFunction()
 async Task SecondFunction()
 {
     var span = transaction.StartChild("function", nameof(SecondFunction));
-
     try
     {
         // Simulate doing some work
@@ -97,26 +96,25 @@ async Task SecondFunction()
         SentrySdk.Logger.LogError(static log => log.SetAttribute("method", nameof(SecondFunction)),
             "Error with message: {0}", exception.Message);
     }
-
-    span.Finish();
+    finally
+    {
+        span.Finish();
+    }
 }
 
 async Task ThirdFunction()
 {
-    var span = transaction.StartChild("function", nameof(ThirdFunction));
-    try
-    {
-        // Simulate doing some work
-        await Task.Delay(100);
+    // The `using` here ensures the span gets finished when we leave this method... This is unnecessary here,
+    // since the method always throws and the span will be finished automatically when the exception is captured,
+    // but this gives you another way to ensure spans are finished.
+    using var span = transaction.StartChild("function", nameof(ThirdFunction));
 
-        SentrySdk.Logger.LogFatal(static log => log.SetAttribute("suppress", true),
-            "Crash imminent!");
+    // Simulate doing some work
+    await Task.Delay(100);
 
-        // This is an example of an unhandled exception.  It will be captured automatically.
-        throw new InvalidOperationException("Something happened that crashed the app!");
-    }
-    finally
-    {
-        span.Finish();
-    }
+    SentrySdk.Logger.LogFatal(static log => log.SetAttribute("suppress", true),
+        "Crash imminent!");
+
+    // This is an example of an unhandled exception.  It will be captured automatically.
+    throw new InvalidOperationException("Something happened that crashed the app!");
 }

src/Sentry/CaptureFeedbackErrorReason.cs

@@ -0,0 +1,43 @@
+namespace Sentry;
+
+/// <summary>
+/// Result code for <see cref="ISentryClient.CaptureFeedback"/> requests
+/// </summary>
+public enum CaptureFeedbackResult
+{
+    /// <summary>
+    /// Feedback captured successfully.
+    /// </summary>
+    Success,
+    /// <summary>
+    /// <para>
+    /// An unknown error occurred (enable debug mode and check the logs for details).
+    /// </para>
+    /// <para>
+    /// Possible causes:
+    /// <list type="bullet">
+    ///   <item>
+    ///     <description>An exception from the configureScope callback</description>
+    ///   </item>
+    ///   <item>
+    ///     <description>An error when sending the envelope</description>
+    ///   </item>
+    ///   <item>
+    ///     <description>An attempt to send feedback while the application is shutting down</description>
+    ///   </item>
+    ///   <item>
+    ///     <description>Something more mysterious...</description>
+    ///   </item>
+    /// </list>
+    /// </para>
+    /// </summary>
+    UnknownError,
+    /// <summary>
+    /// Capture failed because Sentry is disabled (very likely an empty DSN was provided when initialising the SDK).
+    /// </summary>
+    DisabledHub,
+    /// <summary>
+    /// Capture failed because the <see cref="SentryFeedback.Message"/> message is empty.
+    /// </summary>
+    EmptyMessage,
+}

src/Sentry/Extensibility/DisabledHub.cs

@@ -186,15 +186,21 @@ public bool CaptureEnvelope(Envelope envelope)
     /// <summary>
     /// No-Op.
     /// </summary>
-    public void CaptureFeedback(SentryFeedback feedback, Action<Scope> configureScope, SentryHint? hint = null)
+    public SentryId CaptureFeedback(SentryFeedback feedback, out CaptureFeedbackResult result,
+        Action<Scope> configureScope, SentryHint? hint = null)
     {
+        result = CaptureFeedbackResult.DisabledHub;
+        return SentryId.Empty;
     }
 
     /// <summary>
     /// No-Op.
     /// </summary>
-    public void CaptureFeedback(SentryFeedback feedback, Scope? scope = null, SentryHint? hint = null)
+    public SentryId CaptureFeedback(SentryFeedback feedback, out CaptureFeedbackResult result,
+        Scope? scope = null, SentryHint? hint = null)
     {
+        result = CaptureFeedbackResult.DisabledHub;
+        return SentryId.Empty;
     }
 
     /// <summary>

src/Sentry/Extensibility/HubAdapter.cs

@@ -272,16 +272,18 @@ public SentryId CaptureEvent(SentryEvent evt, Scope? scope, SentryHint? hint = n
     /// </summary>
     [DebuggerStepThrough]
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public void CaptureFeedback(SentryFeedback feedback, Action<Scope> configureScope, SentryHint? hint = null)
-        => SentrySdk.CaptureFeedback(feedback, configureScope, hint);
+    public SentryId CaptureFeedback(SentryFeedback feedback, out CaptureFeedbackResult result,
+        Action<Scope> configureScope, SentryHint? hint = null)
+        => SentrySdk.CaptureFeedback(feedback, out result, configureScope, hint);
 
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>
     [DebuggerStepThrough]
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public void CaptureFeedback(SentryFeedback feedback, Scope? scope = null, SentryHint? hint = null)
-        => SentrySdk.CaptureFeedback(feedback, scope, hint);
+    public SentryId CaptureFeedback(SentryFeedback feedback, out CaptureFeedbackResult result, Scope? scope = null,
+        SentryHint? hint = null)
+        => SentrySdk.CaptureFeedback(feedback, out result, scope, hint);
 
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.

src/Sentry/HubExtensions.cs

@@ -206,6 +206,22 @@ internal static SentryId CaptureExceptionInternal(this IHub hub, Exception ex) =
     public static SentryId CaptureException(this IHub hub, Exception ex, Action<Scope> configureScope) =>
         hub.CaptureEvent(new SentryEvent(ex), configureScope);
 
+    /// <summary>
+    /// Captures feedback from the user.
+    /// </summary>
+    /// <param name="hub">The Sentry hub.</param>
+    /// <param name="feedback">The feedback to send to Sentry.</param>
+    /// <param name="configureScope">Callback method to configure the scope.</param>
+    /// <param name="hint">
+    /// An optional hint providing high-level context for the source of the event, including attachments
+    /// </param>
+    /// <returns>
+    /// A <see cref="SentryId"/> that will contain the Id of the new event (if successful) or
+    /// <see cref="SentryId.Empty"/> otherwise
+    /// </returns>
+    public static SentryId CaptureFeedback(this IHub hub, SentryFeedback feedback, Action<Scope> configureScope, SentryHint? hint = null)
+        => hub.CaptureFeedback(feedback, out _, configureScope, hint);
+
     /// <summary>
     /// Captures a message with a configurable scope callback.
     /// </summary>

src/Sentry/IHub.cs

@@ -143,7 +143,15 @@ public TransactionContext ContinueTrace(
     /// Captures feedback from the user.
     /// </summary>
     /// <param name="feedback">The feedback to send to Sentry.</param>
+    /// <param name="result">A <see cref="CaptureFeedbackResult"/> indicating either success or a specific error</param>
     /// <param name="configureScope">Callback method to configure the scope.</param>
-    /// <param name="hint">An optional hint providing high level context for the source of the event, including attachments</param>
-    public void CaptureFeedback(SentryFeedback feedback, Action<Scope> configureScope, SentryHint? hint = null);
+    /// <param name="hint">
+    /// An optional hint providing high-level context for the source of the event, including attachments
+    /// </param>
+    /// <returns>
+    /// A <see cref="SentryId"/> that will contain the Id of the new event (if successful) or
+    /// <see cref="SentryId.Empty"/> otherwise
+    /// </returns>
+    public SentryId CaptureFeedback(SentryFeedback feedback, out CaptureFeedbackResult result, Action<Scope> configureScope,
+        SentryHint? hint = null);
 }

src/Sentry/ISentryClient.cs

@@ -32,9 +32,17 @@ public interface ISentryClient
     /// Captures feedback from the user.
     /// </summary>
     /// <param name="feedback">The feedback to send to Sentry.</param>
-    /// <param name="scope">An optional scope to be applied to the event.</param>
-    /// <param name="hint">An optional hint providing high level context for the source of the event</param>
-    public void CaptureFeedback(SentryFeedback feedback, Scope? scope = null, SentryHint? hint = null);
+    /// <param name="result">A <see cref="CaptureFeedbackResult"/> indicating either success or a specific error</param>
+    /// <param name="scope">An optional scope to be applied to the feedback event.</param>
+    /// <param name="hint">
+    /// An optional hint providing high-level context for the source of the event, including attachments
+    /// </param>
+    /// <returns>
+    /// A <see cref="SentryId"/> that will contain the Id of the new event (if successful) or
+    /// <see cref="SentryId.Empty"/> otherwise
+    /// </returns>
+    public SentryId CaptureFeedback(SentryFeedback feedback, out CaptureFeedbackResult result, Scope? scope = null,
+        SentryHint? hint = null);
 
     /// <summary>
     /// Captures a transaction.

src/Sentry/ISpan.cs

@@ -5,7 +5,7 @@ namespace Sentry;
 /// <summary>
 /// SpanTracer interface
 /// </summary>
-public interface ISpan : ISpanData
+public interface ISpan : ISpanData, IDisposable
 {
     /// <summary>
     /// Span description.