feat: Add support for dist and environment fields for termination watch (#5560)

* Update tests in SentryScopePersistentStoreTests and SentryWatchdogTerminationFieldsProcessorTests for the new fields

* Rename `SentryWatchdogTerminationFieldsProcessor` to `SentryWatchdogTerminationAttributesProcessor`

* feat: Add support for dist and environment fields for termination watch

* Update `SentrySDKTests` tests

* Update `SentrySDKTests` tests

* Update tests

* Update changelog

* Undo extrDictionary move

* Fix rebase tests

* Extract string encoding / decoding to a new file

Author: itaybre

CHANGELOG.md

@@ -13,6 +13,7 @@
 - Removed `APPLICATION_EXTENSION_API_ONLY` requirement (#5524)
 - Improve launch profile configuration management (#5318)
 - Record user for watchdog termination events (#5558)
+- Add support for dist and environment fields for termination watch (#5560)
 
 ## 8.53.1
 

Sentry.xcodeproj/project.pbxproj

@@ -1027,6 +1027,7 @@
 		F452438A2DE65968003E8F50 /* ExceptionCatcher.h in Headers */ = {isa = PBXBuildFile; fileRef = F45243862DE65968003E8F50 /* ExceptionCatcher.h */; };
 		F452438C2DE65BC0003E8F50 /* SentryUseNSExceptionCallstackWrapper.h in Headers */ = {isa = PBXBuildFile; fileRef = F452438B2DE65BC0003E8F50 /* SentryUseNSExceptionCallstackWrapper.h */; };
 		F458D1132E180BB00028273E /* SentryFileManagerProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1122E180BB00028273E /* SentryFileManagerProtocol.swift */; };
+		F458D1152E1869AD0028273E /* SentryScopePersistentStore+String.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1142E1869AD0028273E /* SentryScopePersistentStore+String.swift */; };
 		F49D41982DEA27AF00D9244E /* SentryUseNSExceptionCallstackWrapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F49D41972DEA27AF00D9244E /* SentryUseNSExceptionCallstackWrapperTests.swift */; };
 		F49D419A2DEA2FB000D9244E /* SentryCrashExceptionApplicationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F49D41992DEA2FB000D9244E /* SentryCrashExceptionApplicationTests.swift */; };
 		F49D419C2DEA30C300D9244E /* SentryCrashExceptionApplicationHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = F49D419B2DEA30B800D9244E /* SentryCrashExceptionApplicationHelper.h */; };
@@ -2290,6 +2291,7 @@
 		F45243872DE65968003E8F50 /* ExceptionCatcher.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ExceptionCatcher.m; sourceTree = "<group>"; };
 		F452438B2DE65BC0003E8F50 /* SentryUseNSExceptionCallstackWrapper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryUseNSExceptionCallstackWrapper.h; path = include/SentryUseNSExceptionCallstackWrapper.h; sourceTree = "<group>"; };
 		F458D1122E180BB00028273E /* SentryFileManagerProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryFileManagerProtocol.swift; sourceTree = "<group>"; };
+		F458D1142E1869AD0028273E /* SentryScopePersistentStore+String.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+String.swift"; sourceTree = "<group>"; };
 		F49D41972DEA27AF00D9244E /* SentryUseNSExceptionCallstackWrapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUseNSExceptionCallstackWrapperTests.swift; sourceTree = "<group>"; };
 		F49D41992DEA2FB000D9244E /* SentryCrashExceptionApplicationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryCrashExceptionApplicationTests.swift; sourceTree = "<group>"; };
 		F49D419B2DEA30B800D9244E /* SentryCrashExceptionApplicationHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryCrashExceptionApplicationHelper.h; path = include/SentryCrashExceptionApplicationHelper.h; sourceTree = "<group>"; };
@@ -4039,6 +4041,7 @@
 			isa = PBXGroup;
 			children = (
 				F4E3DCCA2E1579240093CB80 /* SentryScopePersistentStore.swift */,
+				F458D1142E1869AD0028273E /* SentryScopePersistentStore+String.swift */,
 			);
 			path = Persistence;
 			sourceTree = "<group>";
@@ -5374,6 +5377,7 @@
 				620078722D38F00D0022CB67 /* SentryGeoCodable.swift in Sources */,
 				D8CB741B2947286500A5F964 /* SentryEnvelopeItemHeader.m in Sources */,
 				92ECD73C2E05ACE00063EC10 /* SentryLog.swift in Sources */,
+				F458D1152E1869AD0028273E /* SentryScopePersistentStore+String.swift in Sources */,
 				D8CB7417294724CC00A5F964 /* SentryEnvelopeAttachmentHeader.m in Sources */,
 				D84793262788737D00BE8E99 /* SentryByteCountFormatter.m in Sources */,
 				63AA769E1EB9C57A00D153DE /* SentryError.mm in Sources */,

Sources/Sentry/SentryScope.m

