buglife / react-native-buglife

A React Native wrapper for Buglife

react-native-buglife

React Native wrapper for Buglife iOS and Buglife Android.

Installation

1. npm install react-native-buglife --save
2. react-native link to link the native libraries to the react wrappers.

If you intend to ship with Buglife to TestFlight or the iOS App Store, you'll need to add NSPhotoLibraryUsageDescription to your Info.plist. See this article.

Configuration

Android native configuration

1. Open your app's build.gradle, and make sure the compileSdkVersion is at least 26, and minSdkVersion is at least 16.

2. If you are not prompted to do so by Android Studio, add the following maven repository to your project's build.gradle buildscript section:

   maven {
       url 'https://maven.google.com/'
       name 'Google'
   }
   

   eg.

   buildscript {
       repositories {
           jcenter()
           maven {
               url 'https://maven.google.com/'
               name 'Google'
           }
       }
       ...
   }

3. Add the following lines to the end of the onCreate() method in your main Application subclass. (If your app doesn't have one already, create an Application subclass and declare it in AndroidManifest.xml.)

   Buglife.initWithEmail(this, "[email protected]");
   Buglife.setInvocationMethod(InvocationMethod.SCREENSHOT);

   Be sure to replace [email protected] with your own email address, as bug reports will be sent to this address.

iOS native configuration

1. Open AppDelegate.m and add the following import statement below the others:

   #import "Buglife.h"

2. Add the following to the end of the application:didFinishLaunchingWithOptions: method in AppDelegate.m:

   [[Buglife sharedBuglife] startWithEmail:@"[email protected]"];
   [[Buglife sharedBuglife] setInvocationOptions:LIFEInvocationOptionsScreenshot];

3. Add the NSPhotoLibraryUsageDescription key to your iOS app's Info.plist if it doesn't have it already. See the Buglife iOS App Store documentation.

Javascript configuration

Import & initialize Buglife within App.js:

var Buglife = require('react-native-buglife');

Build & run

Build & run on a device, then take a screenshot to invoke the bug reporter! Submit your first bug report, and it'll show up in your email.

Customization

User identification

You may want to add the reporter's email address or other account identifier to your bug reports. You can do this with

// Set an email address
Buglife.setUserEmail("[email protected]");

// Set a user identifier
Buglife.setUserIdentifier("account name");

Attachments

Your application can include custom JSON attachments with each bug report. For example, to add an attachment solely to the next invocation of the bug reporter:

var myData = { }; // This should be a JSON object with your data
Buglife.addAttachmentWithJSON(myData, "MyData.json");

It’s also possible to add a String attachment:

var myText = "great detailed log"; // This should be a String object with your data
Buglife.addAttachmentWithString(myText, "MyText.text");

In some cases, you may wish to add an attachment on every invocation of the bug reporter; You can do so by subscribing to the BuglifeAttachmentRequest event:

import { NativeModules, NativeEventEmitter } from 'react-native';

const eventEmitter = new NativeEventEmitter(NativeModules.RNBuglife);

eventEmitter.addListener(Buglife.BuglifeAttachmentRequest, () => {
  var appState = {"awesomeness": "Insanely awesome", "volume": 11};
  Buglife.addAttachmentWithJSON(appState, "AppState.json");
});

For advanced usage & features (customization, user identification, etc), check out the official Buglife documentation.

react-native-buglife's Issues

Crash when setting shake invocation

http://crashes.to/s/c4ec0bcd1b7

Reported by @oferRounds. This appears to be caused by React Native calling Buglife setters off the main thread, which Buglife Android isn't currently designed to support. Working on a fix for this currently.

iOS at runtime - dyld: Libray not loaded: @rpath/Buglife.framework/Buglife

I had to follow these steps to overcome the issue. Not sure if this can be automated but it should be documented (unless maybe if it is only required on legacy/already setup projects)

[question]: Android support

Hi,

Do you have Android support on the roadmap?

Feature request: include JS logs

Could be possible to add?

Question: does RN-buglife supports the latest buglife iOS/Android versions?

i.e., can we bump the buglife dependencies?

appcompat dependency

Encountered the following errors while compiling. I wasn't able to add appcompat V27 to the package dependency because RN Android default compile SDK version is 23. Is V27 really necessary for the package to work?

Error:Failed to resolve: com.android.support:appcompat-v7:27.0.0
Error:Failed to resolve: com.android.support:design:27.0.0
Error:Failed to resolve: com.android.support:support-dynamic-animation:27.0.0

On iOS, apps require Info.plist to be updated to with NSPhotoLibraryUsageDescription

I tried to publish a build but received an email from Apple prompting me to specify how we use pictures.

I quickly realized it was due to Buglife (our app does not use any photo API).

It'd be nice to add a recipe in the README.

Question: can the Buglife report shown per button-tap?

That is, in addition to have it shown on shake

iOS - Bundling an app for App Store does not work

My build dev and local deployment build using fastlane work just great now but building for the Appstore fails.

error: exportArchive: exportOptionsPlist error for key 'method': expected one of {}, but found app-store

Error Domain=IDEFoundationErrorDomain Code=1 "exportOptionsPlist error for key 'method': expected one of {}, but found app-store" UserInfo={NSLocalizedDescription=exportOptionsPlist error for key 'method': expected one of {}, but found app-store}

** EXPORT FAILED **

This issue seems to explain that it comes from external libraries overriding build options. I guess there is something wrong with React-Native-Buglife.

Missing LIFEAlertAction.h file after iOS installation

Title says it all:

Android reports shown (partly) as iOS

See here. Happened since we moved to Buglife for React Native

Example:
http://buglife.com/r/bob-a2da90d4-af10-4d48-9b8e-c0c4183b582e-test-881453

Notice the combination of iOS 9 + OnePlus

Import issue while installing for Android

Small issue that was an easy fix for me: the imports in my main Application file where not right. I needed to change from:

to:

App not launching after integration

Hi Buglife,

Getting this error after integrating the RN library. Any idea?
Thanks!

dyld: Library not loaded: @rpath/Buglife.framework/Buglife
  Referenced from: /var/containers/Bundle/Application/DA75F366-6311-4B13-9522-1CA7DB66AE6E/Bob.app/Bob
  Reason: image not found