feat: Update Persistent store and processor to handle multiple data types (#5558)

* feat: Update Persistent store and processor to handle multiple data types

* Update tests in SentryScopePersistentStoreTests and SentryWatchdogTerminationFieldsProcessorTests for the new fields

* Update changelog

* Fix tests on macOS

* Rename `SentryWatchdogTerminationFieldsProcessor` to `SentryWatchdogTerminationAttributesProcessor`

* Apply suggestions from PR review

* Fix typo

* Update tests to use fixture

* Rename `decoderAux` to `decoderUserHelper`

Author: itaybre

CHANGELOG.md

@@ -12,6 +12,7 @@
 
 - Removed `APPLICATION_EXTENSION_API_ONLY` requirement (#5524)
 - Improve launch profile configuration management (#5318)
+- Record user for watchdog termination events (#5558)
 
 ## 8.53.1
 

Sentry.xcodeproj/project.pbxproj

@@ -390,11 +390,10 @@ - (SentryMXManager *)metricKitManager SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOC
 
 #endif // SENTRY_HAS_METRIC_KIT
 
-- (SentryScopeContextPersistentStore *)
-    scopeContextPersistentStore SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
+- (SentryScopePersistentStore *)scopePersistentStore SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
 {
-    SENTRY_LAZY_INIT(_scopeContextPersistentStore,
-        [[SentryScopeContextPersistentStore alloc] initWithFileManager:self.fileManager]);
+    SENTRY_LAZY_INIT(_scopePersistentStore,
+        [[SentryScopePersistentStore alloc] initWithFileManager:self.fileManager]);
 }
 
 - (SentryDebugImageProvider *)debugImageProvider SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
@@ -416,7 +415,7 @@ - (SentryWatchdogTerminationScopeObserver *)getWatchdogTerminationScopeObserverW
         initWithBreadcrumbProcessor:
             [self
                 getWatchdogTerminationBreadcrumbProcessorWithMaxBreadcrumbs:options.maxBreadcrumbs]
-                   contextProcessor:self.watchdogTerminationContextProcessor];
+                attributesProcessor:self.watchdogTerminationAttributesProcessor];
 }
 
 - (SentryWatchdogTerminationBreadcrumbProcessor *)
@@ -429,16 +428,16 @@ - (SentryWatchdogTerminationScopeObserver *)getWatchdogTerminationScopeObserverW
                    fileManager:self.fileManager];
 }
 
-- (SentryWatchdogTerminationContextProcessor *)
-    watchdogTerminationContextProcessor SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
+- (SentryWatchdogTerminationAttributesProcessor *)
+    watchdogTerminationAttributesProcessor SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
 {
-    SENTRY_LAZY_INIT(_watchdogTerminationContextProcessor,
-        [[SentryWatchdogTerminationContextProcessor alloc]
+    SENTRY_LAZY_INIT(_watchdogTerminationAttributesProcessor,
+        [[SentryWatchdogTerminationAttributesProcessor alloc]
             initWithDispatchQueueWrapper:
                 [self.dispatchFactory
-                    createUtilityQueue:"io.sentry.watchdog-termination-tracking.context-processor"
+                    createUtilityQueue:"io.sentry.watchdog-termination-tracking.fields-processor"
                       relativePriority:0]
-                       scopeContextStore:self.scopeContextPersistentStore])
+                    scopePersistentStore:self.scopePersistentStore])
 }
 #endif
 

Sources/Sentry/SentryDependencyContainer.m

@@ -241,7 +241,7 @@ + (void)startWithOptions:(SentryOptions *)options
     [newClient.fileManager moveAppStateToPreviousAppState];
     [newClient.fileManager moveBreadcrumbsToPreviousBreadcrumbs];
     [SentryDependencyContainer.sharedInstance
-            .scopeContextPersistentStore moveCurrentFileToPreviousFile];
+            .scopePersistentStore moveAllCurrentStateToPreviousState];
 
     SentryScope *scope
         = options.initialScope([[SentryScope alloc] initWithMaxBreadcrumbs:options.maxBreadcrumbs]);

Sources/Sentry/SentrySDK.m

@@ -11,19 +11,19 @@
 @interface SentryWatchdogTerminationScopeObserver ()
 
 @property (nonatomic, strong) SentryWatchdogTerminationBreadcrumbProcessor *breadcrumbProcessor;
