misc(sample): Add SAGP JVM source context (#3532)

Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>

Author: krystofwoldrich

CONTRIBUTING.md

@@ -168,3 +168,30 @@ dependencies {
 +    api 'io.sentry:sentry-android:6.7.7-my-local-version'
 }
 ```
+
+## Develop with sentry-android-gradle-plugin
+
+Here are steps on how to debug the gradle builds process with `sentry-android-gradle-plugin`. We assume that you have `sentry-android-gradle-plugin` setup, Android SDK installed, correct JAVA version etc.
+
+1. Add the following code to `samples/react-native/android/settings.gradle`, this ensure the plugin builds at the beginning of the application build:
+
+```groovy
+includeBuild('../../../../sentry-android-gradle-plugin/plugin-build') {
+  dependencySubstitution {
+    substitute(module 'io.sentry:sentry-android-gradle-plugin') using project(':')
+  }
+}
+```
+
+`../../../../sentry-android-gradle-plugin/plugin-build` this example works if `sentry-react-native` and `sentry-android-gradle-plugin` are sibling directories.
+
+2. Open `samples/react-native/android` in Android Studio.
+3. Add `Remote JVM Debug` configuration (keep all defaults).
+4. Run build command with `-Dorg.gradle.debug=true` and `--no-daemon`, example:
+
+```groovy
+./gradlew assembleRelease -Dorg.gradle.debug=true --no-daemon
+```
+
+5. The build command will wait for the debugger connection, go to the Android Studio and select the newly created `Remote JVM Debug` configuration and click `Debug`.
+6. The build process will stop on active breakpoint.

samples/react-native/android/app/build.gradle

@@ -35,6 +35,18 @@ sentry {
     // Default is disabled.
     includeNativeSources = true
 
+    // Generates a JVM (Java, Kotlin, etc.) source bundle and uploads your source code to Sentry.
+    // This enables source context, allowing you to see your source
+    // code as part of your stack traces in Sentry.
+    //
+    // Default is disabled.
+    includeSourceContext = true
+
+    // Includes additional source directories into the source bundle.
+    // These directories are resolved relative to the project directory
+    // which is /android/app in this sample application.
+    // additionalSourceDirsForSourceContext = ["src/main/java"]
+
     // `@sentry/react-native` ships with compatible `sentry-android`
     // This option would install the latest version that ships with the SDK or SAGP (Sentry Android Gradle Plugin)
     // which might be incompatible with the React Native SDK

samples/react-native/android/app/src/main/java/com/samplenewarchitecture/SamplePackage.java

@@ -52,6 +52,25 @@ public List<NativeModule> createNativeModules(
             }
         });
 
+        modules.add(new ReactContextBaseJavaModule() {
+            @Override public String getName() {
+                return "CrashModule";
+            }
+
+            @ReactMethod public void crashOrUndefined() {
+              this.crashNow();
+            }
+
+            @ReactMethod public int crashOrNumber() {
+              this.crashNow();
+              return 42;
+            }
+
+            private void crashNow() {
+                throw new RuntimeException("CrashModule.crashNow()");
+            }
+        });
+
         return modules;
     }
 

samples/react-native/src/Screens/HomeScreen.tsx

@@ -20,7 +20,7 @@ import { UserFeedbackModal } from '../components/UserFeedbackModal';
 import { FallbackRender } from '@sentry/react';
 import NativeSampleModule from '../../tm/NativeSampleModule';
 
-const { AssetsModule, CppModule } = NativeModules;
+const { AssetsModule, CppModule, CrashModule } = NativeModules;
 
 interface Props {
   navigation: StackNavigationProp<any, 'HomeScreen'>;
@@ -120,12 +120,26 @@ const HomeScreen = (props: Props) => {
           }}
         />
         {Platform.OS === 'android' && (
-          <Button
-            title="Crash in Android Cpp"
-            onPress={() => {
-              CppModule?.crashCpp();
-            }}
-          />
+          <>
+            <Button
+              title="Crash in Android Cpp"
+              onPress={() => {
+                CppModule?.crashCpp();
+              }}
+            />
+            <Button
+              title="JVM Crash or Undefined"
+              onPress={() => {
+                CrashModule.crashOrUndefined();
+              }}
+            />
+            <Button
+              title="JVM Crash or Number"
+              onPress={() => {
+                CrashModule.crashOrNumber();
+              }}
+            />
+          </>
         )}
         <Spacer />
         <Sentry.ErrorBoundary fallback={errorBoundaryFallback}>