@@ -29,11 +29,6 @@ @interface SentryScope ()
  */
 @property (atomic, strong) NSMutableDictionary<NSString *, id> *extraDictionary;
 
-/**
- * This distribution of the application.
- */
-@property (atomic, copy) NSString *_Nullable distString;
-
 /**
  * Set the fingerprint of an event to determine the grouping
  */

Sources/Sentry/SentryWatchdogTerminationScopeObserver.m

@@ -54,12 +54,12 @@ - (void)setContext:(nullable NSDictionary<NSString *, id> *)context
 
 - (void)setDist:(nullable NSString *)dist
 {
-    // Left blank on purpose
+    [self.attributesProcessor setDist:dist];
 }
 
 - (void)setEnvironment:(nullable NSString *)environment
 {
-    // Left blank on purpose
+    [self.attributesProcessor setEnvironment:environment];
 }
 
 - (void)setExtras:(nullable NSDictionary<NSString *, id> *)extras

Sources/Sentry/SentryWatchdogTerminationTracker.m

@@ -58,6 +58,8 @@ - (void)start
             [self addBreadcrumbsToEvent:event];
             [self addContextToEvent:event];
             event.user = [self.scopePersistentStore readPreviousUserFromDisk];
+            event.dist = [self.scopePersistentStore readPreviousDistFromDisk];
+            event.environment = [self.scopePersistentStore readPreviousEnvironmentFromDisk];
 
             SentryException *exception =
                 [[SentryException alloc] initWithValue:SentryWatchdogTerminationExceptionValue

Sources/Sentry/SentryWatchdogTerminationTrackingIntegration.m

@@ -97,6 +97,8 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         // before installation.
         [scopeObserver setContext:outerScope.contextDictionary];
         [scopeObserver setUser:outerScope.userObject];
+        [scopeObserver setEnvironment:outerScope.environmentString];
+        [scopeObserver setDist:outerScope.distString];
     }];
 
     return YES;

Sources/Sentry/include/SentryScope+Private.h

@@ -25,6 +25,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (nonatomic, strong) SentryPropagationContext *propagationContext;
 
+/**
+ * This distribution of the application.
+ */
+@property (atomic, copy) NSString *_Nullable distString;
+
 @property (nonatomic, nullable, copy) NSString *currentScreen;
 
 - (NSArray<SentryBreadcrumb *> *)breadcrumbs;

Sources/Swift/Integrations/WatchdogTerminations/Processors/SentryWatchdogTerminationAttributesProcessor.swift

@@ -36,6 +36,18 @@ import Foundation
         }
     }
 
+    public func setDist(_ dist: String?) {
+        setData(data: dist, field: .dist) { [weak self] data in
+            self?.scopePersistentStore.writeDistToDisk(dist: data)
+        }
+    }
+    
+    public func setEnvironment(_ environment: String?) {
+        setData(data: environment, field: .environment) { [weak self] data in
+            self?.scopePersistentStore.writeEnvironmentToDisk(environment: data)
+        }
+    }
+    
     // MARK: - Private
     private func setData<T>(data: T?, field: SentryScopeField, save: @escaping (T) -> Void) {
         SentrySDKLog.debug("Setting \(field.name) in background queue: \(String(describing: data))")

Sources/Swift/Persistence/SentryScopePersistentStore+String.swift

@@ -0,0 +1,10 @@
+// MARK: - Strings
+extension SentryScopePersistentStore {
+    func encode(string: String) -> Data? {
+        return string.data(using: .utf8)
+    }
+    
+    func decodeString(from data: Data) -> String? {
+        return String(data: data, encoding: .utf8)
+    }
+}

Sources/Swift/Persistence/SentryScopePersistentStore.swift

@@ -4,13 +4,19 @@
 enum SentryScopeField: UInt, CaseIterable {
     case context
     case user
+    case dist
+    case environment
 
     var name: String {
         switch self {
         case .context:
             return "context"
         case .user:
             return "user"
+        case .dist:
+            return "dist"
+        case .environment:
+            return "environment"
         }
     }
 }
@@ -82,6 +88,30 @@ enum SentryScopeField: UInt, CaseIterable {
         writeFieldToDisk(field: .user, data: encode(user: user))
     }
 
+    // MARK: - Dist
+    @objc
+    public func readPreviousDistFromDisk() -> String? {
+        readFieldFromDisk(field: .dist) { data in
+            decodeString(from: data)
+        }
+    }
+    
+    func writeDistToDisk(dist: String) {
+        writeFieldToDisk(field: .dist, data: encode(string: dist))
+    }
+    
+    // MARK: - User
+    @objc
+    public func readPreviousEnvironmentFromDisk() -> String? {
+        readFieldFromDisk(field: .environment) { data in
+            decodeString(from: data)
+        }
+    }
+    
+    func writeEnvironmentToDisk(environment: String) {
+        writeFieldToDisk(field: .environment, data: encode(string: environment))
+    }
+    
     // MARK: - Private Functions
 
     private func moveCurrentFileToPreviousFile(field: SentryScopeField) {