feat(v9): Remove segment property (#5638)

noahsmartin · cursoragent · armcknight · web-flow · commit 9a1776780761 · 2025-07-15T22:08:58.000-04:00
* feat(v9): Remove segment property * Remove userSegment from SentryTraceContext for SDK_V9 (#5640) * Add SDK_V9 support for SentryTraceContext without userSegment Co-authored-by: noah.martin <noah.martin@sentry.io> * Remove userSegment parameter for SDK_V9, conditionally compile related code Co-authored-by: noah.martin <noah.martin@sentry.io> * Checkpoint before follow-up message * Remove userSegment parameter for SDK_V9 builds Co-authored-by: noah.martin <noah.martin@sentry.io> * Changes from background composer bc-531a0790-0efc-4531-b43a-6e3289ec47f4 --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> * Fixes * Update Sources/Sentry/Public/SentryTraceContext.h Co-authored-by: Andrew McKnight <andrew.mcknight@sentry.io> * PR feedback --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Andrew McKnight <andrew.mcknight@sentry.io>
diff --git a/CHANGELOG-v9.md b/CHANGELOG-v9.md
@@ -1,16 +1,17 @@
 # 9.0
 
-## Breaking Changes
-
-### Fixes
-
-Fixes warnings about minimum OS version being lower than Xcode supported version (#5591)
-
-### Improvements
+### Breaking Changes
 
 Removes deprecated user feedback API, this is replaced with the new feedback API (#5591)
 Removes unused SentryLogLevel (#5591)
 Removes deprecated getStoreEndpoint (#5591)
 Removes deprecated useSpan function (#5591)
 Removes deprecated SentryDebugImageProvider class (#5598)
 Makes app hang tracking V2 the default and removes the option to enable/disable it (#5615)
+Removes segment property on SentryUser, SentryBaggage, and SentryTraceContext (#5638)
+
+### Fixes
+
+Fixes warnings about minimum OS version being lower than Xcode supported version (#5591)
+
+### Improvements
diff --git a/Sources/Sentry/Public/SentryBaggage.h b/Sources/Sentry/Public/SentryBaggage.h
@@ -43,7 +43,9 @@ NS_SWIFT_NAME(Baggage)
 /**
  * The value of a segment attribute in the user's data bag, if it exists.
  */
+#if !SDK_V9
 @property (nullable, nonatomic, readonly) NSString *userSegment;
+#endif
 
 /**
  * The random value used to determine if the trace is sampled.
@@ -69,7 +71,9 @@ NS_SWIFT_NAME(Baggage)
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                         sampled:(nullable NSString *)sampled
                        replayId:(nullable NSString *)replayId;
@@ -79,7 +83,9 @@ NS_SWIFT_NAME(Baggage)
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                      sampleRand:(nullable NSString *)sampleRand
                         sampled:(nullable NSString *)sampled
diff --git a/Sources/Sentry/Public/SentryTraceContext.h b/Sources/Sentry/Public/SentryTraceContext.h
@@ -45,7 +45,9 @@ NS_SWIFT_NAME(TraceContext)
 /**
  * A subset of the scope's user context.
  */
+#if !SDK_V9
 @property (nullable, nonatomic, readonly) NSString *userSegment;
+#endif
 
 /**
  * Serialized sample rate used for this trace.
@@ -75,7 +77,9 @@ NS_SWIFT_NAME(TraceContext)
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                         sampled:(nullable NSString *)sampled
                        replayId:(nullable NSString *)replayId;
@@ -88,7 +92,9 @@ NS_SWIFT_NAME(TraceContext)
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                      sampleRand:(nullable NSString *)sampleRand
                         sampled:(nullable NSString *)sampled
@@ -111,16 +117,29 @@ NS_SWIFT_NAME(TraceContext)
                                   scope:(nullable SentryScope *)scope
                                 options:(SentryOptions *)options;
 
+#if SDK_V9
 /**
- * Initializes a SentryTraceContext with data from a traceID, options and userSegment.
+ * Initializes a SentryTraceContext with data from a traceId, options and replayId.
+ *
+ *  @param traceId The current tracer.
+ *  @param options The current active options.
+ *  @param replayId The current session replay.
+ */
+#else
+/**
+ * Initializes a SentryTraceContext with data from a traceId, options, userSegment and replayId.
  *
  *  @param traceId The current tracer.
  *  @param options The current active options.
  *  @param userSegment You can retrieve this usually from the `scope.userObject.segment`.
+ *  @param replayId The current session replay.
  */
+#endif
 - (instancetype)initWithTraceId:(SentryId *)traceId
                         options:(SentryOptions *)options
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                        replayId:(nullable NSString *)replayId;
 
 /**
diff --git a/Sources/Sentry/Public/SentryUser.h b/Sources/Sentry/Public/SentryUser.h
@@ -34,12 +34,14 @@ NS_SWIFT_NAME(User)
  */
 @property (atomic, copy) NSString *_Nullable ipAddress;
 
+#if !SDK_V9
 /**
  * The user segment, for apps that divide users in user segments.
  * @deprecated This field will be removed in the next major version.
  */
 @property (atomic, copy) NSString *_Nullable segment DEPRECATED_MSG_ATTRIBUTE(
     "This field is deprecated and will be removed in the next major update.");
+#endif // !SDK_V9
 
 /**
  * Optional: Human readable name
diff --git a/Sources/Sentry/SentryBaggage.m b/Sources/Sentry/SentryBaggage.m
@@ -15,7 +15,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                         sampled:(nullable NSString *)sampled
                        replayId:(nullable NSString *)replayId
@@ -25,7 +27,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                      releaseName:releaseName
                      environment:environment
                      transaction:transaction
+#if !SDK_V9
                      userSegment:userSegment
+#endif
                       sampleRate:sampleRate
                       sampleRand:nil
                          sampled:sampled
@@ -37,7 +41,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                      sampleRand:(nullable NSString *)sampleRand
                         sampled:(nullable NSString *)sampled
@@ -50,7 +56,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
         _releaseName = releaseName;
         _environment = environment;
         _transaction = transaction;
+#if !SDK_V9
         _userSegment = userSegment;
+#endif
         _sampleRate = sampleRate;
         _sampleRand = sampleRand;
         _sampled = sampled;
@@ -80,9 +88,11 @@ - (NSString *)toHTTPHeaderWithOriginalBaggage:(NSDictionary *_Nullable)originalB
         [information setValue:_transaction forKey:@"sentry-transaction"];
     }
 
+#if !SDK_V9
     if (_userSegment != nil) {
         [information setValue:_userSegment forKey:@"sentry-user_segment"];
     }
+#endif
 
     if (_sampleRand != nil) {
         [information setValue:_sampleRand forKey:@"sentry-sample_rand"];
diff --git a/Sources/Sentry/SentryClient.m b/Sources/Sentry/SentryClient.m
@@ -426,13 +426,19 @@ - (nullable SentryTraceContext *)getTraceStateWithEvent:(SentryEvent *)event
     }
 
     if (event.error || event.exceptions.count > 0) {
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+#if !SDK_V9
+        NSString *segment = nil;
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
+        segment = scope.userObject.segment;
+#    pragma clang diagnostic pop
+#endif
         return [[SentryTraceContext alloc] initWithTraceId:scope.propagationContext.traceId
                                                    options:self.options
-                                               userSegment:scope.userObject.segment
+#if !SDK_V9
+                                               userSegment:segment
+#endif
                                                   replayId:scope.replayId];
-#pragma clang diagnostic pop
     }
 
     return nil;
diff --git a/Sources/Sentry/SentryNetworkTracker.m b/Sources/Sentry/SentryNetworkTracker.m
@@ -230,14 +230,22 @@ - (void)urlSessionTaskResume:(NSURLSessionTask *)sessionTask
 - (void)addTraceWithoutTransactionToTask:(NSURLSessionTask *)sessionTask
 {
     SentryPropagationContext *propagationContext = SentrySDK.currentHub.scope.propagationContext;
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
+#if !SDK_V9
+    NSString *segment = nil;
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
+    segment = SentrySDK.currentHub.scope.userObject.segment;
+#    pragma clang diagnostic pop
+#endif
+
     SentryTraceContext *traceContext =
         [[SentryTraceContext alloc] initWithTraceId:propagationContext.traceId
                                             options:SentrySDK.currentHub.client.options
-                                        userSegment:SentrySDK.currentHub.scope.userObject.segment
+#if !SDK_V9
+                                        userSegment:segment
+#endif
                                            replayId:SentrySDK.currentHub.scope.replayId];
-#pragma clang diagnostic pop
 
     [self addBaggageHeader:[traceContext toBaggage]
                traceHeader:[propagationContext traceHeader]
diff --git a/Sources/Sentry/SentryTraceContext.m b/Sources/Sentry/SentryTraceContext.m
@@ -21,7 +21,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                         sampled:(nullable NSString *)sampled
                        replayId:(nullable NSString *)replayId
@@ -31,7 +33,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                      releaseName:releaseName
                      environment:environment
                      transaction:transaction
+#if !SDK_V9
                      userSegment:userSegment
+#endif
                       sampleRate:sampleRate
                       sampleRand:nil
                          sampled:sampled
@@ -43,7 +47,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
                     releaseName:(nullable NSString *)releaseName
                     environment:(nullable NSString *)environment
                     transaction:(nullable NSString *)transaction
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                      sampleRate:(nullable NSString *)sampleRate
                      sampleRand:(nullable NSString *)sampleRand
                         sampled:(nullable NSString *)sampled
@@ -55,7 +61,9 @@ - (instancetype)initWithTraceId:(SentryId *)traceId
         _environment = environment;
         _releaseName = releaseName;
         _transaction = transaction;
+#if !SDK_V9
         _userSegment = userSegment;
+#endif
         _sampleRand = sampleRand;
         _sampleRate = sampleRate;
         _sampled = sampled;
@@ -81,14 +89,15 @@ - (nullable instancetype)initWithTracer:(SentryTracer *)tracer
     if (tracer.traceId == nil || options.parsedDsn == nil)
         return nil;
 
-    NSString *userSegment;
-
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+#if !SDK_V9
+    NSString *userSegment = nil;
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wdeprecated-declarations"
     if (scope.userObject.segment) {
         userSegment = scope.userObject.segment;
     }
-#pragma clang diagnostic pop
+#    pragma clang diagnostic pop
+#endif // !SDK_V9
 
     NSString *serializedSampleRand = nil;
     NSNumber *sampleRand = [tracer.transactionContext sampleRand];
@@ -112,7 +121,9 @@ - (nullable instancetype)initWithTracer:(SentryTracer *)tracer
                      releaseName:options.releaseName
                      environment:options.environment
                      transaction:tracer.transactionContext.name
+#if !SDK_V9
                      userSegment:userSegment
+#endif
                       sampleRate:serializedSampleRate
                       sampleRand:serializedSampleRand
                          sampled:sampled
@@ -121,15 +132,19 @@ - (nullable instancetype)initWithTracer:(SentryTracer *)tracer
 
 - (instancetype)initWithTraceId:(SentryId *)traceId
                         options:(SentryOptions *)options
+#if !SDK_V9
                     userSegment:(nullable NSString *)userSegment
+#endif
                        replayId:(nullable NSString *)replayId;
 {
     return [[SentryTraceContext alloc] initWithTraceId:traceId
                                              publicKey:options.parsedDsn.url.user
                                            releaseName:options.releaseName
                                            environment:options.environment
                                            transaction:nil
+#if !SDK_V9
                                            userSegment:userSegment
+#endif
                                             sampleRate:nil
                                             sampleRand:nil
                                                sampled:nil
@@ -143,6 +158,7 @@ - (nullable instancetype)initWithDict:(NSDictionary<NSString *, id> *)dictionary
     if (traceId == nil || publicKey == nil)
         return nil;
 
+#if !SDK_V9
     NSString *userSegment;
     if (dictionary[@"user"] != nil) {
         NSDictionary *userInfo = dictionary[@"user"];
@@ -151,13 +167,16 @@ - (nullable instancetype)initWithDict:(NSDictionary<NSString *, id> *)dictionary
     } else {
         userSegment = dictionary[@"user_segment"];
     }
+#endif
 
     return [self initWithTraceId:traceId
                        publicKey:publicKey
                      releaseName:dictionary[@"release"]
                      environment:dictionary[@"environment"]
                      transaction:dictionary[@"transaction"]
+#if !SDK_V9
                      userSegment:userSegment
+#endif
                       sampleRate:dictionary[@"sample_rate"]
                       sampleRand:dictionary[@"sample_rand"]
                          sampled:dictionary[@"sampled"]
@@ -171,7 +190,9 @@ - (SentryBaggage *)toBaggage
                                                        releaseName:_releaseName
                                                        environment:_environment
                                                        transaction:_transaction
+#if !SDK_V9
                                                        userSegment:_userSegment
+#endif
                                                         sampleRate:_sampleRate
                                                         sampleRand:_sampleRand
                                                            sampled:_sampled
@@ -196,9 +217,11 @@ - (SentryBaggage *)toBaggage
         [result setValue:_transaction forKey:@"transaction"];
     }
 
+#if !SDK_V9
     if (_userSegment != nil) {
         [result setValue:_userSegment forKey:@"user_segment"];
     }
+#endif
 
     if (_sampleRand != nil) {
         [result setValue:_sampleRand forKey:@"sample_rand"];
diff --git a/Sources/Sentry/SentryUser.m b/Sources/Sentry/SentryUser.m
diff --git a/Sources/Swift/Protocol/Codable/SentryUserCodable.swift b/Sources/Swift/Protocol/Codable/SentryUserCodable.swift
diff --git a/sdk_api_V9.json b/sdk_api_V9.json
