feat: gwp and ndk setup

MichaelVerdon · MichaelVerdon · commit fe14a8d0505f · 2025-12-08T14:25:01.000Z
diff --git a/docs/crashlytics/android-setup.md b/docs/crashlytics/android-setup.md
@@ -57,23 +57,37 @@ apply plugin: 'com.google.firebase.crashlytics'
 // ..
 ```
 
-## 4. (Optional) Enable Crashlytics NDK reporting
+## 4. (Optional) Configure Crashlytics NDK and GWP-ASan support
+
+### Enable NDK Crash Reporting
 
 Crashlytics NDK reporting allows you to capture Native Development Kit crashes, e.g. in React Native this will capture
 crashes originating from the Yoga layout engine.
 
-Add the `firebaseCrashlytics` block line to the `android/app/build.gradle` file:
+To enable NDK crash reporting, add the following to your `firebase.json` file:
+
+```json
+{
+  "react-native": {
+    "crashlytics_ndk_enabled": true
+  }
+}
+```
+
+When `crashlytics_ndk_enabled` is set to `true`, React Native Firebase will automatically:
+- Enable NDK crash reporting in the manifest
+- Configure automatic native symbol upload for all release build variants
+
+> **Note**: The automatic symbol upload configuration works with standard release builds and custom build flavors (e.g., `playRelease`, `premiumRelease`). Any build variant with "release" in its name will have symbol upload enabled.
+
+If you need to manually configure symbol upload or override the automatic configuration, you can add the `firebaseCrashlytics` block to your `android/app/build.gradle` file:
 
 ```groovy
 android {
     // ...
 
     buildTypes {
         release {
-            /* Add the firebaseCrashlytics extension (by default,
-            * it's disabled to improve build speeds) and set
-            * nativeSymbolUploadEnabled to true along with a pointer to native libs. */
-
             firebaseCrashlytics {
                 nativeSymbolUploadEnabled true
                 unstrippedNativeLibsDir 'build/intermediates/merged_native_libs/release/out/lib'
@@ -84,6 +98,25 @@ android {
 }
 ```
 
+### Configure GWP-ASan Mode
+
+[GWP-ASan](https://developer.android.com/ndk/guides/gwp-asan) (GWP-AddressSanitizer) is a native memory allocator feature that helps detect heap memory errors. You can configure its behavior using `firebase.json`:
+
+```json
+{
+  "react-native": {
+    "crashlytics_gwp_asan_mode": "default"
+  }
+}
+```
+
+Available values:
+- `"default"` - The default behavior (system-determined, typically enabled for a small percentage of devices)
+- `"never"` - Disable GWP-ASan completely
+- `"always"` - Enable GWP-ASan on all devices (useful for testing, but not recommended for production due to performance impact)
+
+> **Recommended**: Use `"default"` for production builds to get memory error detection with minimal performance impact.
+
 ## 5. Rebuild the project
 
 Once the above steps have been completed, rebuild your Android project:
diff --git a/docs/crashlytics/usage/index.md b/docs/crashlytics/usage/index.md
@@ -213,21 +213,47 @@ Because you have stack traces readily available while you're debugging your app,
 ## Crashlytics NDK
 
 React Native Firebase supports [Crashlytics NDK](https://firebase.google.com/docs/crashlytics/ndk-reports) reporting
-which is enabled by default but will require a change as described in that link to enable symbol upload.
+which allows Crashlytics to capture crashes originating from the Yoga layout engine used by React Native.
 
-This allows Crashlytics to capture crashes originating from the Yoga layout engine used by React Native.
+**Note:** NDK reporting is disabled by default due to memory usage concerns. 
 
-You can disable Crashlytics NDK in your `firebase.json` config.
+### Enable NDK Reporting
+
+To enable NDK crash reporting, add the following to your `firebase.json`:
+
+```json
+// <project-root>/firebase.json
+{
+  "react-native": {
+    "crashlytics_ndk_enabled": true
+  }
+}
+```
+
+When enabled, React Native Firebase will automatically:
+- Enable NDK crash reporting in your Android app
+- Configure automatic native symbol upload for all release build variants
+
+For more details on Android setup, see the [Android Setup](/crashlytics/android-setup) documentation.
+
+### Configure GWP-ASan
+
+[GWP-ASan](https://developer.android.com/ndk/guides/gwp-asan) (GWP-AddressSanitizer) is a native memory allocator feature that helps detect heap memory errors. You can configure its behavior:
 
 ```json
 // <project-root>/firebase.json
 {
   "react-native": {
-    "crashlytics_ndk_enabled": false
+    "crashlytics_gwp_asan_mode": "default"
   }
 }
 ```
 
+Available values:
+- `"default"` - System-determined (recommended for production)
+- `"never"` - Disable GWP-ASan completely
+- `"always"` - Enable on all devices (for testing only)
+
 ## Crashlytics Javascript stacktrace issue generation
 
 React Native Crashlytics module by default installs a global javascript exception handler, and it records a crash with a javascript stack trace any time an unhandled javascript exception is thrown. Sometimes it is not desirable behavior since it might duplicate issues in combination with the default mode of javascript global exception handler chaining. We recommend leaving JS crashes enabled and turning off exception handler chaining. However, if you have special crash handling requirements, you may disable this behavior by setting the appropriate option to false:
diff --git a/packages/crashlytics/android/build.gradle b/packages/crashlytics/android/build.gradle
@@ -61,14 +61,19 @@ apply from: file('./../../app/android/firebase-json.gradle')
 
 // Default to 'false' for the feature due to memory usage concerns
 String crashlyticsNdkEnabled = 'false'
+// Default to 'default' for GWP-ASan mode (other options: 'never', 'always')
+String crashlyticsGwpAsanMode = 'default'
 
 if (rootProject.ext && rootProject.ext.firebaseJson) {
   def rnfbConfig = rootProject.ext.firebaseJson
   
-  // Allow users to opt-in to NDK crash reporting (or whatever feature)
+  // Allow users to opt-in to NDK crash reporting
   if (rnfbConfig.isFlagEnabled('crashlytics_ndk_enabled', false) == true) {
     crashlyticsNdkEnabled = 'true'
   }
+  
+  // Allow users to configure GWP-ASan mode: 'default', 'never', or 'always'
+  crashlyticsGwpAsanMode = rnfbConfig.getStringValue('crashlytics_gwp_asan_mode', 'default')
 }
 
 android {
@@ -80,7 +85,8 @@ android {
   defaultConfig {
     multiDexEnabled = true
     manifestPlaceholders = [
-      firebaseJsonCrashlyticsNdkEnabled: crashlyticsNdkEnabled
+      firebaseJsonCrashlyticsNdkEnabled: crashlyticsNdkEnabled,
+      firebaseJsonCrashlyticsGwpAsanMode: crashlyticsGwpAsanMode
     ]
   }
 
@@ -117,3 +123,74 @@ ReactNative.shared.applyPackageVersion()
 ReactNative.shared.applyDefaultExcludes()
 ReactNative.module.applyAndroidVersions()
 ReactNative.module.applyReactNativeDependency("api")
+
+// Configure automatic NDK symbol upload for release variants if NDK is enabled
+if (rootProject.ext && rootProject.ext.firebaseJson) {
+  def rnfbConfig = rootProject.ext.firebaseJson
+  
+  if (rnfbConfig.isFlagEnabled('crashlytics_ndk_enabled', false) == true) {
+    rootProject.afterEvaluate {
+      // Find the app project (the one with com.android.application plugin)
+      def appProject = rootProject.subprojects.find { 
+        it.plugins.hasPlugin('com.android.application') 
+      }
+      
+      if (appProject != null) {
+        appProject.afterEvaluate {
+          try {
+            def android = appProject.extensions.findByName('android')
+            
+            if (android != null) {
+              // Try to configure all release-type variants
+              try {
+                android.applicationVariants.all { variant ->
+                  // Match variants with 'release' in the name (case insensitive)
+                  if (variant.name.toLowerCase().contains('release')) {
+                    try {
+                      // Access or create the firebaseCrashlytics extension for this variant
+                      def buildType = android.buildTypes.findByName(variant.buildType.name)
+                      if (buildType != null) {
+                        buildType.configure {
+                          // Check if firebaseCrashlytics extension exists
+                          try {
+                            firebaseCrashlytics {
+                              nativeSymbolUploadEnabled = true
+                            }
+                            appProject.logger.info("RNFirebase: Enabled Crashlytics NDK symbol upload for build type '${variant.buildType.name}'")
+                          } catch (Exception e) {
+                            // Extension might not exist if Crashlytics plugin not applied
+                            appProject.logger.warn("RNFirebase: Could not configure Crashlytics NDK symbol upload for build type '${variant.buildType.name}'. " +
+                              "Ensure the Crashlytics Gradle plugin is applied in your app/build.gradle: ${e.message}")
+                          }
+                        }
+                      }
+                    } catch (Exception e) {
+                      appProject.logger.warn("RNFirebase: Could not configure variant '${variant.name}': ${e.message}")
+                    }
+                  }
+                }
+              } catch (Exception e) {
+                // Fallback: just try to configure the 'release' build type directly
+                appProject.logger.info("RNFirebase: Using fallback approach for NDK symbol upload configuration")
+                try {
+                  android.buildTypes.release {
+                    firebaseCrashlytics {
+                      nativeSymbolUploadEnabled = true
+                    }
+                  }
+                  appProject.logger.info("RNFirebase: Enabled Crashlytics NDK symbol upload for 'release' build type")
+                } catch (Exception fallbackError) {
+                  appProject.logger.warn("RNFirebase: Could not automatically enable Crashlytics NDK symbol upload. " +
+                    "You may need to configure it manually in your app/build.gradle. " +
+                    "See: https://firebase.google.com/docs/crashlytics/android/get-started-ndk#set-up-automatic-native-symbols-upload")
+                }
+              }
+            }
+          } catch (Exception e) {
+            appProject.logger.warn("RNFirebase: Failed to configure automatic Crashlytics NDK symbol upload: ${e.message}")
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/packages/crashlytics/android/src/main/AndroidManifest.xml b/packages/crashlytics/android/src/main/AndroidManifest.xml
@@ -18,6 +18,17 @@
       android:name="firebase_crashlytics_ndk_enabled"
       android:value="${firebaseJsonCrashlyticsNdkEnabled}" />
     
+    <!-- GWP-ASan mode - 'default', 'never', or 'always' -->
+    <!-- Example (in Firebase.json): {
+        "react-native": {
+          "crashlytics_gwp_asan_mode": "default"
+        }
+      }
+    -->
+    <meta-data
+      android:name="com.google.firebase.crashlytics.ndk.gwp_asan_mode"
+      android:value="${firebaseJsonCrashlyticsGwpAsanMode}" />
+    
     <provider
       android:name="io.invertase.firebase.crashlytics.ReactNativeFirebaseCrashlyticsInitProvider"
       android:authorities="${applicationId}.reactnativefirebasecrashlyticsinitprovider"
diff --git a/tests/firebase.json b/tests/firebase.json
@@ -8,6 +8,7 @@
     "app_check_token_auto_refresh": false,
 
     "crashlytics_ndk_enabled": true,
+    "crashlytics_gwp_asan_mode": "default",
     "crashlytics_debug_enabled": true,
     "crashlytics_disable_auto_disabler": true,
     "crashlytics_auto_collection_enabled": true,
