GenerateRnSourcemapTaskRegistration improvements (#2214)

priettt · web-flow · commit f4cb1a8509aa · 2025-06-02T14:47:03.000-03:00
diff --git a/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/build.gradle b/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/build.gradle
@@ -0,0 +1,17 @@
+plugins {
+    id("com.android.application")
+    id("io.embrace.swazzler")
+    id("io.embrace.android.testplugin")
+}
+
+repositories {
+    google()
+    mavenCentral()
+    mavenLocal()
+}
+
+integrationTest.configureAndroidProject(project)
+
+embrace {
+    autoAddEmbraceDependencies.set(true)
+}
diff --git a/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/proguard-rules.pro b/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/proguard-rules.pro
@@ -0,0 +1,2 @@
+-keep class com.example.app.Foo { *; }
+-keep class io.embrace.android.embracesdk.internal.config.instrumented.* { *; }
diff --git a/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/AndroidManifest.xml b/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/AndroidManifest.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest />
diff --git a/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/embrace-config.json b/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/embrace-config.json
@@ -0,0 +1,5 @@
+{
+  "app_id": "abcde",
+  "api_token": "12345123451234512345123451234512",
+  "ndk_enabled": true
+}
diff --git a/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/java/com/example/app/Bar.java b/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/java/com/example/app/Bar.java
@@ -0,0 +1,7 @@
+package com.example.app;
+
+public class Bar {
+    public static String getBar() {
+        return "bar";
+    }
+}
diff --git a/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/java/com/example/app/Foo.java b/embrace-gradle-plugin-integration-tests/fixtures/not-react-native-android/android/src/main/java/com/example/app/Foo.java
@@ -0,0 +1,7 @@
+package com.example.app;
+
+public class Foo {
+    public static String getFoo() {
+        return "foo";
+    }
+}
diff --git a/embrace-gradle-plugin-integration-tests/src/main/java/io/embrace/android/gradle/integration/framework/SetupInterface.kt b/embrace-gradle-plugin-integration-tests/src/main/java/io/embrace/android/gradle/integration/framework/SetupInterface.kt
@@ -40,6 +40,11 @@ class SetupInterface(
         enqueueResponse(endpoint, response)
     }
 
+    fun SetupInterface.setupEmptyHandshakeResponse() {
+        val json = serializeRequestBody(NdkUploadHandshakeResponse(null))
+        enqueueResponse(EmbraceEndpoint.NDK_HANDSHAKE, MockResponse().setBody(json))
+    }
+
     fun SetupInterface.setupMapResponseWithEmptyValues(endpoint: EmbraceEndpoint) {
         val response = """
             {
diff --git a/embrace-gradle-plugin-integration-tests/src/test/java/io/embrace/android/gradle/integration/testcases/ReactNativeAndroidTest.kt b/embrace-gradle-plugin-integration-tests/src/test/java/io/embrace/android/gradle/integration/testcases/ReactNativeAndroidTest.kt
@@ -48,11 +48,43 @@ class ReactNativeAndroidTest {
                 installNodeModules(projectDir)
                 setupMockResponses(handshakeLibs, handshakeArchs, defaultExpectedVariants)
             },
-            assertions = { projectDir ->
+            assertions = {
                 verifyBuildTelemetryRequestSent(defaultExpectedVariants)
                 verifyHandshakes(defaultExpectedLibs, defaultExpectedArchs, defaultExpectedVariants)
                 verifyUploads(handshakeLibs, handshakeArchs, defaultExpectedVariants)
-                verifyAsmInjection(projectDir)
+            }
+        )
+    }
+
+    @Test
+    fun `react native asm injection test`() {
+        rule.runTest(
+            fixture = "react-native-android",
+            androidProjectRoot = "android",
+            task = "assembleRelease",
+            setup = { projectDir ->
+                setupEmptyHandshakeResponse()
+                installNodeModules(projectDir)
+            },
+            assertions = { projectDir ->
+                verifyAsmInjection(File(projectDir, "app"), "765FB008173DC25D016D112F67250241")
+            }
+        )
+    }
+
+    @Test
+    fun `react native project without bundle or sourcemap`() {
+        rule.runTest(
+            fixture = "not-react-native-android",
+            androidProjectRoot = "android",
+            additionalArgs = listOf("-Pandroid.useAndroidX=true"),
+            task = "assembleRelease",
+            setup = {
+                setupEmptyHandshakeResponse()
+            },
+            assertions = { projectDir ->
+                verifyNoUploads()
+                verifyAsmInjection(projectDir, null)
             }
         )
     }
@@ -71,10 +103,10 @@ class ReactNativeAndroidTest {
         }
     }
 
-    private fun verifyAsmInjection(projectDir: File) {
+    private fun verifyAsmInjection(buildDir: File, expectedBundleId: String?) {
         // Read and parse the smali file containing the injected symbols
         val smaliFile = SmaliConfigReader().readSmaliFiles(
-            File(projectDir, "app"),
+            buildDir,
             listOf("/io/embrace/android/embracesdk/internal/config/instrumented/ProjectConfigImpl")
         ).first()
 
@@ -84,6 +116,6 @@ class ReactNativeAndroidTest {
             listOf(SmaliMethod("getReactNativeBundleId()Ljava/lang/String;"))
         ).methods.first()
 
-        assertEquals("765FB008173DC25D016D112F67250241", method.returnValue)
+        assertEquals(expectedBundleId, method.returnValue)
     }
 }
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImpl.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImpl.kt
@@ -53,7 +53,7 @@ class PluginBehaviorImpl(
     }
 
     override val isReactNativeProject: Boolean by lazy {
-        val rootFile = project.layout.projectDirectory.asFile.parentFile?.parentFile
+        val rootFile = project.rootDir.parentFile
         if (rootFile != null) {
             val nodeModules = File("${rootFile.path}/node_modules")
             val nodeModulesEmbrace = File("${nodeModules.path}/react-native")
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/reactnative/GenerateRnSourcemapTask.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/reactnative/GenerateRnSourcemapTask.kt
@@ -16,6 +16,8 @@ import org.gradle.api.model.ObjectFactory
 import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.OutputFile
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.TaskAction
 import java.io.File
 import javax.inject.Inject
@@ -29,12 +31,14 @@ abstract class GenerateRnSourcemapTask @Inject constructor(
 
     private val logger = Logger(GenerateRnSourcemapTask::class.java)
 
-    @get:Optional
+    @Optional
     @get:InputFile
+    @get:PathSensitive(PathSensitivity.NONE)
     val sourcemap: RegularFileProperty = objectFactory.fileProperty()
 
-    @get:Optional
+    @Optional
     @get:InputFile
+    @get:PathSensitive(PathSensitivity.NONE)
     val bundleFile: RegularFileProperty = objectFactory.fileProperty()
 
     @get:OutputFile
@@ -45,22 +49,17 @@ abstract class GenerateRnSourcemapTask @Inject constructor(
 
     @TaskAction
     fun onRun() {
-        val bundleFile = bundleFile.orNull?.asFile
+        val bundleFile = bundleFile.asFile.orNull
         if (bundleFile == null || !bundleFile.exists()) {
-            logger.error("Couldn't find the JSBundle. React native files were not uploaded.")
+            logger.error("JSBundle not found. React Native files were not uploaded.")
             return
         }
 
         val bundleId = calculateMD5ForFile(bundleFile)
 
-        /**
-         * In old React Native Versions, the source map is not exposed as output in the task.
-         * If the source map is not present, we will search for it in the known location
-         */
-        val sourceMapFile: File? = sourcemap.orNull?.asFile
-
+        val sourceMapFile = sourcemap.asFile.orNull
         if (sourceMapFile == null || !sourceMapFile.exists()) {
-            logger.error("Couldn't find the Source Map. React native files were not uploaded.")
+            logger.error("Sourcemap not found. React Native files were not uploaded.")
             return
         }
 
diff --git a/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/reactnative/GenerateRnSourcemapTaskRegistration.kt b/embrace-gradle-plugin/src/main/java/io/embrace/android/gradle/plugin/tasks/reactnative/GenerateRnSourcemapTaskRegistration.kt
@@ -1,18 +1,18 @@
 package io.embrace.android.gradle.plugin.tasks.reactnative
 
-import io.embrace.android.gradle.plugin.Logger
 import io.embrace.android.gradle.plugin.gradle.nullSafeMap
 import io.embrace.android.gradle.plugin.gradle.registerTask
+import io.embrace.android.gradle.plugin.gradle.safeFlatMap
 import io.embrace.android.gradle.plugin.gradle.tryGetTaskProvider
 import io.embrace.android.gradle.plugin.model.AndroidCompactedVariantData
 import io.embrace.android.gradle.plugin.network.EmbraceEndpoint
 import io.embrace.android.gradle.plugin.tasks.common.RequestParams
 import io.embrace.android.gradle.plugin.tasks.registration.EmbraceTaskRegistration
 import io.embrace.android.gradle.plugin.tasks.registration.RegistrationParams
+import io.embrace.android.gradle.plugin.util.capitalizedString
 import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.provider.Provider
-import org.gradle.api.tasks.TaskProvider
 import java.io.File
 
 private const val REACT_PROPERTY = "react"
@@ -24,100 +24,70 @@ private const val SOURCE_MAP_NAME = "android-embrace.bundle.map"
 
 class GenerateRnSourcemapTaskRegistration : EmbraceTaskRegistration {
 
-    private val logger = Logger(GenerateRnSourcemapTaskRegistration::class.java)
-
     override fun register(params: RegistrationParams) {
-        params.project.afterEvaluate {
-            params.execute()
-        }
+        params.execute()
     }
 
     /**
      * Given the build variant, attempts to register the RN Source Map generator task into the
-     * build variant's build
-     * process.
-     * <p>
-     * We choose process${variant}JavaRes and compile${variant}JavaWithJavac tasks as anchor
-     * for the ReactNativeBundleRetrieverTask because it's a safe stage to assume that both, the
-     * bundle and the Source Map, have been already generated.
+     * build variant's build process.
      */
-    private fun RegistrationParams.execute(): TaskProvider<GenerateRnSourcemapTask>? {
+    private fun RegistrationParams.execute() {
         // Prevent upload the bundle in debug variant
         if (data.isBuildTypeDebuggable) {
-            return null
-        }
-
-        val variantCapitalized = variant.name
-            .replaceFirstChar { if (it.isLowerCase()) it.titlecase() else it.toString() }
-
-        // React Native started to use this task after version 0.71 +
-        val newRNSourceFilesGeneratorTask = "createBundle${variantCapitalized}JsAndAssets"
-
-        // For React Native versions prior to 0.71, this task is used to generate and copy the
-        // source map and bundle files into the APK/AAB before packaging
-        val oldRNSourceFilesGeneratorTask = "bundle${variantCapitalized}JsAndAssets"
-
-        val generatorTask = project.tryGetTaskProvider(newRNSourceFilesGeneratorTask)
-            ?: project.tryGetTaskProvider(oldRNSourceFilesGeneratorTask)
-
-        if (generatorTask == null || !generatorTask.isPresent) {
-            logger.error(
-                "We could not find the task that generates the Bundle. Please submit the Bundle and Source Map manually." +
-                    "https://embrace.io/docs/react-native/integration/upload-symbol-files/?platform=android#symbolication-with-codepush"
-            )
-            return null
+            return
         }
 
-        return createRnSourcemapGeneratorTaskProvider(generatorTask)
-    }
-
-    private fun RegistrationParams.createRnSourcemapGeneratorTaskProvider(
-        generatorTask: TaskProvider<Task>,
-    ) = project.registerTask(
-        GenerateRnSourcemapTask.NAME,
-        GenerateRnSourcemapTask::class.java,
-        data
-    ) { rnTask ->
-        try {
+        project.registerTask(
+            GenerateRnSourcemapTask.NAME,
+            GenerateRnSourcemapTask::class.java,
+            data
+        ) { rnTask ->
             val embraceConfig = variantConfigurationsListProperty.get().first { it.variantName == variant.name }.embraceConfig
             rnTask.requestParams.set(
-                project.provider {
+                behavior.failBuildOnUploadErrors.map { failBuildOnUploadErrors ->
                     RequestParams(
                         appId = embraceConfig?.appId.orEmpty(),
                         apiToken = embraceConfig?.apiToken.orEmpty(),
                         endpoint = EmbraceEndpoint.SOURCE_MAP,
                         fileName = FILE_NAME_SOURCE_MAP_JSON,
                         baseUrl = behavior.baseUrl,
-                        failBuildOnUploadErrors = behavior.failBuildOnUploadErrors.get(),
+                        failBuildOnUploadErrors = failBuildOnUploadErrors,
                     )
                 }
             )
 
-            rnTask.bundleFile.set(project.layout.file(getBundleFileProvider(generatorTask, project)))
-            rnTask.sourcemap.set(project.layout.file(getSourcemapFileProvider(generatorTask, project, data)))
+            val variantCapitalized = variant.name.capitalizedString()
+            val generatorTaskProvider: Provider<Task?> = project.provider {
+                project.tryGetTaskProvider("createBundle${variantCapitalized}JsAndAssets")
+            }.safeFlatMap { it as Provider<Task?> }
+
+            rnTask.bundleFile.set(project.layout.file(getBundleFileProvider(generatorTaskProvider, project)))
+            rnTask.sourcemap.set(project.layout.file(getSourcemapFileProvider(generatorTaskProvider, project, data)))
 
-            val flavorName = data.flavorName
-            val buildTypeName = data.buildTypeName
-            val bundleFileFolder = if (flavorName.isBlank()) buildTypeName else "$flavorName/$buildTypeName"
             rnTask.sourcemapAndBundleFile.set(
                 project.layout.buildDirectory.file(
-                    "outputs/embrace/$bundleFileFolder/$FILE_NAME_SOURCE_MAP_JSON"
+                    "outputs/embrace/${data.name}/$FILE_NAME_SOURCE_MAP_JSON"
                 )
             )
 
             rnTask.bundleIdOutputFile.set(
                 project.layout.buildDirectory.file("intermediates/embrace/react/${data.name}/bundleId.txt")
             )
 
-            rnTask.dependsOn(generatorTask)
-        } catch (e: Exception) {
-            logger.error("EmbraceRNSourcemapGeneratorTask failed while getting the Bundle and the SourceMap", e)
+            // We need an explicit dependsOn because it seems task.outputs.files.asFileTree.elements, inside getBundleFileProvider
+            // and getSourcemapFileProvider, is not carrying dependencies, even when we access it through safeFlatMap.
+            // As dependsOn doesn't accept a provider { null }, we need to create a new provider that returns an empty list.
+            val dependsOnTaskProvider = project.provider {
+                project.tryGetTaskProvider("createBundle${variantCapitalized}JsAndAssets") ?: emptyList<Task>()
+            }
+            rnTask.dependsOn(dependsOnTaskProvider)
         }
     }
 
-    private fun getBundleFileProvider(generatorTask: TaskProvider<Task>, project: Project): Provider<File?> =
-        generatorTask.flatMap { task ->
-            task.outputs.files.asFileTree.elements.flatMap { fileLocations ->
+    private fun getBundleFileProvider(generatorTask: Provider<Task?>, project: Project): Provider<File?> =
+        generatorTask.safeFlatMap { task ->
+            task?.outputs?.files?.asFileTree?.elements?.safeFlatMap { fileLocations ->
                 val bundleFile = fileLocations.firstOrNull { location ->
                     location.asFile.name.endsWith(RN_BUNDLE_FILE_EXTENSION)
                 }?.asFile
@@ -127,7 +97,7 @@ class GenerateRnSourcemapTaskRegistration : EmbraceTaskRegistration {
                 } else {
                     findBundleFile(project)
                 }
-            }
+            } ?: findBundleFile(project)
         }
 
     /**
@@ -142,12 +112,12 @@ class GenerateRnSourcemapTaskRegistration : EmbraceTaskRegistration {
     }
 
     private fun getSourcemapFileProvider(
-        generatorTask: TaskProvider<Task>,
+        generatorTask: Provider<Task?>,
         project: Project,
         data: AndroidCompactedVariantData,
     ): Provider<File?> =
-        generatorTask.flatMap { task ->
-            task.outputs.files.asFileTree.elements.flatMap { fileLocations ->
+        generatorTask.safeFlatMap { task ->
+            task?.outputs?.files?.asFileTree?.elements?.flatMap { fileLocations ->
                 val sourcemapFile = fileLocations.firstOrNull { location ->
                     location.asFile.name.endsWith(RN_SOURCEMAP_FILE_EXTENSION)
                 }?.asFile
@@ -157,7 +127,7 @@ class GenerateRnSourcemapTaskRegistration : EmbraceTaskRegistration {
                 } else {
                     findSourcemapFile(project, data)
                 }
-            }
+            } ?: findSourcemapFile(project, data)
         }
 
     private fun findSourcemapFile(project: Project, data: AndroidCompactedVariantData): Provider<File?> {
diff --git a/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImplTest.kt b/embrace-gradle-plugin/src/test/java/io/embrace/android/gradle/plugin/config/PluginBehaviorImplTest.kt
@@ -272,9 +272,7 @@ class PluginBehaviorImplTest {
     }
 
     private fun findRnNodeModulesDir(): File {
-        val rootFile = project.layout.projectDirectory.asFile.parentFile?.parentFile
-            ?: error("Parent directory of project root is null")
-
+        val rootFile = project.rootDir.parentFile ?: error("Parent directory of project root is null")
         return File("${File("${rootFile.path}/node_modules").path}/react-native")
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+-keep class com.example.app.Foo { *; }`
	`2`	`+-keep class io.embrace.android.embracesdk.internal.config.instrumented.* { *; }`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="utf-8"?>`
	`2`	`+<manifest />`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,11 @@ class SetupInterface(`
`40`	`40`	`enqueueResponse(endpoint, response)`
`41`	`41`	`}`
`42`	`42`
	`43`	`+ fun SetupInterface.setupEmptyHandshakeResponse() {`
	`44`	`+ val json = serializeRequestBody(NdkUploadHandshakeResponse(null))`
	`45`	`+ enqueueResponse(EmbraceEndpoint.NDK_HANDSHAKE, MockResponse().setBody(json))`
	`46`	`+ }`
	`47`	`+`
`43`	`48`	`fun SetupInterface.setupMapResponseWithEmptyValues(endpoint: EmbraceEndpoint) {`
`44`	`49`	`val response = """`
`45`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class PluginBehaviorImpl(`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`override val isReactNativeProject: Boolean by lazy {`
`56`		`- val rootFile = project.layout.projectDirectory.asFile.parentFile?.parentFile`
	`56`	`+ val rootFile = project.rootDir.parentFile`
`57`	`57`	`if (rootFile != null) {`
`58`	`58`	`val nodeModules = File("${rootFile.path}/node_modules")`
`59`	`59`	`val nodeModulesEmbrace = File("${nodeModules.path}/react-native")`