feat: Add support for extras, fingerprint, and level watchdog termination events (#5569)

* feat: Add support for extras, fingerprint, and level watchdog termination events

* Update changelog

* Fix rebase changes

* Ensure `deserializeArrayFromJsonData` returns an array + tests

* extract SentryScopePersistentStore extensions for extras, fingerprint, and level encoding/decoding

* Skip setLevel in `SentryWatchdogTerminationTrackingIntegration.m`

* Remove setLevel assertions

* Log class found on serialization fail

* Remove level persistance

* Sanitize extras

* Add comment

* Fix rebase issues

* Use generic decoder

* Move fixes in Changelog

* Refactor fingerprint deserialization to return only string elements and add test for non-string elements

Author: itaybre

CHANGELOG.md

@@ -8,15 +8,15 @@
 - User feedback widget can now be displayed in SwiftUI apps (#5223)
 - Fix crash when SentryFileManger is nil (#5535)
 - Fix crash when capturing events at the same time `bindClient:` is called from a different thread (#5523)
+- Record user for watchdog termination events (#5558)
+- Add support for dist and environment fields for termination watch (#5560)
+- Add support for tags and context fields for termination watch (#5561)
+- Add support for extras, fingerprint, and level watchdog termination events (#5569)
 
 ### Improvements
 
 - 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)
-- Record user for watchdog termination events (#5558)
-- Add support for tags and context fields for termination watch (#5561)
 - Deprecate getStoreEndpoint (#5591)
 
 ## 8.53.1

Sentry.xcodeproj/project.pbxproj

@@ -1032,6 +1032,8 @@
 		F458D1132E180BB00028273E /* SentryFileManagerProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1122E180BB00028273E /* SentryFileManagerProtocol.swift */; };
 		F458D1152E1869AD0028273E /* SentryScopePersistentStore+String.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1142E1869AD0028273E /* SentryScopePersistentStore+String.swift */; };
 		F46DA6C32E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift in Sources */ = {isa = PBXBuildFile; fileRef = F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */; };
+		F458D1172E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1162E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift */; };
+		F458D1192E186E000028273E /* SentryScopePersistentStore+Extras.swift in Sources */ = {isa = PBXBuildFile; fileRef = F458D1182E186E000028273E /* SentryScopePersistentStore+Extras.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 */; };
@@ -2301,6 +2303,8 @@
 		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>"; };
 		F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Helper.swift"; sourceTree = "<group>"; };
+		F458D1162E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Fingerprint.swift"; sourceTree = "<group>"; };
+		F458D1182E186E000028273E /* SentryScopePersistentStore+Extras.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Extras.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>"; };
@@ -4057,6 +4061,9 @@
 				F41362102E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift */,
 				F41362122E1C566100B84443 /* SentryScopePersistentStore+User.swift */,
 				F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */,
+				F458D11A2E186E0D0028273E /* SentryScopePersistentStore+Level.swift */,
+				F458D1182E186E000028273E /* SentryScopePersistentStore+Extras.swift */,
+				F458D1162E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift */,
 			);
 			path = Persistence;
 			sourceTree = "<group>";
@@ -5394,6 +5401,7 @@
 				D8CB741B2947286500A5F964 /* SentryEnvelopeItemHeader.m in Sources */,
 				92ECD73C2E05ACE00063EC10 /* SentryLog.swift in Sources */,
 				F458D1152E1869AD0028273E /* SentryScopePersistentStore+String.swift in Sources */,
+				F458D1172E186DF20028273E /* SentryScopePersistentStore+Fingerprint.swift in Sources */,
 				D8CB7417294724CC00A5F964 /* SentryEnvelopeAttachmentHeader.m in Sources */,
 				D84793262788737D00BE8E99 /* SentryByteCountFormatter.m in Sources */,
 				63AA769E1EB9C57A00D153DE /* SentryError.mm in Sources */,
@@ -5464,6 +5472,7 @@
 				848A45192BBF8D33006AAAEC /* SentryContinuousProfiler.mm in Sources */,
 				D81988C32BEC189C0020E36C /* SentryRRWebMetaEvent.swift in Sources */,
 				15E0A8E5240C457D00F044E3 /* SentryEnvelope.m in Sources */,
+				F458D1192E186E000028273E /* SentryScopePersistentStore+Extras.swift in Sources */,
 				8EC3AE7A25CA23B600E7591A /* SentrySpan.m in Sources */,
 				6360850E1ED2AFE100E8599E /* SentryBreadcrumb.m in Sources */,
 				D82859432C3E753C009A28AA /* SentrySessionReplaySyncC.c in Sources */,
@@ -5659,6 +5668,7 @@
 				D85852BA27EDDC5900C6D8AE /* SentryUIApplication.m in Sources */,
 				FAB3599A2E05D8080083D5E3 /* SentryEventSwiftHelper.m in Sources */,
 				F41362112E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift in Sources */,
+				F458D11B2E186E0D0028273E /* SentryScopePersistentStore+Level.swift in Sources */,
 				7B4E375F258231FC00059C93 /* SentryAttachment.m in Sources */,
 				636085141ED47BE600E8599E /* SentryFileManager.m in Sources */,
 				63FE710B20DA4C1000CDBAE8 /* SentryCrashMach.c in Sources */,

Sources/Sentry/SentryScope.m

@@ -19,21 +19,6 @@
 
 @interface SentryScope ()
 
-/**
- * Set global extra -> these will be sent with every event
- */
-@property (atomic, strong) NSMutableDictionary<NSString *, id> *extraDictionary;
-
-/**
- * Set the fingerprint of an event to determine the grouping
- */
-@property (atomic, strong) NSMutableArray<NSString *> *fingerprintArray;
-
-/**
- * SentryLevel of the event
- */
-@property (atomic) enum SentryLevel levelEnum;
-
 @property (atomic) NSUInteger maxBreadcrumbs;
 @property (atomic) NSUInteger currentBreadcrumbIndex;
 

Sources/Sentry/SentrySerialization.m

@@ -310,6 +310,22 @@ + (SentryLevel)levelFromData:(NSData *)eventEnvelopeItemData
     return sentryLevelForString(eventDictionary[@"level"]);
 }
 
++ (NSArray *_Nullable)deserializeArrayFromJsonData:(NSData *)data
+{
+    NSError *error = nil;
+    id json = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
+    if (nil != error) {
+        SENTRY_LOG_ERROR(@"Failed to deserialize json item array: %@", error);
+        return nil;
+    }
+    if (![json isKindOfClass:[NSArray class]]) {
+        SENTRY_LOG_ERROR(
+            @"Deserialized json is not an NSArray, found %@", NSStringFromClass([json class]));
+        return nil;
+    }
+    return (NSArray *)json;
+}
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/SentryWatchdogTerminationScopeObserver.m

@@ -64,17 +64,17 @@ - (void)setEnvironment:(nullable NSString *)environment
 
 - (void)setExtras:(nullable NSDictionary<NSString *, id> *)extras
 {
-    // Left blank on purpose
+    [self.attributesProcessor setExtras:extras];
 }
 
 - (void)setFingerprint:(nullable NSArray<NSString *> *)fingerprint
 {
-    // Left blank on purpose
+    [self.attributesProcessor setFingerprint:fingerprint];
 }
 
 - (void)setLevel:(enum SentryLevel)level
 {
-    // Left blank on purpose
+    // Nothing to do here, watchdog termination events are always Fatal
 }
 
 - (void)setTags:(nullable NSDictionary<NSString *, NSString *> *)tags

Sources/Sentry/SentryWatchdogTerminationTracker.m

@@ -61,6 +61,9 @@ - (void)start
             event.dist = [self.scopePersistentStore readPreviousDistFromDisk];
             event.environment = [self.scopePersistentStore readPreviousEnvironmentFromDisk];
             event.tags = [self.scopePersistentStore readPreviousTagsFromDisk];
+            event.extra = [self.scopePersistentStore readPreviousExtrasFromDisk];
+            event.fingerprint = [self.scopePersistentStore readPreviousFingerprintFromDisk];
+            // Termination events always have fatal level, so we are not reading from disk
 
             SentryException *exception =
                 [[SentryException alloc] initWithValue:SentryWatchdogTerminationExceptionValue

Sources/Sentry/SentryWatchdogTerminationTrackingIntegration.m

@@ -101,8 +101,11 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         [scopeObserver setEnvironment:outerScope.environmentString];
         [scopeObserver setDist:outerScope.distString];
         [scopeObserver setTags:outerScope.tags];
+        [scopeObserver setExtras:outerScope.extraDictionary];
+        [scopeObserver setFingerprint:outerScope.fingerprintArray];
         // We intentionally skip calling `setTraceContext:` since traces are not stored for watchdog
         // termination events
+        // We intentionally skip calling `setLevel:` since all termination events have fatal level
     }];
 
     return YES;

Sources/Sentry/include/SentryScope+Private.h

@@ -30,6 +30,21 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @property (atomic, copy) NSString *_Nullable distString;
 
+/**
+ * Set global extra -> these will be sent with every event
+ */
+@property (atomic, strong) NSMutableDictionary<NSString *, id> *extraDictionary;
+
+/**
+ * Set the fingerprint of an event to determine the grouping
+ */
+@property (atomic, strong) NSMutableArray<NSString *> *fingerprintArray;
+
+/**
+ * SentryLevel of the event
+ */
+@property (atomic) enum SentryLevel levelEnum;
+
 @property (nonatomic, nullable, copy) NSString *currentScreen;
 
 - (NSArray<SentryBreadcrumb *> *)breadcrumbs;

Sources/Sentry/include/SentrySerialization.h

@@ -34,6 +34,11 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (SentryLevel)levelFromData:(NSData *)eventEnvelopeItemData;
 
+/**
+ * Retrieves the json object from an event envelope item data.
+ */
++ (NSArray *_Nullable)deserializeArrayFromJsonData:(NSData *)data;
+
 @end
 
 NS_ASSUME_NONNULL_END

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

@@ -54,6 +54,18 @@ import Foundation
         }
     }
 
+    public func setExtras(_ extras: [String: Any]?) {
+        setData(data: extras, field: .extras) { [weak self] data in
+            self?.scopePersistentStore.writeExtrasToDisk(extras: data)
+        }
+    }
+    
+    public func setFingerprint(_ fingerprint: [String]?) {
+        setData(data: fingerprint, field: .fingerprint) { [weak self] data in
+            self?.scopePersistentStore.writeFingerprintToDisk(fingerprint: 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))")