Merge pull request #306 from bugsnag/add-deobfuscation-examples

Update examples to show how to deobfuscate JS + Native stacktraces

Author: fractalwrench

examples/plain/.gitignore

@@ -51,3 +51,6 @@ buck-out/
 */fastlane/report.xml
 */fastlane/Preview.html
 */fastlane/screenshots
+
+*.bundle
+*.bundle.map

examples/plain/README.md

@@ -52,3 +52,45 @@ A robust example of how to make best use of the Bugsnag React Native notifier.
    ```
    react-native run-android --variant=release
    ```
+
+## Deobfuscating stacktraces
+
+This app provides working examples of how to deobfuscate stacktraces for JS, Android, and iOS. For further information, please consult [our React Native documentation](https://docs.bugsnag.com/platforms/react-native/showing-full-stacktraces/).
+
+### JavaScript
+
+You will need to upload source maps to Bugsnag in order to deobfuscate JavaScript stack traces. Example scripts for achieving this on Android/iOS in both debug and release builds can be found [here](scripts). The example scripts use [bugsnag-sourcemaps](https://github.com/bugsnag/bugsnag-sourcemaps), which is installed as a dev dependency of the project. The scripts can also be invoked in this example project using [npm run](https://docs.npmjs.com/cli/run-script.html):
+
+```bash
+npm run upload-sourcemaps:debug:android
+npm run upload-sourcemaps:debug:ios
+npm run upload-sourcemaps:release:android
+npm run upload-sourcemaps:release:ios
+```
+
+Please note that if you use Code Push, you should specify `codeBundleId` in your JS configuration, and use that as the value of `app-version` instead. See [the docs](https://docs.bugsnag.com/platforms/react-native/showing-full-stacktraces) for further detail.
+
+Note: recent versions of React Native have an [issue](https://github.com/facebook/react-native/issues/6946#issuecomment-405525464) which may result in the failure to apply source maps or incorrect line numbers being mapped.
+
+### Android
+
+The [Bugsnag Gradle Plugin](https://docs.bugsnag.com/build-integrations/gradle/) will automatically upload all the necessary mapping files when `react-native run-android --variant=release` is invoked.
+
+ProGuard mapping files can also be uploaded manually in this example project by using [npm run](https://docs.npmjs.com/cli/run-script.html):
+
+```bash
+npm run upload-proguard:release:android
+```
+
+### iOS
+
+If Bitcode is enabled in your project, you will first need to download your dSYMs from XCode or iTunes Connect, then upload them by using our fastlane plugin or bugsnag-dsym-upload. A working example of this can be found [here](ios/upload-react-native-dsyms.sh). The example script requires the installation of [bugsnag-dsym-upload](https://github.com/bugsnag/bugsnag-dsym-upload) to work, and can be invoked using [npm run](https://docs.npmjs.com/cli/run-script.html):
+
+```bash
+npm run upload-dsyms:release:ios
+```
+
+
+If you are not using Bitcode, you can use our Fastlane or Cocoapods integrations, or add a manual Build phase to upload the dSYMs.
+
+Read the [iOS symbolication guide](https://docs.bugsnag.com/platforms/ios/symbolication-guide) for further details.

examples/plain/android/app/build.gradle

@@ -1,4 +1,5 @@
 apply plugin: "com.android.application"
+apply plugin: 'com.bugsnag.android.gradle'
 
 import com.android.build.OutputFile
 
@@ -91,7 +92,7 @@ def enableSeparateBuildPerCPUArchitecture = false
 /**
  * Run Proguard to shrink the Java bytecode in release builds.
  */
-def enableProguardInReleaseBuilds = false
+def enableProguardInReleaseBuilds = true
 
 android {
     compileSdkVersion rootProject.ext.compileSdkVersion
@@ -158,3 +159,7 @@ task copyDownloadableDepsToLibs(type: Copy) {
     from configurations.compile
     into 'libs'
 }
+
+bugsnag {
+    overwrite true
+}

examples/plain/android/build.gradle

@@ -15,6 +15,7 @@ buildscript {
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.1.4'
+        classpath 'com.bugsnag:bugsnag-android-gradle-plugin:3.6.0'
 
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files

examples/plain/android/upload-proguard.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+cd android
+./gradlew uploadBugsnagReleaseMapping

examples/plain/ios/upload-react-native-dsyms.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+cd ios
+bugsnag-dsym-upload build/Build/Products/Release-iphonesimulator/