@bugfender/rn-bugfender 1.1.5

package/android/src/main/java/com/bugfender/react/RNBugfenderPackage.java

@@ -0,0 +1,29 @@
+package com.bugfender.react;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+import com.facebook.react.ReactPackage;
+import com.facebook.react.bridge.NativeModule;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.uimanager.ViewManager;
+import com.facebook.react.bridge.JavaScriptModule;
+
+public class RNBugfenderPackage implements ReactPackage {
+
+    @Override
+    public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
+      return Arrays.<NativeModule>asList(new RNBugfenderModule(reactContext));
+    }
+
+    // Deprecated from RN 0.47
+    public List<Class<? extends JavaScriptModule>> createJSModules() {
+      return Collections.emptyList();
+    }
+
+    @Override
+    public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
+      return Collections.emptyList();
+    }
+}

package/bugfender.js

@@ -0,0 +1,217 @@
+import {
+  NativeModules,
+  Platform
+} from 'react-native';
+
+var Bugfender = NativeModules.RNBugfender;
+
+export default {
+
+  /**
+   * @typedef {string} LogLevel
+   * @readonly
+   * @enum {LogLevel}
+   */
+  LogLevel: {DEBUG: "Debug", WARNING: "Warning", ERROR: "Error"},
+
+  /**
+   * Initialize the Bugfender SDK with a specific application token.
+   */
+  init: (token, debug = true) => {
+    // Library initialization
+    Platform.OS === 'ios' ? Bugfender.activateLogger(token) : Bugfender.init(token, debug)
+  },
+
+  /**
+   * Sets the URL of the API
+   *
+   * Usage of this function is not necessary in the general use case. Please use exclusively when
+   * directed from technical support. This method must be called before Bugfender.init().
+   * @param {string} url - base URL of the Bugfender's dashboard
+   */
+  setApiUrl: apiUrl => Bugfender.setApiUrl(apiUrl),
+
+  /**
+   * Sets the URL of the Bugfender Dashboard
+   *
+   * Usage of this function is not necessary in the general use case. Please use exclusively when
+   * directed from technical support. This method must be called before Bugfender.init().
+   * @param {string} url - base URL of the Bugfender's dashboard
+   */
+  setBaseUrl: baseUrl => Bugfender.setBaseUrl(baseUrl),
+
+  /**
+   * Sets the name for the device. If the Device Name is not set, then the platform standard device name will be automatically sent
+   *
+   * @note This method has to be called prior to activate logger. Otherwise, an exception will be thrown
+   * @param {string} deviceName - Device name that will be send to Bugfender.
+   */
+  overrideDeviceName: value => Bugfender.overrideDeviceName(value),
+
+  /**
+   * Synchronizes all logs and issues with the server all the time, regardless if this device is enabled or not.
+   *
+   * Logs and issues are synchronized continuously while forceEnabled is active.
+   *
+   * @param {boolean} enabled - Whether logs and issues should be sent regardless of the Bugfender Console settings.
+   */
+  setForceEnabled: value => Bugfender.setForceEnabled(value),
+
+  /**
+   * Set the maximum size to store local log files.
+   *
+   * By default, the limit is 5 MB.
+   *
+   * @param {number} sizeInBytes Maximum size in bytes. Range accepted is from 1 byte to 50 MB. If the value provided is outside this range, it will be set to 50 MB.
+   */
+  setMaximumLocalStorageSize: sizeInBytes => Bugfender.setMaximumLocalStorageSize(sizeInBytes),
+
+  /**
+   * Remove a device detail.
+   *
+   * @param {string} key - key.
+   */
+  removeDeviceKey: key => Bugfender.removeDeviceKey(key),
+
+  /**
+   * Logs all logs written via Logcat.
+   */
+  enableLogcatLogging: () => Bugfender.enableLogcatLogging(),
+
+  /**
+   * Enable crash reporting tool functionality
+   */
+  enableCrashReporting: () => Bugfender.enableCrashReporting(),
+
+  /**
+   * Logs all actions performed and screen changes in the application, such as button touches, etc...
+   */
+  enableUIEventLogging: () => Bugfender.enableUIEventLogging(),
+
+  /**
+   * Sets a device detail with boolean type.
+   *
+   * @param {string} key - key.
+   * @param {boolean} value - A boolean value.
+   */
+  setDeviceBoolean: (key, value) => Bugfender.setDeviceBoolean(key, value),
+
+  /**
+   * Sets a device detail with string type.
+   *
+   * @param {string} key - key.
+   * @param {string} value - A string value.
+   */
+  setDeviceString: (key, value) => Bugfender.setDeviceString(key, value),
+
+  /**
+   * Sets a device detail with integer type.
+   *
+   * @param {string} key - key.
+   * @param {number} value - A integer value.
+   */
+  setDeviceInteger: (key, value) => Bugfender.setDeviceInteger(key, value),
+
+  /**
+   * Sets a device detail with double type.
+   *
+   * @param {string} key - key.
+   * @param {number} value - A double value.
+   */
+  setDeviceFloat: (key, value) => Bugfender.setDeviceFloat(key, value),
+
+  /**
+   * Default Bugfender log method.
+   *
+   * @param {string} tag - String with the tag.
+   * @param {string} message - String with the message.
+   */
+  d: (tag, text) => Bugfender.debug(tag, text),
+
+  /**
+   * Warning Bugfender log method.
+   *
+   * @param {string} tag - String with the tag.
+   * @param {string} message - String with the message.
+   */
+  w: (tag, text) => Bugfender.warning(tag, text),
+
+  /**
+   * Error Bugfender log method.
+   *
+   * @param {string} tag - String with the tag.
+   * @param {string} message - String with the message.
+   */
+  e: (tag, text) => Bugfender.error(tag, text),
+
+  /**
+   * Bugfender interface for logging, which takes a simple string as log message.
+   *
+   * @param {number} lineNumber - The line number of the log.
+   * @param {string} method - The method where the log has happened.
+   * @param {string} file - The file where the log has happened.
+   * @param {LogLevel} loglevel - Log level.
+   * @param {string} tag - Tag to be applied to the log line.
+   * @param {string} message - Message to be logged. The message will be logged verbatim, no interpretation will be performed.
+   **/
+  log: (lineNumber, method, file, loglevel, tag, message) => Bugfender.log(lineNumber, method, file, loglevel, tag, message),
+
+  /**
+   * Sends an issue
+   *
+   * @param {string} title - Short description of the issue.
+   * @param {string} text - Full details of the issue. Markdown format is accepted.
+   * @return {Promise<string>} A Promise with the URL pointing to the issue on the Bugfender dashboard or null if SDK is not initialized.
+   */
+  sendIssue: (title, text) => Bugfender.sendIssue(title, text),
+
+  /**
+   * Send a crash. Useful for controlled Exceptions
+   *
+   * @param {string} title - Title for the crash.
+   * @param {string} text - Additional info for the crash, p.e. the Stack trace. Markdown format is accepted
+   * @return A Promise with the URL pointing to the crash information on the Bugfender dashboard or null if SDK is not initialized.
+   */
+  sendCrash: (title, text) => Bugfender.sendCrash(title, text),
+
+  /**
+   * Sends user feedback
+   *
+   * @param {string} title - Title for the feedback.
+   * @param {string} message - Feedback message. Markdown format is accepted
+   * @return {Promise<string>} A Promise with the URL pointing to the feedback information on the Bugfender dashboard or null if SDK is not initialized.
+   */
+  sendUserFeedback: (title, text) => Bugfender.sendUserFeedback(title, text),
+
+  /**
+   * Synchronizes all logs and issues with the server once, regardless if this device is enabled or not.
+   *
+   * Logs and issues are synchronized only once. After that, the logs are again sent according to the enabled flag
+   * in the Bugfender Console.
+   */
+  forceSendOnce: () => Bugfender.forceSendOnce(),
+
+  /**
+   * Get a URL pointing to the Bugfender dashboard page for the device.
+   * @return {Promise<string>} A Promise with the URL to the page if the Bugfender sdk is initialized otherwise return null.
+   */
+  getDeviceUrl: () => Bugfender.getDeviceUrl(),
+
+  /**
+   * Get a URL pointing to the Bugfender dashboard page for the device and current session.
+   * @return {Promise<string>} A Promise with the URL to the page if the Bugfender sdk is initialized otherwise return null.
+   */
+  getSessionUrl: () => Bugfender.getSessionUrl(),
+
+  /**
+   * Open a screen to gather the feedback of the users and sent it to Bugfender.
+   * @param title
+   * @param hint
+   * @param subjectHint
+   * @param messageHint
+   * @param sendButtonText
+   * @param cancelButtonText
+   * @returns {Promise<string>} A Promise with the URL to the feedback information on the Bugfender dashboard. If the user cancels then the Promise is rejected
+   */
+  showUserFeedback: (title, hint, subjectHint, messageHint, sendButtonText, cancelButtonText) => Bugfender.showUserFeedback(title, hint, subjectHint, messageHint, sendButtonText, cancelButtonText)
+};

