Marked SentryUser.Segment as deprecated (#3437)

jamescrosswell · web-flow · commit 2ef9f802c720 · 2024-06-20T13:25:32.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Obsoletion
+
+- Marked SentryUser.Segment as deprecated ([#3437](https://github.com/getsentry/sentry-dotnet/pull/3437))
+
 ### Features
 
 - Added a new package `Sentry.AspNetCore.Blazor.WebAssembly`. This packages provides you with an extension to `WebAssemblyHostBuilder` to allow SDK configuration via the builder pattern. This package gives us an entry point and the ability to extend the SDKs support and out-of-the-box offering. You can follow the progress and leave feedback either ([here](https://github.com/getsentry/sentry-dotnet/issues/2329)) for extending the support for Blazor Server or ([here](https://github.com/getsentry/sentry-dotnet/issues/2021)) for Blazor WebAssembly support ([#3386](https://github.com/getsentry/sentry-dotnet/pull/3386))
diff --git a/src/Sentry.NLog/SentryTarget.cs b/src/Sentry.NLog/SentryTarget.cs
@@ -453,7 +453,9 @@ private void InnerWrite(LogEventInfo logEvent)
             Username = User.Username?.Render(logEvent),
             Email = User.Email?.Render(logEvent),
             IpAddress = User.IpAddress?.Render(logEvent),
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = User.Segment?.Render(logEvent)
+#pragma warning restore CS0618 // Type or member is obsolete
         };
 
         if (User.Other?.Count > 0)
diff --git a/src/Sentry/DynamicSamplingContext.cs b/src/Sentry/DynamicSamplingContext.cs
@@ -127,7 +127,9 @@ public static DynamicSamplingContext CreateFromTransaction(TransactionTracer tra
         var traceId = transaction.TraceId;
         var sampled = transaction.IsSampled;
         var sampleRate = transaction.SampleRate!.Value;
+#pragma warning disable CS0618 // Type or member is obsolete
         var userSegment = transaction.User.Segment;
+#pragma warning restore CS0618 // Type or member is obsolete
         var transactionName = transaction.NameSource.IsHighQuality() ? transaction.Name : null;
 
         // These two may not have been set yet on the transaction, but we can get them directly.
diff --git a/src/Sentry/Platforms/Android/Extensions/UserExtensions.cs b/src/Sentry/Platforms/Android/Extensions/UserExtensions.cs
@@ -12,7 +12,9 @@ public static SentryUser ToUser(this JavaSdk.Protocol.User user) =>
             Id = user.Id,
             IpAddress = user.IpAddress,
             Username = user.Username,
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = user.Segment,
+#pragma warning restore CS0618 // Type or member is obsolete
             Other = user.Data ?? EmptyDictionary
         };
 
@@ -23,7 +25,9 @@ public static JavaSdk.Protocol.User ToJavaUser(this SentryUser user) =>
             Id = user.Id,
             IpAddress = user.IpAddress,
             Username = user.Username,
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = user.Segment,
+#pragma warning restore CS0618 // Type or member is obsolete
             Data = user.Other.Count == 0 ? null : user.Other
         };
 }
diff --git a/src/Sentry/Platforms/Cocoa/Extensions/UserExtensions.cs b/src/Sentry/Platforms/Cocoa/Extensions/UserExtensions.cs
@@ -11,7 +11,9 @@ public static SentryUser ToUser(this CocoaSdk.SentryUser user, IDiagnosticLogger
             Id = user.UserId,
             IpAddress = user.IpAddress,
             Username = user.Username,
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = user.Segment,
+#pragma warning restore CS0618 // Type or member is obsolete
             Other = user.Data.ToStringDictionary(logger)
         };
 
@@ -23,7 +25,9 @@ public static CocoaSdk.SentryUser ToCocoaUser(this SentryUser user)
             UserId = user.Id,
             IpAddress = user.IpAddress,
             Username = user.Username,
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = user.Segment,
+#pragma warning restore CS0618 // Type or member is obsolete
             Data = user.Other.ToNullableNSDictionary()
         };
 
diff --git a/src/Sentry/SentryUser.cs b/src/Sentry/SentryUser.cs
@@ -85,6 +85,7 @@ public string? IpAddress
     /// <summary>
     /// The segment the user belongs to.
     /// </summary>
+    [Obsolete("This property is deprecated and will be removed in a future version.")]
     public string? Segment
     {
         get => _segment;
@@ -136,7 +137,9 @@ internal void CopyTo(SentryUser? user)
         user.Username ??= Username;
         user.Email ??= Email;
         user.IpAddress ??= IpAddress;
+#pragma warning disable CS0618 // Type or member is obsolete
         user.Segment ??= Segment;
+#pragma warning restore CS0618 // Type or member is obsolete
 
         user._other ??= _other?.ToDictionary(
             entry => entry.Key,
@@ -148,7 +151,9 @@ Id is not null ||
         Username is not null ||
         Email is not null ||
         IpAddress is not null ||
+#pragma warning disable CS0618 // Type or member is obsolete
         Segment is not null ||
+#pragma warning restore CS0618 // Type or member is obsolete
         _other?.Count > 0;
 
     /// <inheritdoc />
@@ -160,7 +165,9 @@ public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? _)
         writer.WriteStringIfNotWhiteSpace("username", Username);
         writer.WriteStringIfNotWhiteSpace("email", Email);
         writer.WriteStringIfNotWhiteSpace("ip_address", IpAddress);
+#pragma warning disable CS0618 // Type or member is obsolete
         writer.WriteStringIfNotWhiteSpace("segment", Segment);
+#pragma warning restore CS0618 // Type or member is obsolete
         writer.WriteStringDictionaryIfNotEmpty("other", _other!);
 
         writer.WriteEndObject();
@@ -184,7 +191,9 @@ public static SentryUser FromJson(JsonElement json)
             Username = username,
             Email = email,
             IpAddress = ip,
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = segment,
+#pragma warning restore CS0618 // Type or member is obsolete
             _other = other?.WhereNotNullValue().ToDict()
         };
     }
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet6_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet6_0.verified.txt
@@ -87,7 +87,6 @@
               Username: ,
               Email: ,
               IpAddress: ,
