Removed obsolete v6 APIs (#4619)

Author: jamescrosswell

CHANGELOG.md

@@ -7,6 +7,9 @@
 - `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))
+- Removed obsolete APIs ([#4619](https://github.com/getsentry/sentry-dotnet/pull/4619))
+  - Removed the unusual constructor from `Sentry.Maui.BreadcrumbEvent` that had been marked as obsolete. That constructor expected a `IEnumerable<(string Key, string Value)>[]` argument (i.e. an array of IEnumerable of tuples). If you were using this constructor, you should instead use the alternate constructor that expects just an IEnumerable of tuples: `IEnumerable<(string Key, string Value)>`.
+  - Removed `SentrySdk.CaptureUserFeedback` and all associated members. Use the newer `SentrySdk.CaptureFeedback` instead.
 - Backpressure handling is now enabled by default, meaning that the SDK will monitor system health and reduce the sampling rate of events and transactions when the system is under load. When the system is determined to be healthy again, the sampling rates are returned to their original levels. ([#4615](https://github.com/getsentry/sentry-dotnet/pull/4615))
 - ScopeExtensions.Populate is now internal ([#4611](https://github.com/getsentry/sentry-dotnet/pull/4611))
 

src/Sentry.Maui/BreadcrumbEvent.cs

@@ -52,20 +52,4 @@ public BreadcrumbEvent(
             e => new KeyValuePair<string, string>(e.key, e.value)))
     {
     }
-
-    /// <summary>
-    /// This constructor remains for backward compatibility.
-    /// </summary>
-    /// <param name="sender"></param>
-    /// <param name="eventName"></param>
-    /// <param name="extraData"></param>
-    [Obsolete("Use one of the other simpler constructors instead.")]
-    public BreadcrumbEvent(
-        object? sender,
-        string eventName,
-        IEnumerable<(string Key, string Value)>[] extraData) : this(sender, eventName, extraData.SelectMany(
-            x => x.Select(pair => new KeyValuePair<string, string>(pair.Key, pair.Value)))
-        )
-    {
-    }
 }

src/Sentry/Extensibility/DisabledHub.cs

@@ -242,14 +242,6 @@ public void Dispose()
     {
     }
 
-    /// <summary>
-    /// No-Op.
-    /// </summary>
-    [Obsolete("Use CaptureFeedback instead.")]
-    public void CaptureUserFeedback(UserFeedback userFeedback)
-    {
-    }
-
     /// <summary>
     /// No-Op.
     /// </summary>

src/Sentry/Extensibility/HubAdapter.cs

@@ -335,13 +335,4 @@ public SentryId CaptureCheckIn(
     [EditorBrowsable(EditorBrowsableState.Never)]
     public Task FlushAsync(TimeSpan timeout)
         => SentrySdk.FlushAsync(timeout);
-
-    /// <summary>
-    /// Forwards the call to <see cref="SentrySdk"/>
-    /// </summary>
-    [DebuggerStepThrough]
-    [EditorBrowsable(EditorBrowsableState.Never)]
-    [Obsolete("Use CaptureFeedback instead.")]
-    public void CaptureUserFeedback(UserFeedback sentryUserFeedback)
-        => SentrySdk.CaptureUserFeedback(sentryUserFeedback);
 }

src/Sentry/ISentryClient.cs

@@ -36,13 +36,6 @@ public interface ISentryClient
     /// <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);
 
-    /// <summary>
-    /// Captures a user feedback.
-    /// </summary>
-    /// <param name="userFeedback">The user feedback to send to Sentry.</param>
-    [Obsolete("Use CaptureFeedback instead.")]
-    public void CaptureUserFeedback(UserFeedback userFeedback);
-
     /// <summary>
     /// Captures a transaction.
     /// </summary>

src/Sentry/Internal/Hub.cs

@@ -662,34 +662,6 @@ internal void CaptureHeapDump(string dumpFile)
     }
 #endif
 
-    [Obsolete("Use CaptureFeedback instead.")]
-    public void CaptureUserFeedback(UserFeedback userFeedback)
-    {
-        if (!IsEnabled)
-        {
-            return;
-        }
-
-        try
-        {
-            if (!string.IsNullOrWhiteSpace(userFeedback.Email) && !EmailValidator.IsValidEmail(userFeedback.Email))
-            {
-                _options.LogWarning("Feedback email scrubbed due to invalid email format: '{0}'", userFeedback.Email);
-                userFeedback = new UserFeedback(
-                    userFeedback.EventId,
-                    userFeedback.Name,
-                    null, // Scrubbed email
-                    userFeedback.Comments);
-            }
-
-            CurrentClient.CaptureUserFeedback(userFeedback);
-        }
-        catch (Exception e)
-        {
-            _options.LogError(e, "Failure to capture user feedback: {0}", userFeedback.EventId);
-        }
-    }
-
     public void CaptureTransaction(SentryTransaction transaction) => CaptureTransaction(transaction, null, null);
 
     public void CaptureTransaction(SentryTransaction transaction, Scope? scope, SentryHint? hint)

src/Sentry/Protocol/Envelopes/Envelope.cs

@@ -330,23 +330,6 @@ public static Envelope FromFeedback(
         return new Envelope(eventId, header, items);
     }
 
-    /// <summary>
-    /// Creates an envelope that contains a single user feedback.
-    /// </summary>
-    [Obsolete("Use FromFeedback instead.")]
-    public static Envelope FromUserFeedback(UserFeedback sentryUserFeedback)
-    {
-        var eventId = sentryUserFeedback.EventId;
-        var header = CreateHeader(eventId);
-
-        var items = new[]
-        {
-            EnvelopeItem.FromUserFeedback(sentryUserFeedback)
-        };
-
-        return new Envelope(eventId, header, items);
-    }
-
     /// <summary>
     /// Creates an envelope that contains a single transaction.
     /// </summary>

src/Sentry/Protocol/Envelopes/EnvelopeItem.cs

@@ -231,20 +231,6 @@ public static EnvelopeItem FromFeedback(SentryEvent @event)
         return new EnvelopeItem(header, new JsonSerializable(@event));
     }
 
-    /// <summary>
-    /// Creates an <see cref="EnvelopeItem"/> from <paramref name="sentryUserFeedback"/>.
-    /// </summary>
-    [Obsolete("Use FromFeedback instead.")]
-    public static EnvelopeItem FromUserFeedback(UserFeedback sentryUserFeedback)
-    {
-        var header = new Dictionary<string, object?>(1, StringComparer.Ordinal)
-        {
-            [TypeKey] = TypeValueUserReport
-        };
-
-        return new EnvelopeItem(header, new JsonSerializable(sentryUserFeedback));
-    }
-
     /// <summary>
     /// Creates an <see cref="EnvelopeItem"/> from <paramref name="transaction"/>.
     /// </summary>
@@ -417,18 +403,6 @@ private static async Task<ISerializable> DeserializePayloadAsync(
             return new JsonSerializable(sentryEvent);
         }
 
-        // User report
-        if (string.Equals(payloadType, TypeValueUserReport, StringComparison.OrdinalIgnoreCase))
-        {
-#pragma warning disable CS0618 // Type or member is obsolete
-            var bufferLength = (int)(payloadLength ?? stream.Length);
-            var buffer = await stream.ReadByteChunkAsync(bufferLength, cancellationToken).ConfigureAwait(false);
-            var userFeedback = Json.Parse(buffer, UserFeedback.FromJson);
-#pragma warning restore CS0618 // Type or member is obsolete
-
-            return new JsonSerializable(userFeedback);
-        }
-
         // Transaction
         if (string.Equals(payloadType, TypeValueTransaction, StringComparison.OrdinalIgnoreCase))
         {

src/Sentry/SentryClient.cs

@@ -119,20 +119,6 @@ public void CaptureFeedback(SentryFeedback feedback, Scope? scope = null, Sentry
         CaptureEnvelope(envelope);
     }
 
-    /// <inheritdoc />
-    [Obsolete("Use CaptureFeedback instead.")]
-    public void CaptureUserFeedback(UserFeedback userFeedback)
-    {
-        if (userFeedback.EventId.Equals(SentryId.Empty))
-        {
-            // Ignore the user feedback if EventId is empty
-            _options.LogWarning("User feedback dropped due to empty id.");
-            return;
-        }
-
-        CaptureEnvelope(Envelope.FromUserFeedback(userFeedback));
-    }
-
     /// <inheritdoc />
     public void CaptureTransaction(SentryTransaction transaction) => CaptureTransaction(transaction, null, null);
 

src/Sentry/SentryClientExtensions.cs

@@ -49,26 +49,6 @@ public static void CaptureFeedback(this ISentryClient client, string message, st
         => client.CaptureFeedback(new SentryFeedback(message, contactEmail, name, replayId, url, associatedEventId),
             scope, hint);
 
-    /// <summary>
-    /// Captures a user feedback.
-    /// </summary>
-    /// <param name="client"></param>
-    /// <param name="eventId">The event Id.</param>
-    /// <param name="email">The user email.</param>
-    /// <param name="comments">The user comments.</param>
-    /// <param name="name">The optional username.</param>
-    [Obsolete("Use CaptureFeedback instead.")]
-    public static void CaptureUserFeedback(this ISentryClient client, SentryId eventId, string email, string comments,
-        string? name = null)
-    {
-        if (!client.IsEnabled)
-        {
-            return;
-        }
-
-        client.CaptureUserFeedback(new UserFeedback(eventId, name, email, comments));
-    }
-
     /// <summary>
     /// Flushes the queue of captured events until the timeout set in <see cref="SentryOptions.FlushTimeout"/>
     /// is reached.
@@ -125,7 +105,8 @@ public static Task FlushAsync(this ISentryClient client)
     /// </summary>
     /// <param name="clientOrHub"></param>
     /// <returns></returns>
-    [Obsolete("This method is meant for external usage only")]
+    [Obsolete("WARNING: This method is meant for internal usage only")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static SentryOptions? GetInternalSentryOptions(this ISentryClient clientOrHub) =>
         clientOrHub.GetSentryOptions();
 }