Merge pull request #779 from bugsnag/next

Next release

Author: fractalwrench

Bugsnag.podspec.json

@@ -1,6 +1,6 @@
 {
   "name": "Bugsnag",
-  "version": "6.1.2",
+  "version": "6.1.3",
   "summary": "The Bugsnag crash reporting framework for Apple platforms.",
   "homepage": "https://bugsnag.com",
   "license": "MIT",
@@ -9,7 +9,7 @@
   },
   "source": {
     "git": "https://github.com/bugsnag/bugsnag-cocoa.git",
-    "tag": "v6.1.2"
+    "tag": "v6.1.3"
   },
   "frameworks": [
     "Foundation",

Bugsnag/BugsnagCrashSentry.m

@@ -30,8 +30,11 @@ - (void)install:(BugsnagConfiguration *)config
     ksCrash.introspectMemory = YES;
     ksCrash.onCrash = onCrash;
     ksCrash.maxStoredReports = BSG_MAX_STORED_REPORTS;
-    ksCrash.threadTracingEnabled = (int) config.sendThreads;
-    
+
+    // overridden elsewhere for handled errors, so we can assume that this only
+    // applies to unhandled errors
+    ksCrash.threadTracingEnabled = config.sendThreads != BSGThreadSendPolicyNever;
+
     // User reported events are *always* handled
     BSG_KSCrashType crashTypes = BSG_KSCrashTypeUserReported;
 

Bugsnag/BugsnagErrorReportSink.m

@@ -45,16 +45,11 @@ @interface BugsnagNotifier ()
 - (NSDictionary *)toDict;
 @end
 
-@interface BugsnagClient ()
-@property (nonatomic) NSString *codeBundleId;
-@end
-
 @interface BugsnagEvent ()
 - (NSDictionary *_Nonnull)toJson;
 - (BOOL)shouldBeSent;
 - (instancetype _Nonnull)initWithKSReport:(NSDictionary *_Nonnull)report;
 @property NSSet<NSString *> *redactedKeys;
-@property (nonatomic) NSString *codeBundleId;
 @end
 
 @interface BugsnagConfiguration ()
@@ -123,7 +118,6 @@ - (void)sendStoredReports:(NSDictionary <NSString *, NSDictionary *> *)ksCrashRe
     for (NSString *fileKey in keys) {
         NSDictionary *report = ksCrashReports[fileKey];
         BugsnagEvent *event = [[BugsnagEvent alloc] initWithKSReport:report];
-        event.codeBundleId = [Bugsnag client].codeBundleId;
         event.redactedKeys = configuration.redactedKeys;
 
         if ([event shouldBeSent] && [self runOnSendBlocks:configuration event:event]) {

Bugsnag/Client/BugsnagClient.m

@@ -306,6 +306,7 @@ @interface BugsnagClient ()
 @property (nonatomic, strong) NSString *lastOrientation;
 #endif
 @property NSMutableDictionary *extraRuntimeInfo;
+@property (nonatomic) BugsnagUser *user;
 @end
 
 @interface BugsnagConfiguration ()
@@ -351,6 +352,8 @@ @interface BugsnagSessionTracker ()
 
 @interface BugsnagUser ()
 - (instancetype)initWithDictionary:(NSDictionary *)dict;
+- (instancetype)initWithUserId:(NSString *)userId name:(NSString *)name emailAddress:(NSString *)emailAddress;
+- (NSDictionary *)toJson;
 @end
 
 @interface BugsnagBreadcrumbs ()
@@ -410,7 +413,7 @@ - (id)initWithConfiguration:(BugsnagConfiguration *)initConfiguration {
                                                          }];
 
         self.breadcrumbs = [[BugsnagBreadcrumbs alloc] initWithConfiguration:self.configuration];
-        
+
         // Start with a copy of the configuration metadata
         self.metadata = [[configuration metadata] deepCopy];
         // sync initial state
@@ -431,15 +434,16 @@ - (id)initWithConfiguration:(BugsnagConfiguration *)initConfiguration {
         [self.configuration.config addObserverWithBlock:observer];
         [self.state addObserverWithBlock:observer];
 
-        self.pluginClient = [[BugsnagPluginClient alloc] initWithPlugins:self.configuration.plugins];
+        self.pluginClient = [[BugsnagPluginClient alloc] initWithPlugins:self.configuration.plugins
+                                                                  client:self];
 
 #if BSG_PLATFORM_IOS
         _lastOrientation = BSGOrientationNameFromEnum([UIDevice currentDevice].orientation);
 #endif
-        BugsnagUser *user = self.configuration.user;
+        _user = self.configuration.user;
 
-        if (user.id == nil) { // populate with an autogenerated ID if no value set
-            [self setUser:[BSG_KSSystemInfo deviceAndAppHash] withEmail:user.email andName:user.name];
+        if (_user.id == nil) { // populate with an autogenerated ID if no value set
+            [self setUser:[BSG_KSSystemInfo deviceAndAppHash] withEmail:_user.email andName:_user.name];
         }
     }
     return self;
@@ -450,6 +454,15 @@ - (void)addObserverWithBlock:(BugsnagObserverBlock _Nonnull)observer {
 
     // additionally listen for metadata updates
     [self.metadata addObserverWithBlock:observer];
+
+    // sync the new observer with changes to metadata so far
+    BugsnagStateEvent *event = [[BugsnagStateEvent alloc] initWithName:kStateEventMetadata data:self.metadata];
+    observer(event);
+
+    NSDictionary *userJson = [self.user toJson];
+    observer([[BugsnagStateEvent alloc] initWithName:kStateEventUser data:userJson]);
+
+    observer([[BugsnagStateEvent alloc] initWithName:kStateEventContext data:self.context]);
 }
 
 - (void)removeObserverWithBlock:(BugsnagObserverBlock _Nonnull)observer {
@@ -563,7 +576,7 @@ - (void)start {
                selector:@selector(orientationChanged:)
                    name:UIDeviceOrientationDidChangeNotification
                  object:nil];
-    
+
     [center addObserver:self
                selector:@selector(lowMemoryWarning:)
                    name:UIApplicationDidReceiveMemoryWarningNotification
@@ -592,7 +605,7 @@ - (void)start {
     _started = YES;
     // autoDetectErrors disables all unhandled event reporting
     BOOL configuredToReportOOMs = self.configuration.autoDetectErrors && self.configuration.enabledErrorTypes.ooms;
-    
+
     // Disable if a debugger is enabled, since the development cycle of starting
     // and restarting an app is also an uncatchable kill
     BOOL noDebuggerEnabled = !bsg_ksmachisBeingTraced();
@@ -646,15 +659,15 @@ - (void)computeDidCrashLastLaunch {
         }
     }
     self.appDidCrashLastLaunch = handledCrashLastLaunch || [self.oomWatchdog didOOMLastLaunch];
-    
+
     // Ignore potential false positive OOM if previous session crashed and was
     // reported. There are two checks in place:
     //
     //     1. crashState->crashedLastLaunch: Accurate unless the crash callback crashes
     //
     //     2. crash sentinel file exists: This file is written in the event of a crash
     //        and insures against the crash callback crashing
-    
+
     if (!handledCrashLastLaunch && [self.oomWatchdog didOOMLastLaunch]) {
         [self notifyOutOfMemoryEvent];
     }
@@ -665,6 +678,7 @@ - (void)computeDidCrashLastLaunch {
 
 - (void)setCodeBundleId:(NSString *)codeBundleId {
     _codeBundleId = codeBundleId;
+    [self.state addMetadata:codeBundleId withKey:BSGKeyCodeBundleId toSection:BSGKeyApp];
     self.oomWatchdog.codeBundleId = codeBundleId;
     self.sessionTracker.codeBundleId = codeBundleId;
 }
@@ -748,7 +762,7 @@ - (void)setupConnectivityListener {
         if (connected) {
             [strongSelf flushPendingReports];
         }
-        
+
         [self addAutoBreadcrumbOfType:BSGBreadcrumbTypeState
                           withMessage:@"Connectivity changed"
                           andMetadata:@{
@@ -787,22 +801,21 @@ - (void)leaveBreadcrumbWithMessage:(NSString *_Nonnull)message
 
 - (BugsnagUser *_Nonnull)user
 {
-    NSDictionary *userInfo = [self.metadata getMetadataFromSection:BSGKeyUser];
-    return [[BugsnagUser alloc] initWithDictionary:userInfo ?: @{}];
+    return self.configuration.user;
 }
 
 - (void)setUser:(NSString *_Nullable)userId
       withEmail:(NSString *_Nullable)email
         andName:(NSString *_Nullable)name
 {
-    [self.metadata addMetadata:userId withKey:BSGKeyId    toSection:BSGKeyUser];
-    [self.metadata addMetadata:name   withKey:BSGKeyName  toSection:BSGKeyUser];
-    [self.metadata addMetadata:email  withKey:BSGKeyEmail toSection:BSGKeyUser];
+    [self.configuration setUser:userId withEmail:email andName:name];
+    NSDictionary *userJson = [_user toJson];
+    [self.state addMetadata:userJson toSection:BSGKeyUser];
 
     NSMutableDictionary *dict = [NSMutableDictionary new];
-    BSGDictInsertIfNotNil(dict, self.user.id, @"id");
-    BSGDictInsertIfNotNil(dict, self.user.email, @"email");
-    BSGDictInsertIfNotNil(dict, self.user.name, @"name");
+    BSGDictInsertIfNotNil(dict, userId, @"id");
+    BSGDictInsertIfNotNil(dict, email, @"email");
+    BSGDictInsertIfNotNil(dict, name, @"name");
     [self notifyObservers:[[BugsnagStateEvent alloc] initWithName:kStateEventUser data:dict]];
 }
 
@@ -905,7 +918,7 @@ - (void)notify:(NSException *_Nonnull)exception {
     [self notify:exception handledState:state block:nil];
 }
 
-- (void)notify:(NSException *)exception 
+- (void)notify:(NSException *)exception
          block:(BugsnagOnErrorBlock)block
 {
     BugsnagHandledState *state =
@@ -972,15 +985,14 @@ - (void)notify:(NSException *)exception
      * 4. -[BSG_KSCrash captureThreads:depth:]
      */
     int depth = (int)(BSGNotifierStackFrameCount);
-    NSArray *threads = [[BSG_KSCrash sharedInstance] captureThreads:exception depth:depth];
+
+    BOOL recordAllThreads = self.configuration.sendThreads == BSGThreadSendPolicyAlways;
+    NSArray *threads = [[BSG_KSCrash sharedInstance] captureThreads:exception
+                                                              depth:depth
+                                                   recordAllThreads:recordAllThreads];
     NSArray *errors = @[[self generateError:exception threads:threads]];
 
     BugsnagMetadata *metadata = [self.metadata deepCopy];
-    NSDictionary *deviceFields = [self.state getMetadataFromSection:BSGKeyDeviceState];
-
-    if (deviceFields) {
-        [metadata addMetadata:deviceFields toSection:BSGKeyDevice];
-    }
 
     NSDictionary *systemInfo = [BSG_KSSystemInfo systemInfo];
     BugsnagEvent *event = [[BugsnagEvent alloc] initWithApp:[self generateAppWithState:systemInfo]
@@ -1008,6 +1020,13 @@ - (void)notify:(NSException *)exception
 - (void)notifyInternal:(BugsnagEvent *_Nonnull)event
                  block:(BugsnagOnErrorBlock)block
 {
+    // enhance device information with additional metadata
+    NSDictionary *deviceFields = [self.state getMetadataFromSection:BSGKeyDeviceState];
+
+    if (deviceFields) {
+        [event.metadata addMetadata:deviceFields toSection:BSGKeyDevice];
+    }
+
     @try {
         if (block != nil && !block(event)) { // skip notifying if callback false
             return;
@@ -1158,25 +1177,25 @@ - (void)orientationChanged:(NSNotification *)notification {
         _lastOrientation = orientation;
         return;
     }
-    
+
     // We have an orientation, it's not a dupe and we have a lastOrientation.
     // Send a breadcrumb and preserve the orientation.
-    
+
     [self addAutoBreadcrumbOfType:BSGBreadcrumbTypeState
                       withMessage:BSGBreadcrumbNameForNotificationName(notification.name)
                       andMetadata:@{
                           @"from" : _lastOrientation,
                           @"to" : orientation
                       }];
-    
+
     _lastOrientation = orientation;
 }
 
 - (void)lowMemoryWarning:(NSNotification *)notif {
     [self.state addMetadata:[BSG_RFC3339DateTool stringFromDate:[NSDate date]]
                       withKey:BSEventLowMemoryWarning
                     toSection:BSGKeyDeviceState];
-     
+
     if ([[self configuration] shouldRecordBreadcrumbType:BSGBreadcrumbTypeState]) {
         [self sendBreadcrumbForNotification:notif];
     }
@@ -1231,7 +1250,7 @@ - (void)updateAutomaticBreadcrumbDetectionSettings {
                      object:nil];
         }
     }
-    
+
     // Navigation events
     if ([[self configuration] shouldRecordBreadcrumbType:BSGBreadcrumbTypeNavigation]) {
         // UI/NSTableView events
@@ -1313,7 +1332,7 @@ - (void)updateAutomaticBreadcrumbDetectionSettings {
         NSWindowDidExitFullScreenNotification
     ];
 #endif
-    
+
     // Fall-through
     return nil;
 }
@@ -1332,7 +1351,7 @@ - (void)updateAutomaticBreadcrumbDetectionSettings {
         NSControlTextDidEndEditingNotification
     ];
 #endif
-    
+
     // Fall-through
     return nil;
 }
@@ -1559,10 +1578,19 @@ - (NSArray *)collectBreadcrumbs {
     return data;
 }
 
-- (NSArray *)collectThreads {
-    int depth = (int)(BSGNotifierStackFrameCount);
+- (NSArray *)collectThreads:(BOOL)unhandled {
+    // discard the following
+    // 1. [BugsnagReactNative getPayloadInfo:resolve:reject:]
+    // 2. [BugsnagClient collectThreads:]
+    // 3. [BSG_KSCrash captureThreads:depth:unhandled:]
+    int depth = 3;
     NSException *exc = [NSException exceptionWithName:@"Bugsnag" reason:@"" userInfo:nil];
-    NSArray<BugsnagThread *> *threads = [[BSG_KSCrash sharedInstance] captureThreads:exc depth:depth];
+    BSGThreadSendPolicy sendThreads = self.configuration.sendThreads;
+    BOOL recordAllThreads = sendThreads == BSGThreadSendPolicyAlways
+            || (unhandled && sendThreads == BSGThreadSendPolicyUnhandledOnly);
+    NSArray<BugsnagThread *> *threads = [[BSG_KSCrash sharedInstance] captureThreads:exc
+                                                                               depth:depth
+                                                                    recordAllThreads:recordAllThreads];
     return [BugsnagThread serializeThreads:threads];
 }
 
@@ -1573,6 +1601,7 @@ - (void)addRuntimeVersionInfo:(NSString *)info
     if (info != nil && key != nil) {
         self.extraRuntimeInfo[key] = info;
     }
+    [self.state addMetadata:self.extraRuntimeInfo withKey:BSGKeyExtraRuntimeInfo toSection:BSGKeyDevice];
 }
 
 @end

Bugsnag/Helpers/BugsnagKeys.h

@@ -25,6 +25,7 @@ extern NSString *const BSGKeyBatteryLevel;
 extern NSString *const BSGKeyBreadcrumbs;
 extern NSString *const BSGKeyBundleVersion;
 extern NSString *const BSGKeyCharging;
+extern NSString *const BSGKeyCodeBundleId;
 extern NSString *const BSGKeyConfig;
 extern NSString *const BSGKeyContext;
 extern NSString *const BSGKeyCppException;
@@ -41,6 +42,7 @@ extern NSString *const BSGKeyException;
 extern NSString *const BSGKeyExceptionName;
 extern NSString *const BSGKeyExceptions;
 extern NSString *const BSGKeyExecutableName;
+extern NSString *const BSGKeyExtraRuntimeInfo;
 extern NSString *const BSGKeyFrameAddrFormat;
 extern NSString *const BSGKeyFrameAddress;
 extern NSString *const BSGKeyGroupingHash;

Bugsnag/Helpers/BugsnagKeys.m

@@ -21,6 +21,7 @@
 NSString *const BSGKeyBreadcrumbs = @"breadcrumbs";
 NSString *const BSGKeyBundleVersion = @"bundleVersion";
 NSString *const BSGKeyCharging = @"charging";
+NSString *const BSGKeyCodeBundleId = @"codeBundleId";
 NSString *const BSGKeyConfig = @"config";
 NSString *const BSGKeyContext = @"context";
 NSString *const BSGKeyCppException = @"cpp_exception";
@@ -37,6 +38,7 @@
 NSString *const BSGKeyExceptionName = @"exception_name";
 NSString *const BSGKeyExceptions = @"exceptions";
 NSString *const BSGKeyExecutableName = @"CFBundleExecutable";
+NSString *const BSGKeyExtraRuntimeInfo = @"extraRuntimeInfo";
 NSString *const BSGKeyFrameAddrFormat = @"0x%lx";
 NSString *const BSGKeyFrameAddress = @"frameAddress";
 NSString *const BSGKeyGroupingHash = @"groupingHash";

Bugsnag/KSCrash/Source/KSCrash/Recording/BSG_KSCrash.h

@@ -115,9 +115,13 @@
  *
  * @param exc the exception to record
  * @param depth the number of frames to discard from the main thread's stacktrace
+ * @param recordAllThreads whether all threads should be recorded or just the
+ * main thread's stacktrace
  * @return an array of BugsnagThread
  */
-- (NSArray<BugsnagThread *> *)captureThreads:(NSException *)exc depth:(int)depth;
+- (NSArray<BugsnagThread *> *)captureThreads:(NSException *)exc
+                                       depth:(int)depth
+                            recordAllThreads:(BOOL)recordAllThreads;
 
 /**
  * Collects information about the application's foreground state (duration in foreground/background)
@@ -132,9 +136,8 @@
 
 /**
 * The methodology used for tracing threads.
-* The value will be equal to an enum value from BSGThreadSendPolicy
  */
-@property(nonatomic, readwrite, assign) int threadTracingEnabled;
+@property(nonatomic, readwrite, assign) BOOL threadTracingEnabled;
 
 /**
  * If YES, binary images will be collected for each report.