-              Segment: ,
               Other: {
                 mood: joyous
               }
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet7_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet7_0.verified.txt
@@ -87,7 +87,6 @@
               Username: ,
               Email: ,
               IpAddress: ,
-              Segment: ,
               Other: {
                 mood: joyous
               }
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt
@@ -87,7 +87,6 @@
               Username: ,
               Email: ,
               IpAddress: ,
-              Segment: ,
               Other: {
                 mood: joyous
               }
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.Mono4_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.Mono4_0.verified.txt
@@ -87,7 +87,6 @@
               Username: ,
               Email: ,
               IpAddress: ,
-              Segment: ,
               Other: {
                 mood: joyous
               }
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.Net4_8.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.Net4_8.verified.txt
@@ -87,7 +87,6 @@
               Username: ,
               Email: ,
               IpAddress: ,
-              Segment: ,
               Other: {
                 mood: joyous
               }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt
@@ -982,6 +982,7 @@ namespace Sentry
         public string? Id { get; set; }
         public string? IpAddress { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Other { get; set; }
+        [System.Obsolete("This property is deprecated and will be removed in a future version.")]
         public string? Segment { get; set; }
         public string? Username { get; set; }
         public Sentry.SentryUser Clone() { }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt
@@ -982,6 +982,7 @@ namespace Sentry
         public string? Id { get; set; }
         public string? IpAddress { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Other { get; set; }
+        [System.Obsolete("This property is deprecated and will be removed in a future version.")]
         public string? Segment { get; set; }
         public string? Username { get; set; }
         public Sentry.SentryUser Clone() { }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt
@@ -984,6 +984,7 @@ namespace Sentry
         public string? Id { get; set; }
         public string? IpAddress { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Other { get; set; }
+        [System.Obsolete("This property is deprecated and will be removed in a future version.")]
         public string? Segment { get; set; }
         public string? Username { get; set; }
         public Sentry.SentryUser Clone() { }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt
@@ -979,6 +979,7 @@ namespace Sentry
         public string? Id { get; set; }
         public string? IpAddress { get; set; }
         public System.Collections.Generic.IDictionary<string, string> Other { get; set; }
+        [System.Obsolete("This property is deprecated and will be removed in a future version.")]
         public string? Segment { get; set; }
         public string? Username { get; set; }
         public Sentry.SentryUser Clone() { }
diff --git a/test/Sentry.Tests/DynamicSamplingContextTests.cs b/test/Sentry.Tests/DynamicSamplingContextTests.cs
@@ -255,7 +255,9 @@ public void CreateFromTransaction(bool? isSampled)
             SampleRate = 0.5,
             User =
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 Segment = "Group A"
+#pragma warning restore CS0618 // Type or member is obsolete
             },
         };
 
diff --git a/test/Sentry.Tests/Protocol/ScopeTests.cs b/test/Sentry.Tests/Protocol/ScopeTests.cs
@@ -70,7 +70,9 @@ public void HasUser_UserWithIpAddress_ReturnsTrue()
     public void HasUser_UserWithSegment_ReturnsTrue()
     {
         var sut = _fixture.GetSut();
+#pragma warning disable CS0618 // Type or member is obsolete
         sut.User.Segment = "test";
+#pragma warning restore CS0618 // Type or member is obsolete
         Assert.True(sut.HasUser());
     }
 
diff --git a/test/Sentry.Tests/Protocol/UserTests.cs b/test/Sentry.Tests/Protocol/UserTests.cs
@@ -18,7 +18,9 @@ public void SerializeObject_AllPropertiesSetToNonDefault_SerializesValidObject()
             Username = "user-name",
             Email = "test@sentry.io",
             IpAddress = "::1",
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = "A1",
+#pragma warning restore CS0618 // Type or member is obsolete
             Other = new Dictionary<string, string> { { "testCustomValueKey", "testCustomValue" } }
         };
 