package/example/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["react-native"]
+}

package/example/.watchmanconfig

@@ -0,0 +1 @@
+{}

package/example/App.js

@@ -0,0 +1,163 @@
+import React, {Component} from 'react';
+import {
+  AppRegistry,
+  StyleSheet,
+  Text,
+  View,
+  Button,
+} from 'react-native';
+import Bugfender from '@bugfender/rn-bugfender';
+
+export default class AppComponent extends Component {
+  constructor(props) {
+    super(props);
+
+    // Add a "bugfenderKey.json" containing { "bugfenderKey : "YOUR_APP_KEY" }
+    // Or delete this line and hardcode your key in Bugfender.init("YOUR_APP_KEY")
+    var key = require('./bugfenderKey.json').bugfenderKey;
+
+    // Optional method. Use it to override the device name and avoid sending personal data like "iPhone of John Doe"
+    Bugfender.overrideDeviceName('Anonymous Phone');
+
+    // Optional method. Use it only if you have a custom instance of Bugfender
+    // Bugfender.setBaseUrl("https://bugfender.custom-company.com")
+
+    Bugfender.init(key);
+
+    Bugfender.enableCrashReporting();
+  }
+
+  render() {
+    return (
+        <View style={styles.container}>
+          <Text style={styles.welcome}>
+            Welcome to RN Bugfender Example!
+          </Text>
+          <Text style={styles.instructions}>
+            This application sends directly logs to the server if you push "Send Logs" button.
+          </Text>
+          <Text style={styles.instructions}>
+            Pressing "Generate JS Crash" the application will crash due to a JavaScript error and the crash information
+            will be sent to the server. This won't work on debug builds as LogBox will capture the error.
+          </Text>
+          <Text style={styles.instructions}>
+            Pressing "Show Native User Feedback" a native screen for sending feedback will be shown.
+          </Text>
+          <Text style={styles.instructions}>
+            Double tap R on your keyboard to reload,{'\n'}
+            Shake or press menu button for dev menu
+          </Text>
+          <View style={styles.button}>
+            <Button
+                onPress={this._onPressButton}
+                title="Send logs"
+            />
+          </View>
+          <View style={styles.button}>
+            <Button
+                onPress={this._generateError}
+                title="Generate JS crash"
+            />
+          </View>
+          <View style={styles.button}>
+            <Button
+                onPress={this._onPressShowUserFeedback}
+                title="Show Native User Feedback"
+            />
+          </View>
+        </View>
+    );
+  }
+
+  _generateError = () => {
+    // Force crash
+    var date = new Date(); //Current Date
+    var hours = date.getHours(); //Current Hours
+    var min = date.getMinutes(); //Current Minutes
+    var sec = date.getSeconds(); //Current Seconds
+    throw new Error('Force crash' + 'Time: ' + hours + ':' + min + ':' + sec);
+  };
+
+  _onPressButton() {
+    Bugfender.d('REACT', 'Im being called from React!');
+
+    Bugfender.d('Bugfender', 'Log without break lines in the middle of the message');
+    Bugfender.d('Bugfender', 'Log with break lines \n\n in the middle of the message');
+    Bugfender.d(null, 'Log with tag as null');
+    Bugfender.d('Bugfender', 'Normal log');
+    Bugfender.d('Bugfender', null);
+    Bugfender.d(null, null);
+
+    Bugfender.e('Bugfender', 'Log with break lines \n\n in the middle of the message');
+    Bugfender.e(null, 'Log with tag as null');
+    Bugfender.e('Bugfender', 'Normal log');
+    Bugfender.e('Bugfender', null);
+    Bugfender.e(null, null);
+
+    Bugfender.w('Bugfender', 'Log with break lines \n\n in the middle of the message');
+    Bugfender.w(null, 'Log with tag as null');
+    Bugfender.w('Bugfender', 'Normal log');
+    Bugfender.w('Bugfender', null);
+    Bugfender.w(null, null);
+
+    Bugfender.log(1001, 'method', 'file', Bugfender.LogLevel.DEBUG, 'tag', 'Sending low level log.');
+    Bugfender.log(1001, 'method', 'file', Bugfender.LogLevel.ERROR, 'tag', 'Sending low level log.');
+    Bugfender.log(1001, 'method', 'file', Bugfender.LogLevel.WARNING, 'tag', 'Sending low level log.');
+
+    Bugfender.setDeviceString('device.key.string', 'fake.string.value');
+    Bugfender.setDeviceBoolean('device.key.boolean', true);
+    Bugfender.setDeviceFloat('device.key.float', 101);
+    Bugfender.setDeviceInteger('device.key.integer', 102);
+
+    Bugfender.sendIssue('Issue One', 'Issue Message One').then(url => console.log(url));
+    Bugfender.sendIssue('Issue Two', 'Issue Message Two').then(url => console.log(url));
+    Bugfender.sendIssue('Issue Three', 'Issue Message Three').then(url => console.log(url));
+
+    Bugfender.sendCrash('Crash title', 'Crash text').then(url => console.log(url));
+
+    Bugfender.sendUserFeedback('User feedback', 'User feedback message').then(url => console.log(url));
+
+    Bugfender.getDeviceUrl().then(url => console.log(url));
+
+    Bugfender.getSessionUrl().then(url => console.log(url));
+  }
+
+  _onPressShowUserFeedback() {
+    Bugfender.showUserFeedback(
+        'Feedback',
+        'Please send us your feedback',
+        'This is the reason',
+        'This is the full message',
+        'Send',
+        'Cancel',
+    ).then(url => {
+      console.log('RN: feedback sent with url:', url);
+    }).catch(error => {
+      console.log('RN: feedback not sent');
+    });
+  }
+}
+
+const styles = StyleSheet.create({
+  container: {
+    flex: 1,
+    justifyContent: 'center',
+    alignItems: 'center',
+    backgroundColor: '#F5FCFF',
+  },
+  welcome: {
+    fontSize: 20,
+    textAlign: 'center',
+    margin: 10,
+  },
+  instructions: {
+    textAlign: 'center',
+    color: '#333333',
+    marginBottom: 5,
+  },
+  button: {
+    marginBottom: 5,
+  },
+});
+
+AppRegistry.registerComponent('App', () => AppComponent);

