Merged IHasBreadcrumbs into IEventLike (#2670)

Author: jamescrosswell

CHANGELOG.md

@@ -16,6 +16,7 @@ without native/platform specific bindings and SDKs. See [this ticket for more de
 
 API Changes:
 
+- IHasBreadcrumbs was removed. Use IEventLike instead. ([#2670](https://github.com/getsentry/sentry-dotnet/pull/2670))
 - ISpanContext was removed. Use ITraceContext instead. ([#2668](https://github.com/getsentry/sentry-dotnet/pull/2668))
 - Removed IHasTransactionNameSource. Use ITransactionContext instead. ([#2654](https://github.com/getsentry/sentry-dotnet/pull/2654))
 - Adding `Distribution` to `IEventLike` ([#2660](https://github.com/getsentry/sentry-dotnet/pull/2660))

src/Sentry/IEventLike.cs

@@ -3,8 +3,19 @@ namespace Sentry;
 /// <summary>
 /// Models members common between types that represent event-like data.
 /// </summary>
-public interface IEventLike : IHasBreadcrumbs, IHasTags, IHasExtra
+public interface IEventLike : IHasTags, IHasExtra
 {
+    /// <summary>
+    /// A trail of events which happened prior to an issue.
+    /// </summary>
+    /// <seealso href="https://docs.sentry.io/platforms/dotnet/enriching-events/breadcrumbs/"/>
+    IReadOnlyCollection<Breadcrumb> Breadcrumbs { get; }
+
+    /// <summary>
+    /// Adds a breadcrumb.
+    /// </summary>
+    void AddBreadcrumb(Breadcrumb breadcrumb);
+
     /// <summary>
     /// The release distribution of the application.
     /// </summary>
@@ -96,6 +107,102 @@ public interface IEventLike : IHasBreadcrumbs, IHasTags, IHasExtra
 [EditorBrowsable(EditorBrowsableState.Never)]
 public static class EventLikeExtensions
 {
+#if !NETFRAMEWORK
+    /// <summary>
+    /// Adds a breadcrumb to the object.
+    /// </summary>
+    /// <param name="eventLike">The object.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="category">The category.</param>
+    /// <param name="type">The type.</param>
+    /// <param name="dataPair">The data key-value pair.</param>
+    /// <param name="level">The level.</param>
+    public static void AddBreadcrumb(
+        this IEventLike eventLike,
+        string message,
+        string? category,
+        string? type,
+        (string, string)? dataPair = null,
+        BreadcrumbLevel level = default)
+    {
+        Dictionary<string, string>? data = null;
+
+        if (dataPair != null)
+        {
+            data = new Dictionary<string, string>
+            {
+                {dataPair.Value.Item1, dataPair.Value.Item2}
+            };
+        }
+
+        eventLike.AddBreadcrumb(
+            null,
+            message,
+            category,
+            type,
+            data,
+            level);
+    }
+#endif
+
+    /// <summary>
+    /// Adds a breadcrumb to the object.
+    /// </summary>
+    /// <param name="eventLike">The object.</param>
+    /// <param name="message">The message.</param>
+    /// <param name="category">The category.</param>
+    /// <param name="type">The type.</param>
+    /// <param name="data">The data.</param>
+    /// <param name="level">The level.</param>
+    public static void AddBreadcrumb(
+        this IEventLike eventLike,
+        string message,
+        string? category = null,
+        string? type = null,
+        IReadOnlyDictionary<string, string>? data = null,
+        BreadcrumbLevel level = default)
+    {
+        eventLike.AddBreadcrumb(
+            null,
+            message,
+            category,
+            type,
+            data,
+            level);
+    }
+
+    /// <summary>
+    /// Adds a breadcrumb to the object.
+    /// </summary>
+    /// <remarks>
+    /// This overload is used for testing.
+    /// </remarks>
+    /// <param name="eventLike">The object.</param>
+    /// <param name="timestamp">The timestamp</param>
+    /// <param name="message">The message.</param>
+    /// <param name="category">The category.</param>
+    /// <param name="type">The type.</param>
+    /// <param name="data">The data</param>
+    /// <param name="level">The level.</param>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public static void AddBreadcrumb(
+        this IEventLike eventLike,
+        DateTimeOffset? timestamp,
+        string message,
+        string? category = null,
+        string? type = null,
+        IReadOnlyDictionary<string, string>? data = null,
+        BreadcrumbLevel level = default)
+    {
+        eventLike.AddBreadcrumb(new Breadcrumb(
+            timestamp,
+            message,
+            type,
+            data,
+            category,
+            level));
+    }
+
     /// <summary>
     /// Whether a <see cref="User"/> has been set to the object with any of its fields non null.
     /// </summary>