react-native-bugsnag

React Native Bugsnag

Easily add Bugsnag exception monitoring support to your React Native application.

Although this is not affiliated with Bugsnag directly, we do have their support.

Installation

iOS

1. Install the official iOS Bugsnag sdk into your app according to their iOS instructions.

   Ensure that Symbolication is properly setup in your project as well.

   I used the carthage way and ended up with a Bugsnag.framework file.

2. Install the React Native Bugsnag package:

rnpm install --save react-native-bugsnag

(Make sure to restart your package manager afterwards.)

1. In your AppDelegate.m file, add the following code changes:

a. Import our RNBugsnag library:

#import <RNBugsnag/RNBugsnag.h>  // Add this line.

@implementation AppDelegate
  
  // ... other code

b. Initialize RNBugsnag inside of didFinishLaunchingWithOptions:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{

  // ... other code

  [RNBugsnag init];	//initialize it

}

c. Add your BUSNAG Api Key inside the Info.Plist like so:

Add a new entry with a key of: `BUGSNAG_API_KEY` and a value of your Bugsnag API KEY ([Usually found within your project here](https://bugsnag.com/settings/)).
Opening the `Info.Plist` with a text editor your addition should look like this:

```
<key>BUGSNAG_API_KEY</key>
<string>whatever_your_api_key_is</string>
```

d. Add Bugsnag to the RNBugsnag library. I did this by dragging the Bugsnag.framework I made in step 1 to my RNBugsnag module target.

By that point you should be ok

If you still want to check if things went well,

• You should have the RNBugsnag.xcodeproj within your main project (as a direct dependency coming from ./node_modules/react-native-bugsnag/ios/RNBugsnag.xcodeproj)
• You should have $(SRCROOT)/../node_modules/react-native-bugsnag/ios/RNBugsnag within your Project-->Target-->Build Settings--> Header Search Paths.
• You should have libRNBugsnag.a linked to your project, check that on Project-->Target-->General-->Linked Frameworks and Libraries and see if you can find libRNBugsnag.a

Enjoy!

Android

1. Go to your settings.gradle and add the following lines after

   //somewhere after include ':app' add the following 2 lines
   
   include ':react-native-bugsnag'
   project(':react-native-bugsnag').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-bugsnag/android')
   

2. Go to your app.gradle and add the following line in the end:

   dependencies {
       compile fileTree(dir: 'libs', include: ['*.jar'])
       compile 'com.android.support:appcompat-v7:23.0.1'
       compile 'com.facebook.react:react-native:+'
       //...whatever code
   
       compile project(':react-native-bugsnag')	//<--Add this line
   }
   

3. Go to your manifest.xml and add the following line within the application tag replacing YOUR_API_KEY:

   <meta-data android:name="com.bugsnag.android.API_KEY" android:value="YOUR_API_KEY"/>
   

4. Go to your MainActivity.java and add the following code:

   import com.pintersudoplz.rnbugsnag.RNBugsnagPackage;
   

   and then within your getPackages add the line with the comment

   @Override
   protected List<ReactPackage> getPackages() {
       // ...whatever code
       return Arrays.<ReactPackage>asList(
           new MainReactPackage(),            
           new RNBugsnagPackage()  //add this line
       );
   }
   

Usage

Unhandled errors (Automatic dispatch):

1. Include React Native Bugsnag in your React Native app:

import Bugsnag from 'react-native-bugsnag';

1. Anywhere in the code:

Bugsnag();

Congratulations!!

At that point you have basic error reporting functionality working. Any unhandled javascript or native errors thrown will be reported to Bugsnag.

API

Things you can pass to the constructor:

• You can suppress all the outgoing Error reports to bugsnag by setting suppressDevErrors to true and passing it to the constructor, like so:

  Bugsnag({suppressDevErrors:true});

• You can set identification data for the current user while initiating BugSnag by passing the identifier object to the constructor, like so:

  Bugsnag({identifier:{userId: "aUserId", userEmail:"[e-mail]", userFullname:"aFullName"}})

Setting the identifier for the user at some other point in code:

This will let you know more details about the person that got the crash.

  Bugsnag.setIdentifier("aUserId", "aUserEmail", "userFullname");

Handled errors (Manual dispatch):

You can manually create an exception using the following command:

Bugsnag.notify("TestExceptionName", "TestExceptionReason", "error");

The third parameter is the severity of the notification, it can be one of the following:

• "error"
• "warning"
• "info"

Source maps

In order to get a readable stacktrace with the exact place the error took place all you need to do is create sourcemaps for your app, then upload them to bugsnag and then make your project of type Javascript in the bugsnag dashboard, (you do that from their Settings screen). I did that and now I get a translated stacktrace I can read.

TODO

• Configure Bugsnag from JS.
• Handle different handled exceptions in JS.
• Show line numbers (and method names?) in JS errors.
• Create some nice graphics for this README.
• Test RNPM installation process.
• Submit to js.coach and Bugsnag.
• Fully integrate with Android.