-@property (nonatomic, strong) SentryWatchdogTerminationContextProcessor *contextProcessor;
+@property (nonatomic, strong) SentryWatchdogTerminationAttributesProcessor *attributesProcessor;
 
 @end
 
 @implementation SentryWatchdogTerminationScopeObserver
 
 - (instancetype)
     initWithBreadcrumbProcessor:(SentryWatchdogTerminationBreadcrumbProcessor *)breadcrumbProcessor
-               contextProcessor:(SentryWatchdogTerminationContextProcessor *)contextProcessor;
+            attributesProcessor:(SentryWatchdogTerminationAttributesProcessor *)attributesProcessor;
 {
     if (self = [super init]) {
         self.breadcrumbProcessor = breadcrumbProcessor;
-        self.contextProcessor = contextProcessor;
+        self.attributesProcessor = attributesProcessor;
     }
 
     return self;
@@ -34,7 +34,7 @@ @implementation SentryWatchdogTerminationScopeObserver
 - (void)clear
 {
     [self.breadcrumbProcessor clear];
-    [self.contextProcessor clear];
+    [self.attributesProcessor clear];
 }
 
 - (void)addSerializedBreadcrumb:(NSDictionary *)crumb
@@ -49,7 +49,7 @@ - (void)clearBreadcrumbs
 
 - (void)setContext:(nullable NSDictionary<NSString *, id> *)context
 {
-    [self.contextProcessor setContext:context];
+    [self.attributesProcessor setContext:context];
 }
 
 - (void)setDist:(nullable NSString *)dist
@@ -84,7 +84,7 @@ - (void)setTags:(nullable NSDictionary<NSString *, NSString *> *)tags
 
 - (void)setUser:(nullable SentryUser *)user
 {
-    // Left blank on purpose
+    [self.attributesProcessor setUser:user];
 }
 
 - (void)setTraceContext:(nullable NSDictionary<NSString *, id> *)traceContext

Sources/Sentry/SentryWatchdogTerminationScopeObserver.m

@@ -22,7 +22,7 @@ @interface SentryWatchdogTerminationTracker ()
 @property (nonatomic, strong) SentryDispatchQueueWrapper *dispatchQueue;
 @property (nonatomic, strong) SentryAppStateManager *appStateManager;
 @property (nonatomic, strong) SentryFileManager *fileManager;
-@property (nonatomic, strong) SentryScopeContextPersistentStore *scopeContextStore;
+@property (nonatomic, strong) SentryScopePersistentStore *scopePersistentStore;
 
 @end
 
@@ -33,15 +33,15 @@ - (instancetype)initWithOptions:(SentryOptions *)options
                 appStateManager:(SentryAppStateManager *)appStateManager
            dispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
                     fileManager:(SentryFileManager *)fileManager
-              scopeContextStore:(SentryScopeContextPersistentStore *)scopeContextStore
+           scopePersistentStore:(SentryScopePersistentStore *)scopePersistentStore
 {
     if (self = [super init]) {
         self.options = options;
         self.watchdogTerminationLogic = watchdogTerminationLogic;
         self.appStateManager = appStateManager;
         self.dispatchQueue = dispatchQueueWrapper;
         self.fileManager = fileManager;
-        self.scopeContextStore = scopeContextStore;
+        self.scopePersistentStore = scopePersistentStore;
     }
     return self;
 }
@@ -57,6 +57,7 @@ - (void)start
 
             [self addBreadcrumbsToEvent:event];
             [self addContextToEvent:event];
+            event.user = [self.scopePersistentStore readPreviousUserFromDisk];
 
             SentryException *exception =
                 [[SentryException alloc] initWithValue:SentryWatchdogTerminationExceptionValue
@@ -105,7 +106,7 @@ - (void)addContextToEvent:(SentryEvent *)event
 {
     // Load the previous context from disk, or create an empty one if it doesn't exist
     NSDictionary<NSString *, NSDictionary<NSString *, id> *> *previousContext =
-        [self.scopeContextStore readPreviousContextFromDisk];
+        [self.scopePersistentStore readPreviousContextFromDisk];
     NSMutableDictionary *context =
         [[NSMutableDictionary alloc] initWithDictionary:previousContext ?: @{}];
 

Sources/Sentry/SentryWatchdogTerminationTracker.m

@@ -66,15 +66,15 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         [[SentryWatchdogTerminationLogic alloc] initWithOptions:options
                                                    crashAdapter:crashWrapper
                                                 appStateManager:appStateManager];
-    SentryScopeContextPersistentStore *scopeContextStore =
-        [SentryDependencyContainer.sharedInstance scopeContextPersistentStore];
+    SentryScopePersistentStore *scopeStore =
+        [SentryDependencyContainer.sharedInstance scopePersistentStore];
 
     self.tracker = [[SentryWatchdogTerminationTracker alloc] initWithOptions:options
                                                     watchdogTerminationLogic:logic
                                                              appStateManager:appStateManager
                                                         dispatchQueueWrapper:dispatchQueueWrapper
                                                                  fileManager:fileManager
-                                                           scopeContextStore:scopeContextStore];
+                                                        scopePersistentStore:scopeStore];
 
     [self.tracker start];
 
@@ -96,6 +96,7 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         // Sync the current context to the observer to capture context modifications that happened
         // before installation.
         [scopeObserver setContext:outerScope.contextDictionary];
+        [scopeObserver setUser:outerScope.userObject];
     }];
 
     return YES;

