Add internal api for mutating session payload before sending (#341)

Add internal api for mutating session payload before sending

CHANGELOG.md

@@ -5,6 +5,9 @@ Changelog
 
 ### Enhancements
 
+* Add internal api for mutating session payload before sending
+  [#341](https://github.com/bugsnag/bugsnag-cocoa/pull/341)
+
 * Persist breadcrumbs on disk to allow reading upon next boot in the event of an
   uncatchable app termination.
 * Add `+[Bugsnag appDidCrashLastLaunch]` as a helper to determine if the

Source/BugsnagConfiguration.h

@@ -56,6 +56,13 @@ typedef void (^BugsnagNotifyBlock)(BugsnagCrashReport *_Nonnull report);
 typedef bool (^BugsnagBeforeSendBlock)(NSDictionary *_Nonnull rawEventData,
                                        BugsnagCrashReport *_Nonnull reports);
 
+/**
+ * A configuration block for modifying a session. Intended for internal usage only.
+ *
+ * @param sessionPayload The session about to be delivered
+ */
+typedef void(^BeforeSendSession)(NSMutableDictionary *_Nonnull sessionPayload);
+
 /**
  *  A handler for modifying data before sending it to Bugsnag
  *
@@ -126,6 +133,13 @@ BugsnagBreadcrumbs *breadcrumbs;
  */
 @property(readonly, strong, nullable)
     NSArray<BugsnagBeforeSendBlock> *beforeSendBlocks;
+
+/**
+ *  Hooks for modifying sessions before they are sent to Bugsnag. Intended for internal use only by React Native/Unity.
+ */
+@property(readonly, strong, nullable)
+NSArray<BeforeSendSession> *beforeSendSessionBlocks;
+
 /**
  *  Optional handler invoked when a crash or fatal signal occurs
  */
@@ -205,6 +219,13 @@ BugsnagBreadcrumbs *breadcrumbs;
  */
 - (void)addBeforeSendBlock:(BugsnagBeforeSendBlock _Nonnull)block;
 
+/**
+ *  Add a callback to be invoked before a session is sent to Bugsnag. Intended for internal usage only.
+ *
+ *  @param block A block which can modify the session
+ */
+- (void)addBeforeSendSession:(BeforeSendSession _Nonnull)block;
+
 /**
  * Clear all callbacks
  */

Source/BugsnagConfiguration.m

@@ -48,6 +48,7 @@ @interface BugsnagNotifier ()
 @interface BugsnagConfiguration ()
 @property(nonatomic, readwrite, strong) NSMutableArray *beforeNotifyHooks;
 @property(nonatomic, readwrite, strong) NSMutableArray *beforeSendBlocks;
+@property(nonatomic, readwrite, strong) NSMutableArray *beforeSendSessionBlocks;
 @end
 
 @implementation BugsnagConfiguration
@@ -62,6 +63,7 @@ - (id)init {
         _notifyURL = [NSURL URLWithString:BSGDefaultNotifyUrl];
         _beforeNotifyHooks = [NSMutableArray new];
         _beforeSendBlocks = [NSMutableArray new];
+        _beforeSendSessionBlocks = [NSMutableArray new];
         _notifyReleaseStages = nil;
         _breadcrumbs = [BugsnagBreadcrumbs new];
         _automaticallyCollectBreadcrumbs = YES;
@@ -106,6 +108,10 @@ - (void)addBeforeSendBlock:(BugsnagBeforeSendBlock)block {
     [(NSMutableArray *)self.beforeSendBlocks addObject:[block copy]];
 }
 
+- (void)addBeforeSendSession:(BeforeSendSession)block {
+    [(NSMutableArray *)self.beforeSendSessionBlocks addObject:[block copy]];
+}
+
 - (void)clearBeforeSendBlocks {
     [(NSMutableArray *)self.beforeSendBlocks removeAllObjects];
 }

Source/BugsnagSessionTrackingApiClient.m

@@ -41,14 +41,20 @@ - (void)deliverSessionsInStore:(BugsnagSessionFileStore *)store {
         }
         BugsnagSessionTrackingPayload *payload = [[BugsnagSessionTrackingPayload alloc] initWithSessions:sessions];
         NSUInteger sessionCount = payload.sessions.count;
+        NSMutableDictionary *data = [payload toJson];
+
+        for (BeforeSendSession cb in self.config.beforeSendSessionBlocks) {
+            cb(data);
+        }
+
         if (sessionCount > 0) {
             NSDictionary *HTTPHeaders = @{
                                           @"Bugsnag-Payload-Version": @"1.0",
                                           @"Bugsnag-API-Key": apiKey,
                                           @"Bugsnag-Sent-At": [BSG_RFC3339DateTool stringFromDate:[NSDate new]]
                                           };
             [self sendItems:sessions.count
-                withPayload:[payload toJson]
+                withPayload:data
                       toURL:sessionURL
                     headers:HTTPHeaders
                onCompletion:^(NSUInteger sentCount, BOOL success, NSError *error) {

Source/BugsnagSessionTrackingPayload.h

@@ -14,7 +14,7 @@
 
 - (instancetype)initWithSessions:(NSArray<BugsnagSession *> *)sessions;
 
-- (NSDictionary *)toJson;
+- (NSMutableDictionary *)toJson;
 
 @property NSArray<BugsnagSession *> *sessions;
 

Source/BugsnagSessionTrackingPayload.m

@@ -28,8 +28,7 @@ - (instancetype)initWithSessions:(NSArray<BugsnagSession *> *)sessions {
 }
 
 
-- (NSDictionary *)toJson {
-
+- (NSMutableDictionary *)toJson {
     NSMutableDictionary *dict = [NSMutableDictionary new];
     NSMutableArray *sessionData = [NSMutableArray new];
 
@@ -42,7 +41,7 @@ - (NSDictionary *)toJson {
     NSDictionary *systemInfo = [BSG_KSSystemInfo systemInfo];
     BSGDictSetSafeObject(dict, BSGParseAppState(systemInfo, [Bugsnag configuration].appVersion), @"app");
     BSGDictSetSafeObject(dict, BSGParseDeviceState(systemInfo), @"device");
-    return [NSDictionary dictionaryWithDictionary:dict];
+    return dict;
 }
 
 @end