@@ -48,7 +50,9 @@ public void Clone_CopyValues()
             Email = "emal@sentry.io",
             IpAddress = "::1",
             Username = "user",
+#pragma warning disable CS0618 // Type or member is obsolete
             Segment = "segment",
+#pragma warning restore CS0618 // Type or member is obsolete
             Other = new Dictionary<string, string>
             {
                 {"testCustomValueKey", "testCustomValue"}
@@ -61,7 +65,9 @@ public void Clone_CopyValues()
         Assert.Equal(sut.Username, clone.Username);
         Assert.Equal(sut.Email, clone.Email);
         Assert.Equal(sut.IpAddress, clone.IpAddress);
+#pragma warning disable CS0618 // Type or member is obsolete
         Assert.Equal(sut.Segment, clone.Segment);
+#pragma warning restore CS0618 // Type or member is obsolete
         Assert.Equal(sut.Other, clone.Other);
     }
 
@@ -80,7 +86,9 @@ public static IEnumerable<object[]> TestCases()
         yield return new object[] { (new SentryUser { Username = "some username" }, """{"username":"some username"}""") };
         yield return new object[] { (new SentryUser { Email = "some email" }, """{"email":"some email"}""") };
         yield return new object[] { (new SentryUser { IpAddress = "some ipAddress" }, """{"ip_address":"some ipAddress"}""") };
+#pragma warning disable CS0618 // Type or member is obsolete
         yield return new object[] { (new SentryUser { Segment = "some segment" }, """{"segment":"some segment"}""") };
+#pragma warning restore CS0618 // Type or member is obsolete
 
         var other = new Dictionary<string, string> { { "testCustomValueKey", "testCustomValue" } };
         yield return new object[] { (new SentryUser { Other = other }, """{"other":{"testCustomValueKey":"testCustomValue"}}""") };

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,6 @@`
`87`	`87`	`Username: ,`
`88`	`88`	`Email: ,`
`89`	`89`	`IpAddress: ,`
`90`		`- Segment: ,`
`91`	`90`	`Other: {`
`92`	`91`	`mood: joyous`
`93`	`92`	`}`