fix: Rename IJsonSerializable, Hint, and Attachment (#3116)

Author: bitsandfoxes

CHANGELOG.md

@@ -5,8 +5,11 @@
 ### Fixes 
 
 - To resolve conflicting types due to the SDK adding itself to the global usings: 
- - The interface `Sentry.ISession` has been renamed to `Sentry.ISentrySession`
+ - The interface `Sentry.ISession` has been renamed to `Sentry.ISentrySession` ([#3110](https://github.com/getsentry/sentry-dotnet/pull/3110))
+ - The interface `Sentry.IJsonSerializable` has been renamed to `Sentry.ISentryJsonSerializable` ([#3116](https://github.com/getsentry/sentry-dotnet/pull/3116))
  - The class `Sentry.Session` has been renamed to `Sentry.SentrySession` ([#3110](https://github.com/getsentry/sentry-dotnet/pull/3110))
+- The class `Sentry.Attachment` has been renamed to `Sentry.SentryAttachment` ([#3116](https://github.com/getsentry/sentry-dotnet/pull/3116))
+- The class `Sentry.Hint` has been renamed to `Sentry.SentryHint` ([#3116](https://github.com/getsentry/sentry-dotnet/pull/3116))
 
 ### Dependencies
 

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

@@ -110,7 +110,7 @@ await SentrySdk.ConfigureScopeAsync(async scope =>
 
             SentrySdk.AddBreadcrumb(
                 new Breadcrumb("A breadcrumb that will be replaced by the 'BeforeBreadcrumb callback because of the hint", null),
-                new Hint("don't trust this breadcrumb", "trust this instead")
+                new SentryHint("don't trust this breadcrumb", "trust this instead")
                 );
 
             // Data added to the root scope (no PushScope called up to this point)

src/Sentry.Maui/Internal/ScreenshotAttachment.cs

@@ -2,7 +2,7 @@
 
 namespace Sentry.Maui.Internal;
 
-internal class ScreenshotAttachment : Attachment
+internal class ScreenshotAttachment : SentryAttachment
 {
     public ScreenshotAttachment(SentryMauiOptions options)
         : this(

src/Sentry.Maui/Internal/SentryMauiScreenshotProcessor.cs

@@ -16,7 +16,7 @@ public SentryMauiScreenshotProcessor(SentryMauiOptions options)
         return @event;
     }
 
-    public SentryEvent? Process(SentryEvent @event, Hint hint)
+    public SentryEvent? Process(SentryEvent @event, SentryHint hint)
     {
         hint.Attachments.Add(new ScreenshotAttachment(_options));
         return @event;

src/Sentry/Breadcrumb.cs

@@ -8,7 +8,7 @@ namespace Sentry;
 /// Series of application events.
 /// </summary>
 [DebuggerDisplay("Message: {" + nameof(Message) + "}, Type: {" + nameof(Type) + "}")]
-public sealed class Breadcrumb : IJsonSerializable
+public sealed class Breadcrumb : ISentryJsonSerializable
 {
     private readonly IReadOnlyDictionary<string, string>? _data;
     private readonly string? _message;

src/Sentry/Contexts.cs

@@ -11,7 +11,7 @@ namespace Sentry;
 /// Represents Sentry's structured Context.
 /// </summary>
 /// <seealso href="https://develop.sentry.dev/sdk/event-payloads/contexts/" />
-public sealed class Contexts : IDictionary<string, object>, IJsonSerializable
+public sealed class Contexts : IDictionary<string, object>, ISentryJsonSerializable
 {
     private readonly ConcurrentDictionary<string, object> _innerDictionary = new(StringComparer.Ordinal);
 

src/Sentry/Extensibility/DisabledHub.cs

@@ -147,7 +147,7 @@ public bool CaptureEnvelope(Envelope envelope)
     /// <summary>
     /// No-Op.
     /// </summary>
-    public SentryId CaptureEvent(SentryEvent evt, Scope? scope = null, Hint? hint = null) => SentryId.Empty;
+    public SentryId CaptureEvent(SentryEvent evt, Scope? scope = null, SentryHint? hint = null) => SentryId.Empty;
 
     /// <summary>
     /// No-Op.
@@ -157,7 +157,7 @@ public bool CaptureEnvelope(Envelope envelope)
     /// <summary>
     /// No-Op.
     /// </summary>
-    public SentryId CaptureEvent(SentryEvent evt, Hint? hint, Action<Scope> configureScope) => SentryId.Empty;
+    public SentryId CaptureEvent(SentryEvent evt, SentryHint? hint, Action<Scope> configureScope) => SentryId.Empty;
 
     /// <summary>
     /// No-Op.
@@ -169,7 +169,7 @@ public void CaptureTransaction(SentryTransaction transaction)
     /// <summary>
     /// No-Op.
     /// </summary>
-    public void CaptureTransaction(SentryTransaction transaction, Scope? scope, Hint? hint)
+    public void CaptureTransaction(SentryTransaction transaction, Scope? scope, SentryHint? hint)
     {
     }
 

src/Sentry/Extensibility/HubAdapter.cs

@@ -219,7 +219,7 @@ public SentryId CaptureEvent(SentryEvent evt, Scope? scope)
     /// </summary>
     [DebuggerStepThrough]
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public SentryId CaptureEvent(SentryEvent evt, Scope? scope, Hint? hint = null)
+    public SentryId CaptureEvent(SentryEvent evt, Scope? scope, SentryHint? hint = null)
         => SentrySdk.CaptureEvent(evt, scope, hint);
 
     /// <summary>
@@ -233,7 +233,7 @@ public SentryId CaptureEvent(SentryEvent evt, Action<Scope> configureScope)
     /// <summary>
     /// Forwards the call to <see cref="SentrySdk"/>.
     /// </summary>
-    public SentryId CaptureEvent(SentryEvent evt, Hint? hint, Action<Scope> configureScope)
+    public SentryId CaptureEvent(SentryEvent evt, SentryHint? hint, Action<Scope> configureScope)
         => SentrySdk.CaptureEvent(evt, hint, configureScope);
 
     /// <summary>
@@ -256,7 +256,7 @@ public void CaptureTransaction(SentryTransaction transaction)
     /// </summary>
     [DebuggerStepThrough]
     [EditorBrowsable(EditorBrowsableState.Never)]
-    public void CaptureTransaction(SentryTransaction transaction, Scope? scope, Hint? hint)
+    public void CaptureTransaction(SentryTransaction transaction, Scope? scope, SentryHint? hint)
         => SentrySdk.CaptureTransaction(transaction, scope, hint);
 
     /// <summary>

src/Sentry/Extensibility/ISentryEventProcessor.cs

@@ -20,7 +20,7 @@ public interface ISentryEventProcessor
 
 internal static class ISentryEventProcessorExtensions
 {
-    internal static SentryEvent? DoProcessEvent(this ISentryEventProcessor processor, SentryEvent @event, Hint hint)
+    internal static SentryEvent? DoProcessEvent(this ISentryEventProcessor processor, SentryEvent @event, SentryHint hint)
     {
         return (processor is ISentryEventProcessorWithHint contextualProcessor)
             ? contextualProcessor.Process(@event, hint)

src/Sentry/Extensibility/ISentryEventProcessorWithHint.cs

@@ -9,13 +9,13 @@ public interface ISentryEventProcessorWithHint : ISentryEventProcessor
     /// Process the <see cref="SentryEvent"/>
     /// </summary>
     /// <param name="event">The event to process</param>
-    /// <param name="hint">A <see cref="Hint"/> with context that may be useful prior to sending the event</param>
+    /// <param name="hint">A <see cref="SentryHint"/> with context that may be useful prior to sending the event</param>
     /// <return>The processed event or <c>null</c> if the event was dropped.</return>
     /// <remarks>
     /// The event returned can be the same instance received or a new one.
     /// Returning null will stop the processing pipeline so that the event will neither be processed by
     /// additional event processors or sent to Sentry.
     /// </remarks>
-    SentryEvent? Process(SentryEvent @event, Hint hint);
+    SentryEvent? Process(SentryEvent @event, SentryHint hint);
 }