Next release (#351)

Next release

Author: fractalwrench

CHANGELOG.md

@@ -1,7 +1,10 @@
 Changelog
 =========
 
-## TBD
+## 2.18.0 (2019-05-08)
+
+* Collect version information in device.runtimeVersions
+[#345](https://github.com/bugsnag/bugsnag-react-native/pull/345)
 
 Run checkstyle and lint on Android code, address existing violations
 [#452](https://github.com/bugsnag/bugsnag-react-native/pull/336)

README.md

@@ -1,5 +1,5 @@
 # Bugsnag exception reporter for React Native
-[![Documentation](https://img.shields.io/badge/documentation-2.17.1-blue.svg)](http://docs.bugsnag.com/platforms/react-native/)
+[![Documentation](https://img.shields.io/badge/documentation-2.18.0-blue.svg)](http://docs.bugsnag.com/platforms/react-native/)
 
 Automatic [React Native crash reporting](https://www.bugsnag.com/platforms/react-native-error-reporting/) with Bugsnag helps you detect both native OS and JavaScript errors in your React Native apps.
 

android/build.gradle

@@ -12,7 +12,7 @@ android {
         minSdkVersion safeExtGet('minSdkVersion', 16)
         targetSdkVersion safeExtGet('targetSdkVersion', 26)
         versionCode 4
-        versionName '2.17.1'
+        versionName '2.18.0'
         consumerProguardFiles 'proguard-rules.pro'
     }
     lintOptions {
@@ -23,7 +23,7 @@ android {
 }
 
 dependencies {
-    compile 'com.bugsnag:bugsnag-android:4.13.0'
+    compile 'com.bugsnag:bugsnag-android:4.14.0'
     compile 'com.facebook.react:react-native:+'
 }
 
@@ -39,4 +39,4 @@ task("checkstyle", type: Checkstyle) {
     include "**/*.java"
     exclude "**/external/**/*.java"
     classpath = files()
-}
+}

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

@@ -4,6 +4,7 @@
 import com.bugsnag.android.Bugsnag;
 import com.bugsnag.android.Client;
 import com.bugsnag.android.Configuration;
+import com.bugsnag.android.InternalHooks;
 
 import android.content.Context;
 
@@ -119,6 +120,7 @@ public void startWithOptions(ReadableMap options) {
         libraryVersion = options.getString("version");
         bugsnagAndroidVersion = client.getClass().getPackage().getSpecificationVersion();
         configureRuntimeOptions(client, options);
+        InternalHooks.configureClient(client);
 
         logger.info(String.format("Initialized Bugsnag React Native %s/Android %s",
                 libraryVersion,

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

@@ -0,0 +1,60 @@
+package com.bugsnag;
+
+import com.facebook.react.modules.systeminfo.ReactNativeVersion;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class RuntimeVersions {
+
+    /**
+     * Adds information about the react native version to a device dictionary
+     * 
+     * @param device the device dictionary
+     */
+    public static void addRuntimeVersions(Map<String, Object> device) {
+        @SuppressWarnings("unchecked") // ignore type erasure when casting Map
+        Map<String, Object> runtimeVersions = (Map<String, Object>) device.get("runtimeVersions");
+
+        if (runtimeVersions == null) {
+            runtimeVersions = new HashMap<String, Object>();
+            device.put("runtimeVersions", runtimeVersions);
+        }
+        runtimeVersions.put("reactNative", findReactNativeVersion());
+    }
+
+    // see https://github.com/facebook/react-native/blob/6df2edeb2a33d529e4b13a5b6767f300d08aeb0a/scripts/bump-oss-version.js
+    private static String findReactNativeVersion() {
+        StringBuilder sb = new StringBuilder();
+
+        String major = getStringSafe("major", ReactNativeVersion.VERSION);
+        if (major != null) {
+            sb.append(major);
+            sb.append(".");
+        }
+
+        String minor = getStringSafe("minor", ReactNativeVersion.VERSION);
+        if (minor != null) {
+            sb.append(minor);
+            sb.append(".");
+        }
+
+        String patch = getStringSafe("patch", ReactNativeVersion.VERSION);
+        if (patch != null) {
+            sb.append(patch);
+        }
+
+        String prerelease = getStringSafe("prerelease", ReactNativeVersion.VERSION);
+        if (prerelease != null) {
+            sb.append("-");
+            sb.append(prerelease);
+        }
+        return sb.toString();
+    }
+
+    private static String getStringSafe(String key, Map<String, Object> map) {
+        Object obj = map.get(key);
+        return (obj != null) ? obj.toString() : null;
+    }
+}

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

@@ -0,0 +1,26 @@
+package com.bugsnag.android;
+
+import com.bugsnag.RuntimeVersions;
+
+public class InternalHooks {
+
+    /**
+     * Configures the bugsnag client by hooking into package-visible APIs within bugsnag-android
+     */
+    public static void configureClient(Client client) {
+        client.getConfig().addBeforeSendSession(new BeforeSendSession() {
+            @Override
+            public void beforeSendSession(SessionTrackingPayload payload) {
+                RuntimeVersions.addRuntimeVersions(payload.getDevice());
+            }
+        });
+
+        client.getConfig().beforeSend(new BeforeSend() {
+            @Override
+            public boolean run(Report report) {
+                RuntimeVersions.addRuntimeVersions(report.getError().getDeviceData());
+                return true;
+            }
+        });
+    }
+}

cocoa/BugsnagReactNative.m

@@ -1,6 +1,7 @@
 #import "Bugsnag.h"
 #import "BSG_KSCrashC.h"
 #import "BugsnagReactNative.h"
+#import "RCTVersion.h"
 #import <React/RCTConvert.h>
 
 NSString *const BSGInfoPlistKey = @"BugsnagAPIKey";
@@ -271,6 +272,23 @@ + (void)startWithConfiguration:(BugsnagConfiguration *)config {
     config.shouldAutoCaptureSessions = [RCTConvert BOOL:options[@"autoCaptureSessions"]];
     config.automaticallyCollectBreadcrumbs = [RCTConvert BOOL:options[@"automaticallyCollectBreadcrumbs"]];
 
+    [config addBeforeSendSession:^void(NSMutableDictionary *_Nonnull data) {
+        data[@"device"] = [self addDeviceRuntimeVersion:data[@"device"]
+                                     reactNativeVersion:[self findReactNativeVersion]];
+    }];
+
+    [config addBeforeSendBlock:^bool(NSDictionary *_Nonnull rawEventData,
+                                     BugsnagCrashReport *_Nonnull report) {
+        NSString *reactNativeVersion = report.metaData[@"_bugsnag"][@"reactNativeVersion"];
+        if (reactNativeVersion != nil) {
+            report.device = [self addDeviceRuntimeVersion:report.device reactNativeVersion:reactNativeVersion];
+        }
+        report.metaData = [self removeRuntimeVersionFromMetaData:report];
+
+        return !([report.errorClass hasPrefix:@"RCTFatalException"]
+                 && [report.errorMessage hasPrefix:@"Unhandled JS Exception"]);
+    }];
+
     if (notifyURLPath.length > 0) {
         [config setEndpointsForNotify:notifyURLPath
                              sessions:sessionURLPath];
@@ -299,6 +317,68 @@ + (void)startWithConfiguration:(BugsnagConfiguration *)config {
         // session to compensate.
         [Bugsnag resumeSession];
     }
+    [self addRuntimeVersionToMetaData:config];
+}
+
+/**
+ * Stores runtime version info in a metadata tab (it will be moved to a
+ * different payload location before sending)
+ */
+- (void)addRuntimeVersionToMetaData:(BugsnagConfiguration *)config {
+    [config.metaData addAttribute:@"reactNativeVersion"
+                        withValue:[self findReactNativeVersion]
+                    toTabWithName:@"_bugsnag"];
+}
+
+- (NSDictionary *)removeRuntimeVersionFromMetaData:(BugsnagCrashReport *)report {
+    NSMutableDictionary *metadata = report.metaData.mutableCopy;
+    metadata[@"_bugsnag"] = nil;
+    return metadata;
+}
+
+- (NSDictionary *)addDeviceRuntimeVersion:(NSDictionary *)device
+                       reactNativeVersion:(NSString *)reactNativeVersion {
+    NSMutableDictionary *copy = [device mutableCopy];
+    NSMutableDictionary *runtimeVersions = [copy[@"runtimeVersions"] mutableCopy];
+
+    if (runtimeVersions == nil) {
+        runtimeVersions = [NSMutableDictionary new];
+    }
+    runtimeVersions[@"reactNative"] = reactNativeVersion;
+    copy[@"runtimeVersions"] = runtimeVersions;
+    return copy;
+}
+
+// see https://github.com/facebook/react-native/blob/6df2edeb2a33d529e4b13a5b6767f300d08aeb0a/scripts/bump-oss-version.js
+- (NSString *)findReactNativeVersion {
+    static dispatch_once_t onceToken;
+    static NSString *BSGReactNativeVersion = nil;
+    dispatch_once(&onceToken, ^{
+        NSDictionary *versionMap = RCTGetReactNativeVersion();
+        NSNumber *major = versionMap[@"major"];
+        NSNumber *minor = versionMap[@"minor"];
+        NSNumber *patch = versionMap[@"patch"];
+        NSString *prerelease = versionMap[@"prerelease"];
+        NSMutableString *versionString = [NSMutableString new];
+
+        if (![major isEqual:[NSNull null]]) {
+            [versionString appendString:[major stringValue]];
+            [versionString appendString:@"."];
+        }
+        if (![minor isEqual:[NSNull null]]) {
+            [versionString appendString:[minor stringValue]];
+            [versionString appendString:@"."];
+        }
+        if (![patch isEqual:[NSNull null]]) {
+            [versionString appendString:[patch stringValue]];
+        }
+        if (![prerelease isEqual:[NSNull null]]) {
+            [versionString appendString:@"-"];
+            [versionString appendString:prerelease];
+        }
+        BSGReactNativeVersion = [NSString stringWithString:versionString];
+    });
+    return BSGReactNativeVersion;
 }
 
 - (void)setNotifierDetails:(NSString *)packageVersion {

cocoa/vendor/bugsnag-cocoa/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
  */

cocoa/vendor/bugsnag-cocoa/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];
 }

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

@@ -118,7 +118,12 @@
     BSGDictSetSafeObject(deviceState, report[@"machine"], @"model");
     BSGDictSetSafeObject(deviceState, report[@"system_name"], @"osName");
     BSGDictSetSafeObject(deviceState, report[@"system_version"], @"osVersion");
-    BSGDictSetSafeObject(deviceState, report[@"os_version"], @"osBuild");
+
+    NSMutableDictionary *runtimeVersions = [NSMutableDictionary new];
+    BSGDictSetSafeObject(runtimeVersions, report[@"os_version"], @"osBuild");
+    BSGDictSetSafeObject(runtimeVersions, report[@"clang_version"], @"clangVersion");
+    BSGDictSetSafeObject(deviceState, runtimeVersions, @"runtimeVersions");
+
     BSGDictSetSafeObject(deviceState, @(PLATFORM_WORD_SIZE), @"wordSize");
     BSGDictSetSafeObject(deviceState, @"Apple", @"manufacturer");
     BSGDictSetSafeObject(deviceState, report[@"jailbroken"], @"jailbroken");