feat: Add support for tags and trace context fields for termination watch (#5561)

* Update changelog

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

* feat: Add support for tags and context fields for termination watch

* Fix renamed properties

* Update changelog

* fix rebase conflicts

* Remove trace context calls

* Fix tests after removing traceContext call

* Separate extensions for encoding and decoding context, user, tags, and trace context in SentryScopePersistentStore

* Remove TraceContext persistence

* Remove unnecessary sanitization step

* Pr suggestions

Author: itaybre

CHANGELOG.md

@@ -15,6 +15,8 @@
 - 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)
 
 ## 8.53.1
 

Sentry.xcodeproj/project.pbxproj

@@ -1020,6 +1020,9 @@
 		D8F8F5572B835BC600AC5465 /* SentryMsgPackSerializerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = D8F8F5562B835BC600AC5465 /* SentryMsgPackSerializerTests.m */; };
 		D8FC98AB2CD0DAB30009824C /* BreadcrumbExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8FC98AA2CD0DAAC0009824C /* BreadcrumbExtension.swift */; };
 		D8FFE50C2703DBB400607131 /* SwizzlingCallTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8FFE50B2703DAAE00607131 /* SwizzlingCallTests.swift */; };
+		F41362112E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift in Sources */ = {isa = PBXBuildFile; fileRef = F41362102E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift */; };
+		F41362132E1C566100B84443 /* SentryScopePersistentStore+User.swift in Sources */ = {isa = PBXBuildFile; fileRef = F41362122E1C566100B84443 /* SentryScopePersistentStore+User.swift */; };
+		F41362152E1C568400B84443 /* SentryScopePersistentStore+Context.swift in Sources */ = {isa = PBXBuildFile; fileRef = F41362142E1C568400B84443 /* SentryScopePersistentStore+Context.swift */; };
 		F44858132E03579D0013E63B /* SentryCrashDynamicLinker+Test.h in Headers */ = {isa = PBXBuildFile; fileRef = F44858122E0357940013E63B /* SentryCrashDynamicLinker+Test.h */; };
 		F452437E2DE60B71003E8F50 /* SentryUseNSExceptionCallstackWrapper.m in Sources */ = {isa = PBXBuildFile; fileRef = F452437D2DE60B71003E8F50 /* SentryUseNSExceptionCallstackWrapper.m */; };
 		F45243882DE65968003E8F50 /* ExceptionCatcher.m in Sources */ = {isa = PBXBuildFile; fileRef = F45243872DE65968003E8F50 /* ExceptionCatcher.m */; };
@@ -1028,6 +1031,7 @@
 		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 */; };
+		F46DA6C32E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift in Sources */ = {isa = PBXBuildFile; fileRef = F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.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 */; };
@@ -2286,13 +2290,17 @@
 		D8F8F5562B835BC600AC5465 /* SentryMsgPackSerializerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryMsgPackSerializerTests.m; sourceTree = "<group>"; };
 		D8FC98AA2CD0DAAC0009824C /* BreadcrumbExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BreadcrumbExtension.swift; sourceTree = "<group>"; };
 		D8FFE50B2703DAAE00607131 /* SwizzlingCallTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SwizzlingCallTests.swift; sourceTree = "<group>"; };
+		F41362102E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Tags.swift"; sourceTree = "<group>"; };
+		F41362122E1C566100B84443 /* SentryScopePersistentStore+User.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+User.swift"; sourceTree = "<group>"; };
+		F41362142E1C568400B84443 /* SentryScopePersistentStore+Context.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Context.swift"; sourceTree = "<group>"; };
 		F44858122E0357940013E63B /* SentryCrashDynamicLinker+Test.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "SentryCrashDynamicLinker+Test.h"; sourceTree = "<group>"; };
 		F452437D2DE60B71003E8F50 /* SentryUseNSExceptionCallstackWrapper.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryUseNSExceptionCallstackWrapper.m; sourceTree = "<group>"; };
 		F45243862DE65968003E8F50 /* ExceptionCatcher.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ExceptionCatcher.h; sourceTree = "<group>"; };
 		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>"; };
+		F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SentryScopePersistentStore+Helper.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>"; };
@@ -4044,7 +4052,11 @@
 			isa = PBXGroup;
 			children = (
 				F4E3DCCA2E1579240093CB80 /* SentryScopePersistentStore.swift */,
+				F41362142E1C568400B84443 /* SentryScopePersistentStore+Context.swift */,
 				F458D1142E1869AD0028273E /* SentryScopePersistentStore+String.swift */,
