Create a debugOptimized buildType for Android (#52648)

Summary:
Pull Request resolved: #52648

This creates a `debugOptimized` build type for React Native Android, meaning that we can run C++ optimization on the debug build, while still having the debugger enabled. This is aimed at improving the developer experience for folks developing on low-end devices or emulators.

Users that intend to debug can still use the `debug` variant where the full debug symbols are shipped.

Changelog:

[ANDROID] [ADDED] - Create a debugOptimized buildType for Android

Reviewed By: cipolleschi

Differential Revision: D78425138

Author: cortinico

packages/gradle-plugin/react-native-gradle-plugin/src/main/kotlin/com/facebook/react/ReactExtension.kt

@@ -100,10 +100,10 @@ abstract class ReactExtension @Inject constructor(val project: Project) {
    * Allows to specify the debuggable variants (by default just 'debug'). Variants in this list will
    * not be bundled (the bundle file will not be created and won't be copied over).
    *
-   * Default: ['debug']
+   * Default: ['debug', 'debugOptimized']
    */
   val debuggableVariants: ListProperty<String> =
-      objects.listProperty(String::class.java).convention(listOf("debug"))
+      objects.listProperty(String::class.java).convention(listOf("debug", "debugOptimized"))
 
   /** Hermes Config */
 

packages/gradle-plugin/react-native-gradle-plugin/src/main/kotlin/com/facebook/react/utils/AgpConfiguratorUtils.kt

@@ -42,6 +42,16 @@ internal object AgpConfiguratorUtils {
                   getByName("release").apply {
                     manifestPlaceholders["usesCleartextTraffic"] = "false"
                   }
+                  maybeCreate("debugOptimized").apply {
+                    manifestPlaceholders["usesCleartextTraffic"] = "true"
+                    initWith(debug)
+                    externalNativeBuild {
+                      cmake {
+                        arguments("-DCMAKE_BUILD_TYPE=Release")
+                        matchingFallbacks += listOf("release")
+                      }
+                    }
+                  }
                 }
               }
         }

packages/react-native/ReactAndroid/build.gradle.kts

@@ -599,14 +599,23 @@ android {
   publishing {
     multipleVariants {
       withSourcesJar()
-      includeBuildTypeValues("debug", "release")
+      includeBuildTypeValues("debug", "release", "debugOptimized")
     }
   }
 
   testOptions {
     unitTests { isIncludeAndroidResources = true }
     targetSdk = libs.versions.targetSdk.get().toInt()
   }
+
+  buildTypes {
+    create("debugOptimized") {
+      initWith(getByName("debug"))
+      externalNativeBuild {
+        cmake { arguments("-DCMAKE_BUILD_TYPE=Release", "-DREACT_NATIVE_DEBUG_OPTIMIZED=True") }
+      }
+    }
+  }
 }
 
 tasks.withType<KotlinCompile>().configureEach {

packages/react-native/ReactAndroid/hermes-engine/build.gradle.kts

@@ -306,6 +306,12 @@ android {
         }
       }
     }
+    buildTypes {
+      create("debugOptimized") {
+        initWith(getByName("debug"))
+        externalNativeBuild { cmake { arguments("-DCMAKE_BUILD_TYPE=Release") } }
+      }
+    }
   }
 
   sourceSets.getByName("main") {

packages/react-native/ReactAndroid/src/main/jni/react/hermes/reactexecutor/CMakeLists.txt

@@ -25,4 +25,6 @@ target_link_libraries(
         reactnative
 )
 target_compile_reactnative_options(hermes_executor PRIVATE)
-target_compile_options(hermes_executor PRIVATE $<$<CONFIG:Debug>:-DHERMES_ENABLE_DEBUGGER=1>)
+if(${CMAKE_BUILD_TYPE} MATCHES Debug OR REACT_NATIVE_DEBUG_OPTIMIZED)
+  target_compile_options(hermes_executor PRIVATE -DHERMES_ENABLE_DEBUGGER=1)
+endif()

packages/react-native/ReactAndroid/src/main/jni/react/runtime/hermes/jni/CMakeLists.txt

@@ -27,4 +27,6 @@ target_link_libraries(hermesinstancejni
 )
 
 target_compile_reactnative_options(hermesinstancejni PRIVATE)
-target_compile_options(hermesinstancejni PRIVATE $<$<CONFIG:Debug>:-DHERMES_ENABLE_DEBUGGER=1>)
+if(${CMAKE_BUILD_TYPE} MATCHES Debug OR REACT_NATIVE_DEBUG_OPTIMIZED)
+  target_compile_options(hermesinstancejni PRIVATE -DHERMES_ENABLE_DEBUGGER=1)
+endif ()

packages/react-native/ReactAndroid/src/main/jni/react/runtime/jni/CMakeLists.txt

@@ -17,7 +17,9 @@ add_library(rninstance
 )
 
 target_compile_reactnative_options(rninstance PRIVATE)
-target_compile_options(rninstance PRIVATE $<$<CONFIG:Debug>:-DHERMES_ENABLE_DEBUGGER=1>)
+if(${CMAKE_BUILD_TYPE} MATCHES Debug OR REACT_NATIVE_DEBUG_OPTIMIZED)
+  target_compile_options(rninstance PRIVATE -DHERMES_ENABLE_DEBUGGER=1)
+endif ()
 
 target_merge_so(rninstance)
 target_include_directories(rninstance PUBLIC .)

packages/react-native/ReactCommon/hermes/executor/CMakeLists.txt

@@ -26,7 +26,7 @@ target_link_libraries(hermes_executor_common
 )
 
 target_compile_reactnative_options(hermes_executor_common PRIVATE)
-if(${CMAKE_BUILD_TYPE} MATCHES Debug)
+if(${CMAKE_BUILD_TYPE} MATCHES Debug OR REACT_NATIVE_DEBUG_OPTIMIZED)
         target_compile_options(
                 hermes_executor_common
                 PRIVATE

packages/react-native/ReactCommon/hermes/inspector-modern/CMakeLists.txt

@@ -17,7 +17,7 @@ add_library(hermes_inspector_modern
 
 target_compile_reactnative_options(hermes_inspector_modern PRIVATE)
 
-if(${CMAKE_BUILD_TYPE} MATCHES Debug)
+if(${CMAKE_BUILD_TYPE} MATCHES Debug OR REACT_NATIVE_DEBUG_OPTIMIZED)
         target_compile_options(
                 hermes_inspector_modern
                 PRIVATE

packages/react-native/ReactCommon/jsinspector-modern/CMakeLists.txt

@@ -28,7 +28,9 @@ target_link_libraries(jsinspector
         reactperflogger
 )
 target_compile_reactnative_options(jsinspector PRIVATE)
-target_compile_options(jsinspector PRIVATE
-        $<$<CONFIG:Debug>:-DREACT_NATIVE_DEBUGGER_ENABLED=1>
-        $<$<CONFIG:Debug>:-DREACT_NATIVE_DEBUGGER_ENABLED_DEVONLY=1>
-)
+if(${CMAKE_BUILD_TYPE} MATCHES Debug OR REACT_NATIVE_DEBUG_OPTIMIZED)
+  target_compile_options(jsinspector PRIVATE
+          -DREACT_NATIVE_DEBUGGER_ENABLED=1
+          -DREACT_NATIVE_DEBUGGER_ENABLED_DEVONLY=1
+  )
+endif ()