Fix possible release stage mismatch between sessions and error reports (#260)

Author: kattrali

CHANGELOG.md

@@ -3,11 +3,34 @@ Changelog
 
 ## 2.X.X (TBD)
 
+This release simplies the installation and quick setup process to do all
+configuration in JavaScript, provided that React Native is the primary way to
+interact with your app (rather than having React Native components as a part of
+a larger native app). [See the integration guide updated configuration
+instructions](https://docs.bugsnag.com/platforms/react-native/#basic-configuration).
+
+For applications using React Native to serve a few components (but not the whole
+app), there is a new [Native integration
+guide](https://docs.bugsnag.com/platforms/react-native/native-integration-guide/)
+with additional configuration steps to ensure every crash is captured and
+reported.
+
 ### Bug fixes
 
+* Fix possible mismatch between session release stage and error report release
+  stage, which could result in inconsistent crash rates on the Releases
+  dashboard as a session was assigned to an incorrect release stage.
+  [#260](https://github.com/bugsnag/bugsnag-react-native/issues/260)
+
 * (android) Address javac compiler warnings and intellij inspections
   [#250](https://github.com/bugsnag/bugsnag-react-native/issues/250)
 
+* (cocoa) Upgrade bugsnag-cocoa to v5.16.2:
+  * Fix a regression in session tracking which caused the first session HTTP
+    request to be delivered on the calling thread when automatic session tracking
+    is enabled
+    [#295](https://github.com/bugsnag/bugsnag-cocoa/pull/295)
+
 ## 2.10.0 (2018-07-03)
 
 This release alters the behaviour of the notifier to track sessions automatically.

android/src/main/java/com/bugsnag/BugsnagReactNative.java

@@ -46,14 +46,23 @@ public static ReactPackage getPackage() {
   }
 
   public static Client start(Context context) {
-    return Bugsnag.init(context);
+    Client client = Bugsnag.init(context);
+    // The first session starts during JS initialization
+    // Applications which have specific components in RN instead of the primary
+    // way to interact with the application should instead leverage startSession
+    // manually.
+    client.setAutoCaptureSessions(false);
+    return client;
   }
 
   public static Client startWithApiKey(Context context, String APIKey) {
-    return Bugsnag.init(context, APIKey);
+    Client client = Bugsnag.init(context, APIKey);
+    client.setAutoCaptureSessions(false);
+    return client;
   }
 
   public static Client startWithConfiguration(Context context, Configuration config) {
+    config.setAutoCaptureSessions(false);
     return Bugsnag.init(context, config);
   }
 
@@ -267,10 +276,11 @@ private void configureRuntimeOptions(Client client, ReadableMap options) {
       if (options.hasKey("autoCaptureSessions")) {
           boolean autoCapture = options.getBoolean("autoCaptureSessions");
           config.setAutoCaptureSessions(autoCapture);
-          Activity activity = getCurrentActivity();
-
-          if (activity != null) {
-              client.startFirstSession(getCurrentActivity());
+          if (autoCapture) {
+              // The launch event session is skipped because autoCaptureSessions
+              // was not set when Bugsnag was first initialized. Manually sending a
+              // session to compensate.
+              client.startSession();
           }
       }
   }

cocoa/BugsnagReactNative.m

@@ -131,6 +131,11 @@ + (void)startWithConfiguration:(BugsnagConfiguration *)config {
     if (config.apiKey.length == 0)
         config.apiKey = [[NSBundle mainBundle] objectForInfoDictionaryKey:BSGInfoPlistKey];
 
+    // The first session starts during JS initialization
+    // Applications which have specific components in RN instead of the primary
+    // way to interact with the application should instead leverage startSession
+    // manually.
+    config.shouldAutoCaptureSessions = NO;
     [Bugsnag startBugsnagWithConfiguration:config];
 }
 
@@ -230,6 +235,7 @@ + (void)startWithConfiguration:(BugsnagConfiguration *)config {
     NSString *sessionURLPath = [RCTConvert NSString:options[@"sessionsEndpoint"]];
     NSString *appVersion = [RCTConvert NSString:options[@"appVersion"]];
     NSString *codeBundleId = [RCTConvert NSString:options[@"codeBundleId"]];
+
     BugsnagConfiguration* config = [Bugsnag bugsnagStarted] ? [Bugsnag configuration] : [BugsnagConfiguration new];
 
     if (apiKey.length > 0) {
@@ -267,6 +273,12 @@ + (void)startWithConfiguration:(BugsnagConfiguration *)config {
         [Bugsnag startBugsnagWithConfiguration:config];
     }
     [self setNotifierDetails:[RCTConvert NSString:options[@"version"]]];
+    if (config.shouldAutoCaptureSessions) {
+        // The launch event session is skipped because shouldAutoCaptureSessions
+        // was not set when Bugsnag was first initialized. Manually sending a
+        // session to compensate.
+        [Bugsnag startSession];
+    }
 }
 
 - (void)setNotifierDetails:(NSString *)packageVersion {

cocoa/vendor/bugsnag-cocoa/Source/BugsnagConfiguration.h

@@ -139,6 +139,8 @@ BugsnagBreadcrumbs *breadcrumbs;
 
 /**
  * Determines whether app sessions should be tracked automatically. By default this value is true.
+ * If this value is updated after +[Bugsnag start] is called, only subsequent automatic sessions
+ * will be captured.
  */
 @property BOOL shouldAutoCaptureSessions;
 

cocoa/vendor/bugsnag-cocoa/Source/BugsnagConfiguration.m

@@ -218,23 +218,6 @@ - (void)setApiKey:(NSString *)apiKey {
     }
 }
 
-@synthesize shouldAutoCaptureSessions = _shouldAutoCaptureSessions;
-
-- (BOOL)shouldAutoCaptureSessions {
-    return _shouldAutoCaptureSessions;
-}
-
-- (void)setShouldAutoCaptureSessions:(BOOL)shouldAutoCaptureSessions {
-    @synchronized (self) {
-        _shouldAutoCaptureSessions = shouldAutoCaptureSessions;
-
-        if (shouldAutoCaptureSessions) { // track any existing sessions
-            BugsnagSessionTracker *sessionTracker = [Bugsnag notifier].sessionTracker;
-            [sessionTracker onAutoCaptureEnabled];
-        }
-    }
-}
-
 - (NSDictionary *)errorApiHeaders {
     return @{
              kHeaderApiPayloadVersion: @"4.0",

cocoa/vendor/bugsnag-cocoa/Source/BugsnagCrashReport.m

@@ -242,8 +242,8 @@ - (instancetype)initWithKSReport:(NSDictionary *)report {
         _context = BSGParseContext(report, _metaData);
         _deviceState = BSGParseDeviceState(report);
         _device = BSGParseDevice(report);
-        _app = BSGParseApp(report[BSGKeySystem]);
-        _appState = BSGParseAppState(report[BSGKeySystem]);
+        _app = BSGParseApp(report);
+        _appState = BSGParseAppState(report[BSGKeySystem], [report valueForKeyPath:@"user.config.appVersion"]);
         _groupingHash = BSGParseGroupingHash(report, _metaData);
         _overrides = [report valueForKeyPath:@"user.overrides"];
         _customException = BSGParseCustomException(report, [_errorClass copy],

cocoa/vendor/bugsnag-cocoa/Source/BugsnagFileStore.h

@@ -67,8 +67,7 @@
 - (NSMutableDictionary *)readFile:(NSString *)path
                             error:(NSError *__autoreleasing *)error;
 
-+ (NSString *)findReportStorePath:(NSString *)customDirectory
-                       bundleName:(NSString *)bundleName;
++ (NSString *)findReportStorePath:(NSString *)customDirectory;
 
 - (NSString *)fileIdFromFilename:(NSString *)filename;
 @end

cocoa/vendor/bugsnag-cocoa/Source/BugsnagFileStore.m

@@ -180,9 +180,9 @@ - (void)deleteFileWithId:(NSString *)fileId {
     }
 }
 
-+ (NSString *)findReportStorePath:(NSString *)customDirectory
-                       bundleName:(NSString *)bundleName {
++ (NSString *)findReportStorePath:(NSString *)customDirectory  {
 
+    NSString *bundleName = [[NSBundle mainBundle] infoDictionary][@"CFBundleName"];
     NSArray *directories = NSSearchPathForDirectoriesInDomains(
             NSCachesDirectory, NSUserDomainMask, YES);
     if ([directories count] == 0) {

cocoa/vendor/bugsnag-cocoa/Source/BugsnagKSCrashSysInfoParser.h

@@ -10,5 +10,5 @@
 
 NSDictionary *_Nonnull BSGParseDevice(NSDictionary *_Nonnull report);
 NSDictionary *_Nonnull BSGParseApp(NSDictionary *_Nonnull report);
-NSDictionary *_Nonnull BSGParseAppState(NSDictionary *_Nonnull report);
+NSDictionary *_Nonnull BSGParseAppState(NSDictionary *_Nonnull report, NSString *_Nullable preferredVersion);
 NSDictionary *_Nonnull BSGParseDeviceState(NSDictionary *_Nonnull report);

cocoa/vendor/bugsnag-cocoa/Source/BugsnagKSCrashSysInfoParser.m

@@ -61,9 +61,11 @@
 }
 
 NSDictionary *BSGParseApp(NSDictionary *report) {
+    NSDictionary *system = report[BSGKeySystem];
+
     NSMutableDictionary *appState = [NSMutableDictionary dictionary];
 
-    NSDictionary *stats = report[@"application_stats"];
+    NSDictionary *stats = system[@"application_stats"];
 
     NSInteger activeTimeSinceLaunch =
     [stats[@"active_time_since_launch"] doubleValue] * 1000.0;
@@ -73,23 +75,25 @@
     BSGDictSetSafeObject(appState, @(activeTimeSinceLaunch),
                          @"durationInForeground");
 
-    BSGDictSetSafeObject(appState, report[BSGKeyExecutableName], BSGKeyName);
+    BSGDictSetSafeObject(appState, system[BSGKeyExecutableName], BSGKeyName);
     BSGDictSetSafeObject(appState,
                          @(activeTimeSinceLaunch + backgroundTimeSinceLaunch),
                          @"duration");
     BSGDictSetSafeObject(appState, stats[@"application_in_foreground"],
                          @"inForeground");
-    BSGDictSetSafeObject(appState, report[@"CFBundleIdentifier"], BSGKeyId);
+    BSGDictSetSafeObject(appState, system[@"CFBundleIdentifier"], BSGKeyId);
     return appState;
 }
 
-NSDictionary *BSGParseAppState(NSDictionary *report) {
+NSDictionary *BSGParseAppState(NSDictionary *report, NSString *preferredVersion) {
     NSMutableDictionary *app = [NSMutableDictionary dictionary];
 
+    NSString *version = preferredVersion ?: report[@"CFBundleShortVersionString"];
+
     BSGDictSetSafeObject(app, report[@"CFBundleVersion"], @"bundleVersion");
     BSGDictSetSafeObject(app, [Bugsnag configuration].releaseStage,
                          BSGKeyReleaseStage);
-    BSGDictSetSafeObject(app, report[@"CFBundleShortVersionString"], BSGKeyVersion);
+    BSGDictSetSafeObject(app, version, BSGKeyVersion);
 
     BSGDictSetSafeObject(app, [Bugsnag configuration].codeBundleId, @"codeBundleId");