+				F41362102E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift */,
+				F41362122E1C566100B84443 /* SentryScopePersistentStore+User.swift */,
+				F46DA6C22E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift */,
 			);
 			path = Persistence;
 			sourceTree = "<group>";
@@ -5323,6 +5335,7 @@
 				84302A812B5767A50027A629 /* SentryLaunchProfiling.m in Sources */,
 				63AA76A31EB9CBAA00D153DE /* SentryDsn.m in Sources */,
 				84DBC62C2CE82F12000C4904 /* SentryFeedback.swift in Sources */,
+				F41362132E1C566100B84443 /* SentryScopePersistentStore+User.swift in Sources */,
 				63B818FA1EC34639002FDF4C /* SentryDebugMeta.m in Sources */,
 				7B98D7D325FB65AE00C5A389 /* SentryWatchdogTerminationTracker.m in Sources */,
 				8E564AE8267AF22600FE117D /* SentryNetworkTrackingIntegration.m in Sources */,
@@ -5610,6 +5623,8 @@
 				D40604472DD2471600C40DC0 /* SentryNSApplication.m in Sources */,
 				7DAC589123D8B2E0001CF26B /* SentryGlobalEventProcessor.m in Sources */,
 				7BBD189E244EC8D200427C76 /* SentryRetryAfterHeaderParser.m in Sources */,
+				F41362152E1C568400B84443 /* SentryScopePersistentStore+Context.swift in Sources */,
+				F46DA6C32E1DBCA000DF6E3B /* SentryScopePersistentStore+Helper.swift in Sources */,
 				63FE711920DA4C1000CDBAE8 /* SentryCrashMachineContext.c in Sources */,
 				63FE711B20DA4C1000CDBAE8 /* SentryCrashString.c in Sources */,
 				7B14089824878F950035403D /* SentryCrashStackEntryMapper.m in Sources */,
@@ -5643,6 +5658,7 @@
 				03F84D3327DD4191008FE43F /* SentryMachLogging.cpp in Sources */,
 				D85852BA27EDDC5900C6D8AE /* SentryUIApplication.m in Sources */,
 				FAB3599A2E05D8080083D5E3 /* SentryEventSwiftHelper.m in Sources */,
+				F41362112E1C55AF00B84443 /* SentryScopePersistentStore+Tags.swift in Sources */,
 				7B4E375F258231FC00059C93 /* SentryAttachment.m in Sources */,
 				636085141ED47BE600E8599E /* SentryFileManager.m in Sources */,
 				63FE710B20DA4C1000CDBAE8 /* SentryCrashMach.c in Sources */,

Sources/Sentry/SentryScope.m

@@ -19,11 +19,6 @@
 
 @interface SentryScope ()
 
-/**
- * Set global tags -> these will be sent with every event
- */
-@property (atomic, strong) NSMutableDictionary<NSString *, NSString *> *tagDictionary;
-
 /**
  * Set global extra -> these will be sent with every event
  */

Sources/Sentry/SentryWatchdogTerminationScopeObserver.m

@@ -79,7 +79,7 @@ - (void)setLevel:(enum SentryLevel)level
 
 - (void)setTags:(nullable NSDictionary<NSString *, NSString *> *)tags
 {
-    // Left blank on purpose
+    [self.attributesProcessor setTags:tags];
 }
 
 - (void)setUser:(nullable SentryUser *)user
@@ -89,7 +89,9 @@ - (void)setUser:(nullable SentryUser *)user
 
 - (void)setTraceContext:(nullable NSDictionary<NSString *, id> *)traceContext
 {
-    // Left blank on purpose
+    // Nothing to do here, Trace Context is not persisted for watchdog termination events
+    // On regular events, we have the current trace in memory, but there isn't time to persist one
+    // in watchdog termination events
 }
 
 @end

Sources/Sentry/SentryWatchdogTerminationTracker.m

@@ -60,6 +60,7 @@ - (void)start
             event.user = [self.scopePersistentStore readPreviousUserFromDisk];
             event.dist = [self.scopePersistentStore readPreviousDistFromDisk];
             event.environment = [self.scopePersistentStore readPreviousEnvironmentFromDisk];
