Make user segment a top level property

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Make user segment a top level property ([#2257](https://github.com/getsentry/sentry-java/pull/2257))
+
 ## 6.5.0-beta.1
 
 ### Features

sentry/api/sentry.api

@@ -2974,13 +2974,15 @@ public final class io/sentry/protocol/User : io/sentry/JsonSerializable, io/sent
 	public fun getId ()Ljava/lang/String;
 	public fun getIpAddress ()Ljava/lang/String;
 	public fun getOthers ()Ljava/util/Map;
+	public fun getSegment ()Ljava/lang/String;
 	public fun getUnknown ()Ljava/util/Map;
 	public fun getUsername ()Ljava/lang/String;
 	public fun serialize (Lio/sentry/JsonObjectWriter;Lio/sentry/ILogger;)V
 	public fun setEmail (Ljava/lang/String;)V
 	public fun setId (Ljava/lang/String;)V
 	public fun setIpAddress (Ljava/lang/String;)V
 	public fun setOthers (Ljava/util/Map;)V
+	public fun setSegment (Ljava/lang/String;)V
 	public fun setUnknown (Ljava/util/Map;)V
 	public fun setUsername (Ljava/lang/String;)V
 }
@@ -2996,6 +2998,7 @@ public final class io/sentry/protocol/User$JsonKeys {
 	public static final field ID Ljava/lang/String;
 	public static final field IP_ADDRESS Ljava/lang/String;
 	public static final field OTHER Ljava/lang/String;
+	public static final field SEGMENT Ljava/lang/String;
 	public static final field USERNAME Ljava/lang/String;
 	public fun <init> ()V
 }

sentry/src/main/java/io/sentry/Baggage.java

@@ -292,6 +292,10 @@ public void setValuesFromTransaction(
   }
 
   private static @Nullable String getSegment(final @NotNull User user) {
+    if (user.getSegment() != null) {
+      return user.getSegment();
+    }
+
     final Map<String, String> others = user.getOthers();
     if (others != null) {
       return others.get("segment");

sentry/src/main/java/io/sentry/protocol/User.java

@@ -31,6 +31,8 @@ public final class User implements JsonUnknown, JsonSerializable {
   /** Username of the user. */
   private @Nullable String username;
 
+  private @Nullable String segment;
+
   /** Remote IP address of the user. */
   private @Nullable String ipAddress;
 
@@ -50,6 +52,7 @@ public User(final @NotNull User user) {
     this.username = user.username;
     this.id = user.id;
     this.ipAddress = user.ipAddress;
+    this.segment = user.segment;
     this.other = CollectionUtils.newConcurrentHashMap(user.other);
     this.unknown = CollectionUtils.newConcurrentHashMap(user.unknown);
   }
@@ -108,6 +111,24 @@ public void setUsername(final @Nullable String username) {
     this.username = username;
   }
 
+  /**
+   * Gets the segment of the user.
+   *
+   * @return the user segment.
+   */
+  public @Nullable String getSegment() {
+    return segment;
+  }
+
+  /**
+   * Sets the segment of the user.
+   *
+   * @param segment the segment.
+   */
+  public void setSegment(final @Nullable String segment) {
+    this.segment = segment;
+  }
+
   /**
    * Gets the IP address of the user.
    *
@@ -161,6 +182,7 @@ public static final class JsonKeys {
     public static final String EMAIL = "email";
     public static final String ID = "id";
     public static final String USERNAME = "username";
+    public static final String SEGMENT = "segment";
     public static final String IP_ADDRESS = "ip_address";
     public static final String OTHER = "other";
   }
@@ -178,6 +200,9 @@ public void serialize(@NotNull JsonObjectWriter writer, @NotNull ILogger logger)
     if (username != null) {
       writer.name(JsonKeys.USERNAME).value(username);
     }
+    if (segment != null) {
+      writer.name(JsonKeys.SEGMENT).value(segment);
+    }
     if (ipAddress != null) {
       writer.name(JsonKeys.IP_ADDRESS).value(ipAddress);
     }
@@ -214,6 +239,9 @@ public static final class Deserializer implements JsonDeserializer<User> {
           case JsonKeys.USERNAME:
             user.username = reader.nextStringOrNull();
             break;
+          case JsonKeys.SEGMENT:
+            user.segment = reader.nextStringOrNull();
+            break;
           case JsonKeys.IP_ADDRESS:
             user.ipAddress = reader.nextStringOrNull();
             break;

sentry/src/test/java/io/sentry/protocol/UserTest.kt

@@ -31,6 +31,7 @@ class UserTest {
         assertEquals("123", clone.id)
         assertEquals("123.x", clone.ipAddress)
         assertEquals("userName", clone.username)
+        assertEquals("userSegment", clone.segment)
         assertEquals("others", clone.others!!["others"])
         assertEquals("unknown", clone.unknown!!["unknown"])
     }
@@ -44,6 +45,7 @@ class UserTest {
         user.id = "456"
         user.ipAddress = "456.x"
         user.username = "newUserName"
+        user.segment = "newUserSegment"
         user.others!!["others"] = "newOthers"
         user.others!!["anotherOne"] = "anotherOne"
         val newUnknown = mapOf(Pair("unknown", "newUnknown"), Pair("otherUnknown", "otherUnknown"))
@@ -53,6 +55,7 @@ class UserTest {
         assertEquals("123", clone.id)
         assertEquals("123.x", clone.ipAddress)
         assertEquals("userName", clone.username)
+        assertEquals("userSegment", clone.segment)
         assertEquals("others", clone.others!!["others"])
         assertEquals(1, clone.others!!.size)
         assertEquals("unknown", clone.unknown!!["unknown"])
@@ -84,6 +87,7 @@ class UserTest {
             id = "123"
             ipAddress = "123.x"
             username = "userName"
+            segment = "userSegment"
             val others = mutableMapOf(Pair("others", "others"))
             setOthers(others)
             val unknown = mapOf(Pair("unknown", "unknown"))