fix: Renamed Contexts, Request, and Package (#3121)

Author: bitsandfoxes

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+### Fixes
+
+- To resolve conflicting types due to the SDK adding itself to the global usings: 
+ - The class `Sentry.Context` has been renamed to `Sentry.SentryContext` ([#3121](https://github.com/getsentry/sentry-dotnet/pull/3121))
+ - The class `Sentry.Package` has been renamed to `Sentry.SentryPackage` ([#3121](https://github.com/getsentry/sentry-dotnet/pull/3121))
+ - The class `Sentry.Request` has been renamed to `Sentry.SentryRequest` ([#3121](https://github.com/getsentry/sentry-dotnet/pull/3121))
+
 ### Dependencies
 
 - Bump CLI from v2.27.0 to v2.28.0 ([#3119](https://github.com/getsentry/sentry-dotnet/pull/3119))
@@ -16,8 +23,8 @@
  - 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))
+ - 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
 

src/Sentry/IEventLike.cs

@@ -32,15 +32,15 @@ public interface IEventLike : IHasTags, IHasExtra
     /// <value>
     /// The HTTP.
     /// </value>
-    Request Request { get; set; }
+    SentryRequest Request { get; set; }
 
     /// <summary>
     /// Gets the structured Sentry context.
     /// </summary>
     /// <value>
     /// The contexts.
     /// </value>
-    Contexts Contexts { get; set; }
+    SentryContexts Contexts { get; set; }
 
     /// <summary>
     /// Gets the user information.

src/Sentry/Internal/MainSentryEventProcessor.cs

@@ -158,7 +158,7 @@ public SentryEvent Process(SentryEvent @event)
         return @event;
     }
 
-    private static void AddMemoryInfo(Contexts contexts)
+    private static void AddMemoryInfo(SentryContexts contexts)
     {
 #if NETCOREAPP3_0_OR_GREATER
         var memory = GC.GetGCMemoryInfo();
@@ -192,7 +192,7 @@ private static void AddMemoryInfo(Contexts contexts)
 #endif
     }
 
-    private static void AddThreadPoolInfo(Contexts contexts)
+    private static void AddThreadPoolInfo(SentryContexts contexts)
     {
         ThreadPool.GetMinThreads(out var minWorkerThreads, out var minCompletionPortThreads);
         ThreadPool.GetMaxThreads(out var maxWorkerThreads, out var maxCompletionPortThreads);

src/Sentry/Internal/NoOpTransaction.cs

@@ -39,13 +39,13 @@ public SentryLevel? Level
         set { }
     }
 
-    public Request Request
+    public SentryRequest Request
     {
         get => new();
         set { }
     }
 
-    public Contexts Contexts
+    public SentryContexts Contexts
     {
         get => new();
         set { }

src/Sentry/Platforms/Cocoa/CocoaEventProcessor.cs

@@ -16,7 +16,7 @@ public SentryEvent Process(SentryEvent @event)
         if (json != null)
         {
             var jsonDoc = JsonDocument.Parse(json);
-            var contexts = Contexts.FromJson(jsonDoc.RootElement);
+            var contexts = SentryContexts.FromJson(jsonDoc.RootElement);
             contexts.CopyTo(@event.Contexts);
         }
 

src/Sentry/Protocol/ProfileInfo.cs

@@ -15,10 +15,10 @@ internal sealed class ProfileInfo : ISentryJsonSerializable
 
     public DebugMeta DebugMeta { get; set; } = new() { Images = new() };
 
-    private readonly Contexts _contexts = new();
+    private readonly SentryContexts _contexts = new();
 
     /// <inheritdoc />
-    public Contexts Contexts
+    public SentryContexts Contexts
     {
         get => _contexts;
         set => _contexts.ReplaceWith(value);

src/Sentry/Scope.cs

@@ -85,19 +85,19 @@ internal SentryId LastEventId
     /// <inheritdoc />
     public SentryLevel? Level { get; set; }
 
-    private Request? _request;
+    private SentryRequest? _request;
 
     /// <inheritdoc />
-    public Request Request
+    public SentryRequest Request
     {
-        get => _request ??= new Request();
+        get => _request ??= new SentryRequest();
         set => _request = value;
     }
 
-    private readonly Contexts _contexts = new();
+    private readonly SentryContexts _contexts = new();
 
     /// <inheritdoc />
-    public Contexts Contexts
+    public SentryContexts Contexts
     {
         get => _contexts;
         set => _contexts.ReplaceWith(value);

src/Sentry/SdkVersion.cs

@@ -19,14 +19,14 @@ public sealed class SdkVersion : ISentryJsonSerializable
 
     internal static SdkVersion Instance => InstanceLazy.Value;
 
-    internal ConcurrentBag<Package> InternalPackages { get; set; } = new();
+    internal ConcurrentBag<SentryPackage> InternalPackages { get; set; } = new();
     internal ConcurrentBag<string> Integrations { get; set; } = new();
 
     /// <summary>
     /// SDK packages.
     /// </summary>
     /// <remarks>This property is not required.</remarks>
-    public IEnumerable<Package> Packages => InternalPackages;
+    public IEnumerable<SentryPackage> Packages => InternalPackages;
 
     /// <summary>
     /// SDK name.
@@ -56,9 +56,9 @@ public string? Version
     /// <param name="name">The package name.</param>
     /// <param name="version">The package version.</param>
     public void AddPackage(string name, string version)
-        => AddPackage(new Package(name, version));
+        => AddPackage(new SentryPackage(name, version));
 
-    internal void AddPackage(Package package)
+    internal void AddPackage(SentryPackage package)
         => InternalPackages.Add(package);
 
     /// <summary>
@@ -88,8 +88,8 @@ public static SdkVersion FromJson(JsonElement json)
     {
         // Packages
         var packages =
-            json.GetPropertyOrNull("packages")?.EnumerateArray().Select(Package.FromJson).ToArray()
-            ?? Array.Empty<Package>();
+            json.GetPropertyOrNull("packages")?.EnumerateArray().Select(SentryPackage.FromJson).ToArray()
+            ?? Array.Empty<SentryPackage>();
 
         // Integrations
         var integrations =
@@ -104,7 +104,7 @@ public static SdkVersion FromJson(JsonElement json)
 
         return new SdkVersion
         {
-            InternalPackages = new ConcurrentBag<Package>(packages),
+            InternalPackages = new ConcurrentBag<SentryPackage>(packages),
             Integrations = new ConcurrentBag<string>(integrations),
             Name = name,
             Version = version

src/Sentry/Contexts.cs renamed to src/Sentry/SentryContexts.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>, ISentryJsonSerializable
+public sealed class SentryContexts : IDictionary<string, object>, ISentryJsonSerializable
 {
     private readonly ConcurrentDictionary<string, object> _innerDictionary = new(StringComparer.Ordinal);
 
@@ -59,16 +59,16 @@ public sealed class Contexts : IDictionary<string, object>, ISentryJsonSerializa
     public Trace Trace => _innerDictionary.GetOrCreate<Trace>(Trace.Type);
 
     /// <summary>
-    /// Initializes an instance of <see cref="Contexts"/>.
+    /// Initializes an instance of <see cref="SentryContexts"/>.
     /// </summary>
-    public Contexts() { }
+    public SentryContexts() { }
 
     /// <summary>
     /// Creates a deep clone of this context.
     /// </summary>
-    internal Contexts Clone()
+    internal SentryContexts Clone()
     {
-        var context = new Contexts();
+        var context = new SentryContexts();
 
         CopyTo(context);
 
@@ -78,7 +78,7 @@ internal Contexts Clone()
     /// <summary>
     /// Copies the items of the context while cloning the known types.
     /// </summary>
-    internal void CopyTo(Contexts to)
+    internal void CopyTo(SentryContexts to)
     {
         foreach (var kv in this)
         {
@@ -126,9 +126,9 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
     /// <summary>
     /// Parses from JSON.
     /// </summary>
-    public static Contexts FromJson(JsonElement json)
+    public static SentryContexts FromJson(JsonElement json)
     {
-        var result = new Contexts();
+        var result = new SentryContexts();
 
         foreach (var (name, value) in json.EnumerateObject())
         {
@@ -181,7 +181,7 @@ public static Contexts FromJson(JsonElement json)
         return result;
     }
 
-    internal void ReplaceWith(Contexts? contexts)
+    internal void ReplaceWith(SentryContexts? contexts)
     {
         Clear();
 
@@ -196,7 +196,7 @@ internal void ReplaceWith(Contexts? contexts)
         }
     }
 
-    internal Contexts? NullIfEmpty() => _innerDictionary.IsEmpty ? null : this;
+    internal SentryContexts? NullIfEmpty() => _innerDictionary.IsEmpty ? null : this;
 
     /// <inheritdoc/>
     public IEnumerator<KeyValuePair<string, object>> GetEnumerator() => _innerDictionary.GetEnumerator();

src/Sentry/SentryEvent.cs

@@ -120,19 +120,19 @@ public List<DebugImage>? DebugImages
     /// <inheritdoc />
     public string? TransactionName { get; set; }
 
-    private Request? _request;
+    private SentryRequest? _request;
 
     /// <inheritdoc />
-    public Request Request
+    public SentryRequest Request
     {
-        get => _request ??= new Request();
+        get => _request ??= new SentryRequest();
         set => _request = value;
     }
 
-    private readonly Contexts _contexts = new();
+    private readonly SentryContexts _contexts = new();
 
     /// <inheritdoc />
-    public Contexts Contexts
+    public SentryContexts Contexts
     {
         get => _contexts;
         set => _contexts.ReplaceWith(value);
@@ -301,8 +301,8 @@ internal static SentryEvent FromJson(JsonElement json, Exception? exception)
         var threadValues = json.GetPropertyOrNull("threads")?.GetPropertyOrNull("values")?.EnumerateArray().Select(SentryThread.FromJson).ToList().Pipe(v => new SentryValues<SentryThread>(v));
         var level = json.GetPropertyOrNull("level")?.GetString()?.ParseEnum<SentryLevel>();
         var transaction = json.GetPropertyOrNull("transaction")?.GetString();
-        var request = json.GetPropertyOrNull("request")?.Pipe(Request.FromJson);
-        var contexts = json.GetPropertyOrNull("contexts")?.Pipe(Contexts.FromJson);
+        var request = json.GetPropertyOrNull("request")?.Pipe(SentryRequest.FromJson);
+        var contexts = json.GetPropertyOrNull("contexts")?.Pipe(SentryContexts.FromJson);
         var user = json.GetPropertyOrNull("user")?.Pipe(SentryUser.FromJson);
         var environment = json.GetPropertyOrNull("environment")?.GetString();
         var sdk = json.GetPropertyOrNull("sdk")?.Pipe(SdkVersion.FromJson) ?? new SdkVersion();