Sources/Sentry/SentryWatchdogTerminationTrackingIntegration.m

@@ -22,7 +22,7 @@
 @class SentryThreadWrapper;
 @class SentryThreadInspector;
 @class SentryFileIOTracker;
-@class SentryScopeContextPersistentStore;
+@class SentryScopePersistentStore;
 @class SentryOptions;
 @class SentrySessionTracker;
 @class SentryGlobalEventProcessor;
@@ -45,7 +45,7 @@
 @class SentryViewHierarchyProvider;
 @class SentryUIViewControllerPerformanceTracker;
 @class SentryWatchdogTerminationScopeObserver;
-@class SentryWatchdogTerminationContextProcessor;
+@class SentryWatchdogTerminationAttributesProcessor;
 @class SentryWatchdogTerminationBreadcrumbProcessor;
 #endif // SENTRY_UIKIT_AVAILABLE
 
@@ -109,7 +109,7 @@ SENTRY_NO_INIT
 @property (nonatomic, strong) SentryThreadInspector *threadInspector;
 @property (nonatomic, strong) SentryFileIOTracker *fileIOTracker;
 @property (nonatomic, strong) SentryCrash *crashReporter;
-@property (nonatomic, strong) SentryScopeContextPersistentStore *scopeContextPersistentStore;
+@property (nonatomic, strong) SentryScopePersistentStore *scopePersistentStore;
 @property (nonatomic, strong) SentryDebugImageProvider *debugImageProvider;
 
 - (id<SentryANRTracker>)getANRTracker:(NSTimeInterval)timeout;
@@ -142,7 +142,7 @@ SENTRY_NO_INIT
 - (SentryWatchdogTerminationBreadcrumbProcessor *)
     getWatchdogTerminationBreadcrumbProcessorWithMaxBreadcrumbs:(NSInteger)maxBreadcrumbs;
 @property (nonatomic, strong)
-    SentryWatchdogTerminationContextProcessor *watchdogTerminationContextProcessor;
+    SentryWatchdogTerminationAttributesProcessor *watchdogTerminationAttributesProcessor;
 #endif
 
 @property (nonatomic, strong) SentryGlobalEventProcessor *globalEventProcessor;

Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h

@@ -5,7 +5,7 @@
 #    import "SentryScopeObserver.h"
 
 @class SentryWatchdogTerminationBreadcrumbProcessor;
-@class SentryWatchdogTerminationContextProcessor;
+@class SentryWatchdogTerminationAttributesProcessor;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -20,7 +20,7 @@ SENTRY_NO_INIT
 
 - (instancetype)
     initWithBreadcrumbProcessor:(SentryWatchdogTerminationBreadcrumbProcessor *)breadcrumbProcessor
-               contextProcessor:(SentryWatchdogTerminationContextProcessor *)contextProcessor;
+            attributesProcessor:(SentryWatchdogTerminationAttributesProcessor *)attributesProcessor;
 
 @end
 

Sources/Sentry/include/SentryWatchdogTerminationScopeObserver.h

@@ -5,7 +5,7 @@
 @class SentryFileManager;
 @class SentryOptions;
 @class SentryWatchdogTerminationLogic;
-@class SentryScopeContextPersistentStore;
+@class SentryScopePersistentStore;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -28,7 +28,7 @@ SENTRY_NO_INIT
                 appStateManager:(SentryAppStateManager *)appStateManager
            dispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
                     fileManager:(SentryFileManager *)fileManager
-              scopeContextStore:(SentryScopeContextPersistentStore *)scopeContextStore;
+           scopePersistentStore:(SentryScopePersistentStore *)scopeStore;
 
 - (void)start;
 - (void)stop;