package/ios/RNBugfender.h

@@ -0,0 +1,7 @@
+#import <React/RCTBridgeModule.h>
+
+@import UIKit;
+
+@interface RNBugfender : NSObject <RCTBridgeModule>
+
+@end

package/ios/RNBugfender.m

@@ -0,0 +1,172 @@
+#import "RNBugfender.h"
+#import <BugfenderSDK/BugfenderSDK.h>
+#import <React/RCTUtils.h>
+
+@implementation RNBugfender
+
+RCT_EXPORT_MODULE(RNBugfender);
+
+RCT_EXPORT_METHOD(activateLogger:(NSString *)key)
+{
+    NSLog(@"Activate logger with key %@",key);
+    [Bugfender activateLogger:key];
+}
+
+RCT_EXPORT_METHOD(setApiUrl:(NSString *)apiUrl)
+{
+    NSURL *url = [NSURL URLWithString:apiUrl];
+    [Bugfender setApiURL:url];
+}
+
+RCT_EXPORT_METHOD(setBaseUrl:(NSString *)apiUrl)
+{
+    NSURL *url = [NSURL URLWithString:apiUrl];
+    [Bugfender setBaseURL:url];
+}
+
+RCT_EXPORT_METHOD(setForceEnabled:(BOOL)enabled)
+{
+    [Bugfender setForceEnabled:enabled];
+}
+
+RCT_EXPORT_METHOD(overrideDeviceName:(NSString *)deviceName)
+{
+    [Bugfender overrideDeviceName:deviceName];
+}
+
+RCT_EXPORT_METHOD(setMaximumLocalStorageSize:(int)size)
+{
+    [Bugfender setMaximumLocalStorageSize:size];
+}
+
+RCT_REMAP_METHOD(getDeviceUrl,
+                 getDeviceUrlWithResolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([Bugfender deviceIdentifierUrl].absoluteString);
+}
+
+RCT_REMAP_METHOD(getSessionUrl,
+                 getSessionUrlWithResolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([Bugfender sessionIdentifierUrl].absoluteString);
+}
+
+RCT_EXPORT_METHOD(removeDeviceKey:(NSString *)key)
+{
+    [Bugfender removeDeviceKey:key];
+}
+
+RCT_EXPORT_METHOD(enableLogcatLogging)
+{
+    NSLog(@"Not available on iOS");
+}
+
+RCT_EXPORT_METHOD(enableCrashReporting)
+{
+    [Bugfender enableCrashReporting];
+}
+
+RCT_EXPORT_METHOD(enableUIEventLogging)
+{
+    [Bugfender enableUIEventLogging];
+}
+
+// This methods have a weird naming convention because the Android dev wrote the RN pluging prior to the iOS dev
+RCT_EXPORT_METHOD(setDeviceBoolean:(NSString *)deviceKey boolValue:(BOOL)boolValue)
+{
+    [Bugfender setDeviceBOOL:boolValue forKey:deviceKey];
+}
+
+RCT_EXPORT_METHOD(setDeviceString:(NSString *)deviceKey stringValue:(NSString *)stringValue)
+{
+    [Bugfender setDeviceString:stringValue forKey:deviceKey];
+}
+
+RCT_EXPORT_METHOD(setDeviceInteger:(NSString *)deviceKey intValue:(int)intValue)
+{
+    [Bugfender setDeviceInteger:intValue forKey:deviceKey];
+}
+
+RCT_EXPORT_METHOD(setDeviceFloat:(NSString *)deviceKey floatValue:(float)floatValue)
+{
+    [Bugfender setDeviceDouble:floatValue forKey:deviceKey];
+}
+
+RCT_EXPORT_METHOD(debug:(NSString *)tag text:(NSString *)text)
+{
+    BFLog2(BFLogLevelDefault, tag, @"%@", text);
+}
+
+RCT_EXPORT_METHOD(warning:(NSString *)tag text:(NSString *)text)
+{
+    BFLog2(BFLogLevelWarning, tag, @"%@", text);
+}
+
+RCT_EXPORT_METHOD(error:(NSString *)tag text:(NSString *)text)
+{
+    BFLog2(BFLogLevelError, tag, @"%@", text);
+}
+
+RCT_EXPORT_METHOD(log:(int)lineNumber method:(NSString *)method file:(NSString *)file logLevel:(NSString *)rawLogLevel tag:(NSString *)tag  message:(NSString *)message)
+{
+    BFLogLevel logLevel = BFLogLevelDefault;
+    if ([rawLogLevel isEqualToString:@"Error"])
+        logLevel = BFLogLevelError;
+    else if ([rawLogLevel isEqualToString:@"Warning"])
+        logLevel = BFLogLevelWarning;
+    
+    [Bugfender logWithLineNumber:lineNumber method:method file:file level:logLevel tag:tag message:message];
+}
+
+RCT_EXPORT_METHOD(sendIssue:(NSString *)tag text:(NSString *)text urlResolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([Bugfender sendIssueReturningUrlWithTitle:tag text:text].absoluteString);
+}
+
+RCT_EXPORT_METHOD(sendCrash:(NSString *)title text:(NSString *)text urlResolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([Bugfender sendCrashWithTitle:title text:text].absoluteString);
+}
+
+RCT_EXPORT_METHOD(forceSendOnce)
+{
+    [Bugfender forceSendOnce];
+}
+
+RCT_EXPORT_METHOD(sendUserFeedback:(NSString *)title text:(NSString *)text urlResolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+{
+    resolve([Bugfender sendUserFeedbackReturningUrlWithSubject:title message:text].absoluteString);
+}
+
+RCT_EXPORT_METHOD(showUserFeedback:(NSString *)title hint:(NSString *)hint subjectHint:(NSString *)subjectHint messageHint:(NSString *)messageHint sendButtonText:(NSString *)sendButtonText cancelButtonText:(NSString *)cancelButtonText resolver:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject)
+{
+    UIViewController * controller = [Bugfender userFeedbackViewControllerWithTitle:title
+                                                                              hint:hint
+                                                                subjectPlaceholder:subjectHint
+                                                                messagePlaceholder:messageHint
+                                                                   sendButtonTitle:sendButtonText
+                                                                 cancelButtonTitle:cancelButtonText
+                                                                        completion:^(BOOL feedbackSent, NSURL * _Nullable url) {
+        if (feedbackSent) {
+            resolve(url.absoluteString);
+        } else {
+            reject(0, @"Feedback not sent", nil);
+        }
+    }];
+    
+    UIViewController* vc = RCTPresentedViewController();
+    [vc presentViewController:controller animated:YES completion:nil];
+
+    /*
+     * Another option might be using the window.
+     * But this code might not work for complex native setup, for simple cases, might work
+     * [UIApplication.sharedApplication.delegate.window.rootViewController presentViewController:controller animated:YES completion:nil];
+     */
+}
+
+- (dispatch_queue_t)methodQueue
+{
+    return dispatch_get_main_queue();
+}
+
+@end