+            event.tags = [self.scopePersistentStore readPreviousTagsFromDisk];
 
             SentryException *exception =
                 [[SentryException alloc] initWithValue:SentryWatchdogTerminationExceptionValue

Sources/Sentry/SentryWatchdogTerminationTrackingIntegration.m

@@ -12,6 +12,7 @@
 #    import <SentryHub.h>
 #    import <SentryNSProcessInfoWrapper.h>
 #    import <SentryOptions+Private.h>
+#    import <SentryPropagationContext.h>
 #    import <SentrySDK+Private.h>
 #    import <SentrySwift.h>
 #    import <SentryWatchdogTerminationBreadcrumbProcessor.h>
@@ -99,6 +100,9 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         [scopeObserver setUser:outerScope.userObject];
         [scopeObserver setEnvironment:outerScope.environmentString];
         [scopeObserver setDist:outerScope.distString];
+        [scopeObserver setTags:outerScope.tags];
+        // We intentionally skip calling `setTraceContext:` since traces are not stored for watchdog
+        // termination events
     }];
 
     return YES;

Sources/Sentry/include/SentryScope+Private.h

@@ -40,6 +40,11 @@ NS_ASSUME_NONNULL_BEGIN
 @property (atomic, strong)
     NSMutableDictionary<NSString *, NSDictionary<NSString *, id> *> *contextDictionary;
 
+/**
+ * Set global tags -> these will be sent with every event
+ */
+@property (atomic, strong) NSMutableDictionary<NSString *, NSString *> *tagDictionary;
+
 - (void)addObserver:(id<SentryScopeObserver>)observer;
 
 - (nullable SentryEvent *)applyToEvent:(SentryEvent *)event

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

@@ -48,6 +48,12 @@ import Foundation
         }
     }
 
+    public func setTags(_ tags: [String: String]?) {
+        setData(data: tags, field: .tags) { [weak self] data in
+            self?.scopePersistentStore.writeTagsToDisk(tags: 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+Context.swift

@@ -0,0 +1,11 @@
+@_implementationOnly import _SentryPrivate
+
+extension SentryScopePersistentStore {
+    func encode(context: [String: [String: Any]]) -> Data? {
+        return encode(context, "context", true)
+    }
+    
+    func decodeContext(from data: Data) -> [String: [String: Any]]? {
+        return decode(from: data, "context")
+    }
+}

Sources/Swift/Persistence/SentryScopePersistentStore+Helper.swift

@@ -0,0 +1,55 @@
+@_implementationOnly import _SentryPrivate
+
+extension SentryScopePersistentStore {
+    func encode<T>(_ genericModel: T, _ name: String, _ sanitize: Bool = false) -> Data? {
+        var model: Any = genericModel
+        if sanitize {
+            // We need to check if the context is a valid JSON object before encoding it.
+            // Otherwise it will throw an unhandled `NSInvalidArgumentException` exception.
+            // The error handler is required but will never be executed due to Swift type safety.
+            guard let wrapped = genericModel as? [AnyHashable: Any],
+                  let sanitizedModel = sentry_sanitize(wrapped) else {
+                SentrySDKLog.error("Failed to sanitize \(name), reason: \(name) is not valid json: \(genericModel)")
+                return nil
+            }
+            model = sanitizedModel
+        }
+        
+        guard let data = SentrySerialization.data(withJSONObject: model) else {
+            SentrySDKLog.error("Failed to serialize \(name), reason: \(name) is not valid json: \(genericModel)")
+            return nil
+        }
+        
+        return data
+    }
+    
+    func decode<T>(from data: Data, _ name: String) -> [String: T]? {
+        guard let deserialized = SentrySerialization.deserializeDictionary(fromJsonData: data) else {
+            SentrySDKLog.error("Failed to deserialize \(name), reason: data is not valid json")
+            return nil
+        }
+
+        // `SentrySerialization` is a wrapper around `NSJSONSerialization` which returns any type of data (`id`).
+        // It is the casted to a `NSDictionary`, which is then casted to a `[AnyHashable: Any]` in Swift.
+        //
+        // The responsibility of validating and casting the deserialized data from any data to a dictionary is delegated
+        // to the `SentrySerialization` class.
+        //
+        // As this decode Tags method specifically returns a dictionary of strings, we need to ensure that
+        // each value is a string.
+        //
+        // If the deserialized value is not a string, something clearly went wrong and we should discard the data.
+
+        // Iterate through the deserialized dictionary and check if the type is a dictionary.
+        // When all values are strings, we can safely cast it to `T` without allocating
+        // additional memory (like when mapping values).
+        for (key, value) in deserialized {
+            guard value is T else {
+                SentrySDKLog.error("Failed to deserialize \(name), reason: value for key \(key) is not a valid string")
+                return nil
+            }
+        }
+
+        return deserialized as? [String: T]
+    }
+}