@bugfender/rn-bugfender 1.1.5 → 2.1.0

package/README.md

@@ -1,130 +1,194 @@
 # React Native plugin for Bugfender
 
-## Getting started
+Bugfender module for React Native and React Native for the Web. It depends on the iOS, Android and Javascript Bugfender SDKs.
 
-The Bugfender bindings for React Native depend on the native iOS and Android Bugfender SDKs.
-
-## Creating a RN new project compatible with Bugfender
-
-You can create a new project using 
-
-`$ npx react-native init AwesomeProject`
-
-or if you already started your project using the tool `create-react-native-app` you will need to `eject` your project in order to add native modules. 
-
-More info can be found in the [official docs](https://facebook.github.io/react-native/docs/getting-started.html)
-
-Before moving to the next point **compile the project and ensure you can execute**. 
-In this way, we can discard issues in the next steps. 
-
-## Adding Bugfender to your project 
+## Adding Bugfender to your project
 
 **Please note:** if you're using Expo for development, be sure to be using the ["bare workflow"](https://docs.expo.io/introduction/managed-vs-bare/#bare-workflow).
 
 `$ cd path_to_your_project`
 
-**1.** Add the bugfender plugin from npm 
+Add the bugfender plugin from npm
 
 `$ npm install @bugfender/rn-bugfender --save`
 
-**If you want to use cocoapods (recommended), skip the step 2 and go to the step 3B**. 
-For manual installation, proceed with the steps 2 and 3A. 
-
-**2.** Link to your project
-```
-// Add the classes of the plugin to your android and iOS projects 
-$ npx react-native link @bugfender/rn-bugfender`
-```
-
-### Android
-You are done! 
+### Android & React Native for the Web
+You are done!
 
-### iOS 
-**3A. Manual installation** 
+### iOS
+You can finish the installation manually or via CocoaPods (recommended)
 
-Download the latest release from [Github](https://github.com/bugfender/BugfenderSDK-iOS/releases) and copy `BugfenderSDK.framework` to `YourAwesomeProjectDirectory/ios` (same directory as AwesomeProject.xcodeproj). Then, follow the instructions to setup your project manually: 
-
-* Go to your **Project** > **Your Target** > **General** > **Linked Frameworks and Libraries** and drag `BugfenderSDK.framework` there (uncheck the "Copy items if needed" checkbox).
-
-* Make sure you have linked `SystemConfiguration.framework`, `Security.framework`, `MobileCoreServices.framework` and `libc++.tbd` as well.
-
-**3B. Cocoapods (recommended)**
+**CocoaPods (recommended)**
 
 1. Ensure your iOS project contains a Podfile, otherwise you need to add it now:
 ```
 $ cd path_to_your_project/ios
 $ pod init
 ```
-
-2. Link your project: 
-```
-// Add the classes of the plugin to your android and iOS projects 
-$ npx react-native link @bugfender/rn-bugfender`
-```
-
 Make sure you're targeting at least iOS platform version 10 (specify `platform :ios, '10.0'`).
 
-A new line should have been added automatically to your Podfile: 
-
-`pod 'RNBugfender', :path => '../node_modules/@bugfender/rn-bugfender'`
-
-3. After configuring the podfile you can now go to the console and run 
+2. After configuring the podfile you can now go to the console and run
 
 `$ pod install`
 
-When the installation has finished you should be able to run your project in iOS and Android. 
+When the installation has finished you should be able to run your project in iOS and Android.
 
 **Remember that you should be using the Xcode workspace instead of the xcodeproj file from now on.**
 
-**Important**: the *podspec* of RNBugfender declares React as a dependency. Your Podfile must explicitly override that React dependency. Like this: 
+*At the end of this document you can find a **[recommended podfile](#recommended-podfile)**. You can use it as an example*.
 
-`pod 'React', path: '../node_modules/react-native'`
+If you have any problems compiling or executing, try our [Troubleshooting section](#cocoapods-troubleshooting) at the end of this document.
 
-If you created your project with the react-native cli from React Native 0.60 or newer your podfile should be already prepared. For older versions of react-native you must ensure to override it. Otherwise, cocoapods will download and install a new version in your iOS folder and you will end up with all the React libraries duplicated.  
+**Manual installation (alternative to CocoaPods)**
 
-*At the end of this document you can find a **[recommended podfile](#recommended-podfile)**. You can use it as an example*. 
+Download the latest release from [Github](https://github.com/bugfender/BugfenderSDK-iOS/releases) and copy `BugfenderSDK.framework` to `YourAwesomeProjectDirectory/ios` (same directory as AwesomeProject.xcodeproj). Then, follow the instructions to setup your project manually:
 
-If you have any problems compiling or executing, try our [Troubleshooting section](#cocoapods-troubleshooting) at the end of this document.
+* Go to your **Project** > **Your Target** > **General** > **Linked Frameworks and Libraries** and drag `BugfenderSDK.framework` there (uncheck the "Copy items if needed" checkbox).
 
-## RNBugfender Usage
-```javascript
-import Bugfender from '@bugfender/rn-bugfender';
-
-// Init Bugfender with your APP key 
-Bugfender.init("your_app_key");
-
-// Sending logs with default level 
-Bugfender.d ("REACT", "This is a debug log in Bugfender from React Native");
-
-// Sending logs with warning level 
-Bugfender.w ("REACT", "This is a debug log in Bugfender from React Native");
-
-// Sending logs with error level 
-Bugfender.e ("REACT", "This is a debug log in Bugfender from React Native");
-
-// Low level logs 
-Bugfender.log (1001, "method", "file", "Debug", "tag", "Sending low level log.");
-Bugfender.log (1001, "method", "file", "Error", "tag", "Sending low level log.");
-Bugfender.log (1001, "method", "file", "Warning", "tag", "Sending low level log.");
-        
-// Creating issues 
-Bugfender.sendIssue ("New issue", "This will create a new issue in Bugfender");
-
-// Send user feedback 
-Bugfender.sendUserFeedback ("New feedback", "This will create a new feedback in Bugfender");
-
-// Set values 
-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);
-        
+* Make sure you have linked `SystemConfiguration.framework`, `Security.framework`, `MobileCoreServices.framework` and `libc++.tbd` as well.
+
+## Upgrading from version 1.x
+After updating to version 2.x from version 1.x you should perform the following extra steps:
+### Android
+Open `MainApplication` class inside `android/app/src/main/java/com.<your_app>/` folder and remove any references to `com.bugfender.react.RNBugfenderPackage`
+### iOS
+Open `Podfile` inside `ios` folder and remove the following line:
+```
+pod 'RNBugfender', :path => '../node_modules/@bugfender/rn-bugfender'
+```
+and then execute the following command under `ios` folder:
+```
+pod deintegrate && pod install
 ```
 
-## Cocoapods Troubleshooting 
+## RNBugfender Usage
+```typescript
+import { Bugfender, LogLevel } from '@bugfender/rn-bugfender';
+
+// Init Bugfender with your APP key
+Bugfender.init({
+  appKey: '<YOUR APP KEY>',
+  // apiURL: 'https://api.bugfender.com',
+  // baseURL: 'https://dashboard.bugfender.com',
+  // overrideConsoleMethods: true,
+  // printToConsole: true,
+  // logUIEvents: true,
+  // registerErrorHandler: true,
+  // deviceName: 'Anonymous',
+  // maximumLocalStorageSize: 5 * 1024 * 1024, // Native specific
+  // enableLogcatLogging: false, // Android specific
+  // logBrowserEvents: true, // Web specific
+  // build: '42', // Web specific
+  // version: '1.0', // Web sprecific
+});
+
+// Alternatively, SDKOptionsBuilder can be used to make it apparent what options are specific of certain platforms
+Bugfender.init(
+  new SDKOptionsBuilder({
+    appKey: '<YOUR APP KEY>',
+  }).native({
+    enableLogcatLogging: false,
+  }).web({
+    logBrowserEvents: true,
+    build: '42',
+    version: '1.0',
+  }).build()
+);
+
+// Send logs with different levels
+Bugfender.log('This is a debug log in Bugfender from React Native');
+Bugfender.warn('This is a warn log in Bugfender from React Native');
+Bugfender.error('This is a error log in Bugfender from React Native');
+Bugfender.fatal('This is a fatal log in Bugfender from React Native');
+Bugfender.trace('This is a trace log in Bugfender from React Native');
+Bugfender.info('This is a info log in Bugfender from React Native');
+
+// Send low level log
+Bugfender.sendLog({
+  line: 1001,
+  level: LogLevel.Debug,
+  tag: 'tag',
+  method: 'method',
+  file: 'file',
+  text: 'Sending low level debug log.',
+});
+
+// Send issues
+Bugfender.sendIssue('Issue titile', 'This will create a new issue in Bugfender').then((url) =>
+  console.log('Issue url: %s', url)
+);
+
+// Send crashes
+Bugfender.sendCrash('Crash title', 'This will create a new crash in Bugfender').then((url) =>
+  console.log('Crash url: %s', url)
+);
+
+// Send user feedback
+Bugfender.sendUserFeedback('Feedback title', 'This will create a new feedback in Bugfender').then((url) =>
+  console.log('Feedback url: %s', url)
+);
+
+// Show user feedback native screen
+Bugfender.getUserFeedback({
+    title: 'Feedback',
+    hint: 'Please send us your feedback',
+    subjectPlaceholder: 'This is the reason',
+    feedbackPlaceholder: 'This is the full message',
+    submitLabel: 'Send',
+    closeLabel: 'Cancel',
+  }
+).then(response => {
+  if (response.isSent) {
+    console.log('RN: feedback sent with url:', response.feedbackURL);
+  } else {
+    console.log('RN: feedback not sent');
+  }
+});
+
+// Set device values
+Bugfender.setDeviceKey('device.key.string', 'fake.string.value');
+Bugfender.setDeviceKey('device.key.boolean', true);
+Bugfender.setDeviceKey('device.key.float', 10.1);
+Bugfender.setDeviceKey('device.key.integer', 102);
+
+// Remove device values
+Bugfender.removeDeviceKey('device.key.integer');
+
+// Get different URLs
+Bugfender.getDeviceURL().then((url) => console.log('Device url: %s', url));
+Bugfender.getSessionURL().then((url) => console.log('Session url: %s', url));
+
+// Synchronizes all logs and issues with the server once
+Bugfender.forceSendOnce();
+```
+## Changelog
+The changelog of the Bugfender Web SDK can be found in ReleaseNotes under the [react-native](https://bugfender.releasenotes.io/tag/react-native) tag. For all the Bugfender product changes please visit the general release notes.
+
+### 2.x Breaking Changes
+The React Native SDK API has changed in order be unified with [Bugfender Web SDK](https://www.npmjs.com/package/@bugfender/sdk):
+* The following methods have been removed and replaced with init method attributes:
+  * `setApiUrl`
+  * `setBaseUrl`
+  * `overrideDeviceName`
+  * `setMaximumLocalStorageSize`
+  * `enableLogcatLogging`
+  * `enableCrashReporting`
+  * `enableUIEventLogging`
+
+* The following methods have been renamed:
+  * `setForceEnabled` renamed to `sendForceOnce`
+  * `showUserFeedback` renamed to `sendUserFeedback`
+  * `d` rename to `debug`
+  * `w` renamed to `warn`
+  * `e` renamed to `error`
+  * `log` renamed to `sendLog`
+
+* `setDeviceKey` method replaces `setDeviceBoolean`, `setDeviceString`, `setDeviceInteger` & `setDeviceFloat`
+
+## Cocoapods Troubleshooting
 We did our best to create a installation process that worked for most of the users. However, the React Native configuration can be tricky sometimes.
 
-Most of the issues are related to the high number of dependencies and the compatibility between them. As every project is different and has different needs it's difficult to provide a magic receipt that can work out of the box, however we find out that the following Podfile compiles and run correctly most of the time. You can use it as a basis to experiment and find a configuration that works for you. 
+Most of the issues are related to the high number of dependencies and the compatibility between them. As every project is different and has different needs it's difficult to provide a magic receipt that can work out of the box, however we find out that the following Podfile compiles and run correctly most of the time. You can use it as a basis to experiment and find a configuration that works for you.
 
 ### Recommended Podfile
 ```
@@ -138,7 +202,7 @@ target 'SampleProject' do
   pod 'AFNetworking'
 
   # Add new pods below this line
-  pod 'RNBugfender', :path => '../node_modules/@bugfender/rn-bugfender'
+  pod 'RnBugfender', :path => '../node_modules/@bugfender/rn-bugfender'
 
   rn_path = '../node_modules/react-native'
 
@@ -159,10 +223,10 @@ target 'SampleProject' do
     'RCTVibration',
     'RCTWebSocket',
   ]
-  
+
 end
 ```
 
-If you are not able to get your project working you can still try to add RNBugfender with the Manual Installation or to open an issue in Github and maybe we can help you. 
+If you are not able to get your project working you can still try to add RNBugfender with the Manual Installation or to open an issue in Github and maybe we can help you.
 
-Happy debugging! 
+Happy debugging!

package/RnBugfender.podspec

@@ -0,0 +1,21 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "RnBugfender"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "10.0" }
+  s.source       = { :git => "https://github.com/bugfender/BugfenderSDK-iOS", :tag => "master" }
+
+  s.source_files = "ios/**/*.{h,m,mm}"
+
+  s.dependency "React-Core"
+  s.dependency 'BugfenderSDK', '~> 1.10.5'
+
+end

package/android/build.gradle

@@ -1,103 +1,61 @@
 buildscript {
-  repositories {
-    jcenter()
-    maven { url 'https://maven.google.com' }
-  }
+    if (project == rootProject) {
+        repositories {
+            google()
+            mavenCentral()
+            jcenter()
+        }
 
-  dependencies {
-    classpath 'com.android.tools.build:gradle:3.2.1'
-  }
+        dependencies {
+            classpath 'com.android.tools.build:gradle:3.5.3'
+        }
+    }
 }
 
 apply plugin: 'com.android.library'
 
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
 android {
-  compileSdkVersion 28
-  buildToolsVersion '28.0.3'
+    compileSdkVersion safeExtGet('RnBugfender_compileSdkVersion', 29)
+    defaultConfig {
+        minSdkVersion safeExtGet('RnBugfender_minSdkVersion', 16)
+        targetSdkVersion safeExtGet('RnBugfender_targetSdkVersion', 29)
+        versionCode 1
+        versionName "1.0"
 
-  defaultConfig {
-    minSdkVersion 16
-    targetSdkVersion 28
-    versionCode 1
-    versionName "1.0"
-  }
+    }
 
-  lintOptions {
-    abortOnError false
-  }
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+    }
+    lintOptions {
+        disable 'GradleCompatible'
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
 }
 
 repositories {
-  jcenter()
-  google()
-
-  def found = false
-  def defaultDir = null
-  def androidSourcesName = 'React Native sources'
-
-  if (rootProject.ext.has('reactNativeAndroidRoot')) {
-    defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
-  } else {
-    defaultDir = new File(
-        projectDir,
-        '/../../../node_modules/react-native/android'
-    )
-  }
-
-  if (defaultDir.exists()) {
+    mavenLocal()
     maven {
-      url defaultDir.toString()
-      name androidSourcesName
+        // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+        url("$rootDir/../node_modules/react-native/android")
     }
-
-    logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
-    found = true
-  } else {
-    def parentDir = rootProject.projectDir
-
-    1.upto(5, {
-      if (found) return true
-      parentDir = parentDir.parentFile
-
-      def androidSourcesDir = new File(
-          parentDir,
-          'node_modules/react-native'
-      )
-
-      def androidPrebuiltBinaryDir = new File(
-          parentDir,
-          'node_modules/react-native/android'
-      )
-
-      if (androidPrebuiltBinaryDir.exists()) {
-        maven {
-          url androidPrebuiltBinaryDir.toString()
-          name androidSourcesName
-        }
-
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
-        found = true
-      } else if (androidSourcesDir.exists()) {
-        maven {
-          url androidSourcesDir.toString()
-          name androidSourcesName
-        }
-
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
-        found = true
-      }
-    })
-  }
-
-  if (!found) {
-    throw new GradleException(
-        "${project.name}: unable to locate React Native android sources. " +
-            "Ensure you have you installed React Native as a dependency in your project and try again."
-    )
-  }
+    google()
+    mavenCentral()
+    jcenter()
 }
 
 dependencies {
-  implementation 'com.facebook.react:react-native:+'
-  implementation 'com.bugfender.sdk:android:3.+'
+    //noinspection GradleDynamicVersion
+    implementation "com.facebook.react:react-native:+"  // From node_modules
+    //noinspection GradleDynamicVersion
+    implementation 'com.bugfender.sdk:android:3.+'
 }

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Tue Jul 14 10:32:57 CEST 2020
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-all.zip

package/android/gradlew

@@ -1,5 +1,21 @@
 #!/usr/bin/env sh
 
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 ##############################################################################
 ##
 ##  Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
@@ -56,7 +72,7 @@ case "`uname`" in
   Darwin* )
     darwin=true
     ;;
-  MINGW* )
+  MSYS* | MINGW* )
     msys=true
     ;;
   NONSTOP* )
@@ -66,6 +82,7 @@ esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
@@ -109,10 +126,11 @@ if $darwin; then
     GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
 fi
 
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath
@@ -138,19 +156,19 @@ if $cygwin ; then
         else
             eval `echo args$i`="\"$arg\""
         fi
-        i=$((i+1))
+        i=`expr $i + 1`
     done
     case $i in
-        (0) set -- ;;
-        (1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
     esac
 fi
 
@@ -159,14 +177,9 @@ save () {
     for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
     echo " "
 }
-APP_ARGS=$(save "$@")
+APP_ARGS=`save "$@"`
 
 # Collect all arguments for the java command, following the shell quoting and substitution rules
 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
 exec "$JAVACMD" "$@"