Obsolete platform and always write csharp (#1610)

getsentry · May 3, 2022 · e15413f · e15413f
1 parent a443a18
commit e15413f
Show file tree

Hide file tree

Showing 24 changed files with 103 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@
 
 - Workaround `System.Text.Json` issue with Unity IL2CPP. ([#1583](https://github.com/getsentry/sentry-dotnet/pull/1583))
 - Demystify stack traces for exceptions that fire in a `BeforeSend` callback. ([#1587](https://github.com/getsentry/sentry-dotnet/pull/1587))
+- Obsolete `Platform` and always write `csharp` ([#1610](https://github.com/getsentry/sentry-dotnet/pull/1610))
 - Fix a minor issue in the caching transport related to recovery of files from previous session. ([#1617](https://github.com/getsentry/sentry-dotnet/pull/1617))
 
 ## 3.16.0

diff --git a/src/Sentry/Constants.cs b/src/Sentry/Constants.cs
@@ -1,3 +1,5 @@
+using System;
+
 namespace Sentry
 {
     /// <summary>

diff --git a/src/Sentry/IEventLike.cs b/src/Sentry/IEventLike.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -40,6 +41,7 @@ public interface IEventLike : IHasBreadcrumbs, IHasTags, IHasExtra
         /// <summary>
         /// The name of the platform.
         /// </summary>
+        [Obsolete("Platform is always csharp, and should not be set by consuming code. This property will be removed in version 4.")]
         public string? Platform { get; set; }
 
         /// <summary>

diff --git a/src/Sentry/Internal/Enricher.cs b/src/Sentry/Internal/Enricher.cs
@@ -55,9 +55,6 @@ public void Apply(IEventLike eventLike)
                 eventLike.Sdk.AddPackage("nuget:" + SdkVersion.Instance.Name, SdkVersion.Instance.Version);
             }
 
-            // Platform
-            eventLike.Platform ??= Sentry.Constants.Platform;
-
             // Release
             eventLike.Release ??= ReleaseLocator.Resolve(_options);
 

diff --git a/src/Sentry/Scope.cs b/src/Sentry/Scope.cs
@@ -127,7 +127,8 @@ public User User
         }
 
         /// <inheritdoc />
-        public string? Platform { get; set; }
+        [Obsolete("Platform is always csharp, and should not be set by consuming code. This property will be removed in version 4.")]
+        public string? Platform { get; set; } = Constants.Platform;
 
         /// <inheritdoc />
         public string? Release { get; set; }
@@ -360,7 +361,6 @@ public void Apply(IEventLike other)
             Request.CopyTo(other.Request);
             User.CopyTo(other.User);
 
-            other.Platform ??= Platform;
             other.Release ??= Release;
             other.Environment ??= Environment;
             other.TransactionName ??= TransactionName;

diff --git a/src/Sentry/SentryEvent.cs b/src/Sentry/SentryEvent.cs
@@ -63,7 +63,8 @@ public sealed class SentryEvent : IEventLike, IJsonSerializable
         public string? Logger { get; set; }
 
         /// <inheritdoc />
-        public string? Platform { get; set; }
+        [Obsolete("Platform is always csharp, and should not be set by consuming code. This property will be removed in version 4.")]
+        public string? Platform { get; set; } = Constants.Platform;
 
         /// <summary>
         /// Identifies the host SDK from which the event was recorded.
@@ -202,7 +203,6 @@ internal SentryEvent(
             Exception = exception;
             Timestamp = timestamp ?? DateTimeOffset.UtcNow;
             EventId = eventId != default ? eventId : SentryId.Create();
-            Platform = Constants.Platform;
         }
 
         /// <inheritdoc />
@@ -231,7 +231,7 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
             writer.WriteString("timestamp", Timestamp);
             writer.WriteSerializableIfNotNull("logentry", Message, logger);
             writer.WriteStringIfNotWhiteSpace("logger", Logger);
-            writer.WriteStringIfNotWhiteSpace("platform", Platform);
+            writer.WriteString("platform", Constants.Platform);
             writer.WriteStringIfNotWhiteSpace("server_name", ServerName);
             writer.WriteStringIfNotWhiteSpace("release", Release);
             writer.WriteSerializableIfNotNull("exception", SentryExceptionValues, logger);
@@ -271,7 +271,6 @@ public static SentryEvent FromJson(JsonElement json)
             var timestamp = json.GetPropertyOrNull("timestamp")?.GetDateTimeOffset();
             var message = json.GetPropertyOrNull("logentry")?.Pipe(SentryMessage.FromJson);
             var logger = json.GetPropertyOrNull("logger")?.GetString();
-            var platform = json.GetPropertyOrNull("platform")?.GetString();
             var serverName = json.GetPropertyOrNull("server_name")?.GetString();
             var release = json.GetPropertyOrNull("release")?.GetString();
             var exceptionValues = json.GetPropertyOrNull("exception")?.GetPropertyOrNull("values")?.EnumerateArray().Select(SentryException.FromJson).Pipe(v => new SentryValues<SentryException>(v));
@@ -296,7 +295,6 @@ public static SentryEvent FromJson(JsonElement json)
                 _modules = modules?.WhereNotNullValue().ToDictionary(),
                 Message = message,
                 Logger = logger,
-                Platform = platform,
                 ServerName = serverName,
                 Release = release,
                 SentryExceptionValues = exceptionValues,

diff --git a/src/Sentry/Transaction.cs b/src/Sentry/Transaction.cs
@@ -53,6 +53,7 @@ public SentryId TraceId
         public bool? IsParentSampled { get; set; }
 
         /// <inheritdoc />
+        [Obsolete("Platform is always csharp, and should not be set by consuming code. This property will be removed in version 4.")]
         public string? Platform { get; set; } = Constants.Platform;
 
         /// <inheritdoc />
@@ -210,7 +211,6 @@ public Transaction(ITransaction tracer)
             SpanId = tracer.SpanId;
             TraceId = tracer.TraceId;
             Operation = tracer.Operation;
-            Platform = tracer.Platform;
             Release = tracer.Release;
             StartTimestamp = tracer.StartTimestamp;
             EndTimestamp = tracer.EndTimestamp;
@@ -259,7 +259,7 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
             writer.WriteString("type", "transaction");
             writer.WriteSerializable("event_id", EventId, logger);
             writer.WriteStringIfNotWhiteSpace("level", Level?.ToString().ToLowerInvariant());
-            writer.WriteStringIfNotWhiteSpace("platform", Platform);
+            writer.WriteString("platform", Constants.Platform);
             writer.WriteStringIfNotWhiteSpace("release", Release);
             writer.WriteStringIfNotWhiteSpace("transaction", Name);
             writer.WriteString("start_timestamp", StartTimestamp);
@@ -288,7 +288,6 @@ public static Transaction FromJson(JsonElement json)
             var startTimestamp = json.GetProperty("start_timestamp").GetDateTimeOffset();
             var endTimestamp = json.GetPropertyOrNull("timestamp")?.GetDateTimeOffset();
             var level = json.GetPropertyOrNull("level")?.GetString()?.ParseEnum<SentryLevel>();
-            var platform = json.GetPropertyOrNull("platform")?.GetString();
             var release = json.GetPropertyOrNull("release")?.GetString();
             var request = json.GetPropertyOrNull("request")?.Pipe(Request.FromJson);
             var contexts = json.GetPropertyOrNull("contexts")?.Pipe(Contexts.FromJson);
@@ -310,7 +309,6 @@ public static Transaction FromJson(JsonElement json)
                 StartTimestamp = startTimestamp,
                 EndTimestamp = endTimestamp,
                 Level = level,
-                Platform = platform,
                 Release = release,
                 _request = request,
                 Contexts = contexts ?? new(),

diff --git a/src/Sentry/TransactionTracer.cs b/src/Sentry/TransactionTracer.cs
@@ -43,6 +43,7 @@ public SentryId TraceId
         public bool? IsParentSampled { get; set; }
 
         /// <inheritdoc />
+        [Obsolete("Platform is always csharp, and should not be set by consuming code. This property will be removed in version 4.")]
         public string? Platform { get; set; } = Constants.Platform;
 
         /// <inheritdoc />

diff --git a/.../Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.Core3_1.verified.txt b/.../Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.Core3_1.verified.txt
@@ -6,7 +6,6 @@
         Type: Exception,
         Message: my exception
       },
-      Platform: csharp,
       SentryExceptions: [
         {
           Type: System.Exception,
@@ -25,7 +24,6 @@
   {
     Source: {
       Name: my transaction,
-      Platform: csharp,
       Operation: my operation,
       Description: ,
       Status: UnknownError,

diff --git a/...entry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.DotNet5_0.verified.txt b/...entry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.DotNet5_0.verified.txt
@@ -6,7 +6,6 @@
         Type: Exception,
         Message: my exception
       },
-      Platform: csharp,
       SentryExceptions: [
         {
           Type: System.Exception,
@@ -25,7 +24,6 @@
   {
     Source: {
       Name: my transaction,
-      Platform: csharp,
       Operation: my operation,
       Description: ,
       Status: UnknownError,

diff --git a/...entry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.DotNet6_0.verified.txt b/...entry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.DotNet6_0.verified.txt
@@ -6,7 +6,6 @@
         Type: Exception,
         Message: my exception
       },
-      Platform: csharp,
       SentryExceptions: [
         {
           Type: System.Exception,
@@ -25,7 +24,6 @@
   {
     Source: {
       Name: my transaction,
-      Platform: csharp,
       Operation: my operation,
       Description: ,
       Status: UnknownError,

diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.Net4_8.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEf.Net4_8.verified.txt
@@ -6,7 +6,6 @@
         Type: Exception,
         Message: my exception
       },
-      Platform: csharp,
       SentryExceptions: [
         {
           Type: System.Exception,
@@ -25,7 +24,6 @@
   {
     Source: {
       Name: my transaction,
-      Platform: csharp,
       Operation: my operation,
       Description: ,
       Status: UnknownError,

diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSql.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSql.verified.txt
@@ -6,7 +6,6 @@
         Type: Exception,
         Message: my exception
       },
-      Platform: csharp,
       SentryExceptions: [
         {
           Type: System.Exception,
@@ -25,7 +24,6 @@
   {
     Source: {
       Name: my transaction,
-      Platform: csharp,
       Operation: my operation,
       Description: ,
       Status: UnknownError,

diff --git a/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.Core3_1.verified.txt b/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.Core3_1.verified.txt
@@ -153,6 +153,8 @@ namespace Sentry
         string? Environment { get; set; }
         System.Collections.Generic.IReadOnlyList<string> Fingerprint { get; set; }
         Sentry.SentryLevel? Level { get; set; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         string? Platform { get; set; }
         string? Release { get; set; }
         Sentry.Request Request { get; set; }
@@ -307,6 +309,8 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
         public System.Collections.Generic.IReadOnlyList<string> Fingerprint { get; set; }
         public Sentry.SentryLevel? Level { get; set; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -386,6 +390,8 @@ namespace Sentry
         public string? Logger { get; set; }
         public Sentry.SentryMessage? Message { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Modules { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -804,6 +810,8 @@ namespace Sentry
         public string Name { get; }
         public string Operation { get; }
         public Sentry.SpanId? ParentSpanId { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -857,6 +865,8 @@ namespace Sentry
         public string Name { get; set; }
         public string Operation { get; set; }
         public Sentry.SpanId? ParentSpanId { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }

diff --git a/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt b/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt
@@ -153,6 +153,8 @@ namespace Sentry
         string? Environment { get; set; }
         System.Collections.Generic.IReadOnlyList<string> Fingerprint { get; set; }
         Sentry.SentryLevel? Level { get; set; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         string? Platform { get; set; }
         string? Release { get; set; }
         Sentry.Request Request { get; set; }
@@ -307,6 +309,8 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
         public System.Collections.Generic.IReadOnlyList<string> Fingerprint { get; set; }
         public Sentry.SentryLevel? Level { get; set; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -386,6 +390,8 @@ namespace Sentry
         public string? Logger { get; set; }
         public Sentry.SentryMessage? Message { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Modules { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -804,6 +810,8 @@ namespace Sentry
         public string Name { get; }
         public string Operation { get; }
         public Sentry.SpanId? ParentSpanId { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -857,6 +865,8 @@ namespace Sentry
         public string Name { get; set; }
         public string Operation { get; set; }
         public Sentry.SpanId? ParentSpanId { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }

diff --git a/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt b/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt
@@ -153,6 +153,8 @@ namespace Sentry
         string? Environment { get; set; }
         System.Collections.Generic.IReadOnlyList<string> Fingerprint { get; set; }
         Sentry.SentryLevel? Level { get; set; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         string? Platform { get; set; }
         string? Release { get; set; }
         Sentry.Request Request { get; set; }
@@ -307,6 +309,8 @@ namespace Sentry
         public System.Collections.Generic.IReadOnlyDictionary<string, object?> Extra { get; }
         public System.Collections.Generic.IReadOnlyList<string> Fingerprint { get; set; }
         public Sentry.SentryLevel? Level { get; set; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -386,6 +390,8 @@ namespace Sentry
         public string? Logger { get; set; }
         public Sentry.SentryMessage? Message { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Modules { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -804,6 +810,8 @@ namespace Sentry
         public string Name { get; }
         public string Operation { get; }
         public Sentry.SpanId? ParentSpanId { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }
@@ -857,6 +865,8 @@ namespace Sentry
         public string Name { get; set; }
         public string Operation { get; set; }
         public Sentry.SpanId? ParentSpanId { get; }
+        [System.Obsolete("Platform is always csharp, and should not be set by consuming code. This property" +
+            " will be removed in version 4.")]
         public string? Platform { get; set; }
         public string? Release { get; set; }
         public Sentry.Request Request { get; set; }