fix(android): Generate sentry.options.json into build folder instead of source tree #6751
+218
−81
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,17 @@ | ||
| import org.apache.tools.ant.taskdefs.condition.Os | ||
| import org.codehaus.groovy.runtime.DefaultGroovyMethods | ||
| import org.gradle.api.DefaultTask | ||
| import org.gradle.api.file.ConfigurableFileCollection | ||
| import org.gradle.api.file.DirectoryProperty | ||
| import org.gradle.api.provider.Property | ||
| import org.gradle.api.tasks.Exec | ||
| import org.gradle.api.tasks.Input | ||
| import org.gradle.api.tasks.InputFiles | ||
| import org.gradle.api.tasks.Optional | ||
| import org.gradle.api.tasks.OutputDirectory | ||
| import org.gradle.api.tasks.PathSensitive | ||
| import org.gradle.api.tasks.PathSensitivity | ||
| import org.gradle.api.tasks.TaskAction | ||
| import java.io.FileInputStream | ||
| import java.util.Properties | ||
| import java.util.concurrent.atomic.AtomicBoolean | ||
|
|
@@ -78,10 +89,94 @@ | |
| val execOps: org.gradle.process.ExecOperations | ||
| } | ||
|
|
||
| /** | ||
| * Generates `sentry.options.json` into a `build` folder directory registered as a generated assets | ||
| * source, so nothing is written into the version-controlled `src/main/assets` tree. Declared | ||
| * inputs/outputs make it participate in up-to-date checks and the build cache; the action reads only | ||
| * captured inputs and does plain file I/O, so it is Configuration Cache compatible. | ||
| */ | ||
| abstract class GenerateSentryOptionsTask : DefaultTask() { | ||
| // File collection so a missing source is an empty input, not a failure. RELATIVE: only content matters. | ||
| @get:InputFiles | ||
| @get:PathSensitive(PathSensitivity.RELATIVE) | ||
| abstract val sourceOptionsFiles: ConfigurableFileCollection | ||
|
|
||
| @get:Input | ||
| @get:Optional | ||
| abstract val environmentOverride: Property<String> | ||
|
|
||
| @get:Input | ||
| @get:Optional | ||
| abstract val releaseOverride: Property<String> | ||
|
|
||
| @get:Input | ||
| @get:Optional | ||
| abstract val distOverride: Property<String> | ||
|
|
||
| @get:OutputDirectory | ||
| abstract val outputDir: DirectoryProperty | ||
|
|
||
| // The `SENTRY_COPY_OPTIONS_FILE` opt-out. `@Input` (not `onlyIf`) so toggling it re-runs the task, | ||
| // which clears the output dir when disabled — a skipped task would leave a stale file to be packaged. | ||
| @get:Input | ||
| abstract val copyEnabled: Property<Boolean> | ||
|
|
||
| @TaskAction | ||
| fun generate() { | ||
| val outDir = outputDir.get().asFile | ||
| outDir.mkdirs() | ||
| val dest = File(outDir, "sentry.options.json") | ||
| // Idempotent: clear any prior output so a removed source file, or a disabled opt-out, leaves an | ||
| // empty dir rather than packaging a stale file. | ||
| if (dest.exists()) { | ||
| dest.delete() | ||
| } | ||
|
|
||
| if (!copyEnabled.get()) { | ||
| logger.info("sentry.options.json generation disabled via SENTRY_COPY_OPTIONS_FILE; output left empty") | ||
| return | ||
| } | ||
|
|
||
| val source = sourceOptionsFiles.files.firstOrNull { it.exists() } | ||
| if (source == null) { | ||
| logger.warn("sentry.options.json not found in app root; generated assets directory left empty") | ||
| return | ||
| } | ||
|
|
||
| val environment = environmentOverride.orNull | ||
| val release = releaseOverride.orNull | ||
| val dist = distOverride.orNull | ||
|
|
||
| if (environment == null && release == null && dist == null) { | ||
| dest.writeText(source.readText()) | ||
| logger.lifecycle("Generated sentry.options.json into ${dest.parentFile}") | ||
| return | ||
| } | ||
|
|
||
| try { | ||
| @Suppress("UNCHECKED_CAST") | ||
| val content = | ||
| groovy.json.JsonSlurper().parseText(source.readText()) as MutableMap<String, Any> | ||
| if (environment != null) { | ||
| content["environment"] = environment | ||
| logger.lifecycle("Overriding 'environment' from SENTRY_ENVIRONMENT environment variable") | ||
| } | ||
| if (release != null) { | ||
| content["release"] = release | ||
| logger.lifecycle("Overriding 'release' from SENTRY_RELEASE environment variable") | ||
| } | ||
| if (dist != null) { | ||
| content["dist"] = dist | ||
| logger.lifecycle("Overriding 'dist' from SENTRY_DIST environment variable") | ||
| } | ||
| dest.writeText(groovy.json.JsonOutput.toJson(content)) | ||
| } catch (e: Exception) { | ||
| logger.warn("Failed to override options in sentry.options.json: ${e.message}. Copied file as-is.") | ||
| dest.writeText(source.readText()) | ||
| } | ||
| logger.lifecycle("Generated sentry.options.json into ${dest.parentFile}") | ||
| } | ||
| } | ||
|
Check warning on line 179 in packages/core/sentry.gradle.kts
|
||
|
|
||
| extra["shouldCopySentryOptionsFile"] = | ||
| object : groovy.lang.Closure<Boolean>(this) { | ||
|
|
@@ -103,82 +198,132 @@ | |
| } | ||
|
|
||
| val configFile = "sentry.options.json" | ||
|
|
||
| // Captured at configuration time so task actions do not read `project` state at execution time | ||
| // (required for Gradle Configuration Cache compatibility). | ||
| val rootDirFile = project.rootDir | ||
|
|
||
| // Build-folder dir holding the generated `sentry.options.json`, registered as a generated assets | ||
| // source (below) so AGP merges it into the packaged assets with correct task ordering and caching. | ||
| val sentryOptionsGeneratedDir = layout.buildDirectory.dir("generated/sentry/options") | ||
|
|
||
| // Read at configuration time and passed as task inputs so up-to-date checks re-run on change. | ||
| val sentryOptionsEnvironment: String? = System.getenv("SENTRY_ENVIRONMENT") | ||
| val sentryOptionsRelease: String? = System.getenv("SENTRY_RELEASE") | ||
| val sentryOptionsDist: String? = System.getenv("SENTRY_DIST") | ||
|
|
||
| val generateSentryOptionsTask = | ||
| tasks.register("generateSentryOptions", GenerateSentryOptionsTask::class.java) { | ||
| // Opt-out is a task input resolved in afterEvaluate; the action clears output when disabled. | ||
| copyEnabled.convention(true) | ||
| val appRoot = rootDirFile.parentFile ?: rootDirFile | ||
| sourceOptionsFiles.from(File(appRoot, configFile)) | ||
| sentryOptionsEnvironment?.let { environmentOverride.set(it) } | ||
| sentryOptionsRelease?.let { releaseOverride.set(it) } | ||
| sentryOptionsDist?.let { distOverride.set(it) } | ||
| outputDir.set(sentryOptionsGeneratedDir) | ||
|
antonis marked this conversation as resolved.
|
||
| } | ||
|
Check warning on line 225 in packages/core/sentry.gradle.kts
|
||
|
antonis marked this conversation as resolved.
Collaborator
There was a problem hiding this comment. could you check the warden warning?
Contributor
Author
There was a problem hiding this comment. Good catch 👍 I've added a check for this on the tests PR d8e4648 |
||
|
|
||
| // Older plugin versions copied the file into src/main/assets and a crashed build could leave it | ||
| // behind. It would now shadow or clash with the generated one. Warn (never delete — it may be | ||
| // intentional) so the user can remove the stale copy. | ||
| val legacyOptionsFile = File(project.projectDir, "src/main/assets/$configFile") | ||
| if (legacyOptionsFile.exists()) { | ||
| project.logger.warn( | ||
| "[sentry] Found a stale $configFile in src/main/assets; it is now generated into the build " + | ||
| "folder and the old copy may conflict. Please remove: ${legacyOptionsFile.absolutePath}", | ||
| ) | ||
| } | ||
|
|
||
| // Guards the classic source-set fallback so it registers at most once, only when the variant API is absent. | ||
| val sentryOptionsSourceSetFallbackApplied = AtomicBoolean(false) | ||
|
|
||
| fun applySentryOptionsSourceSetFallback() { | ||
| if (!sentryOptionsSourceSetFallbackApplied.compareAndSet(false, true)) return | ||
| try { | ||
| val android = extensions.getByName("android") | ||
| val sourceSets = android.javaClass.getMethod("getSourceSets").invoke(android) | ||
| val getByName = | ||
| sourceSets.javaClass.methods.first { it.name == "getByName" && it.parameterCount == 1 } | ||
| val mainSourceSet = getByName.invoke(sourceSets, "main") | ||
| val assets = mainSourceSet.javaClass.getMethod("getAssets").invoke(mainSourceSet) | ||
| val srcDir = | ||
| assets.javaClass.methods.first { | ||
| it.name == "srcDir" && it.parameterCount == 1 && it.parameterTypes[0] == Any::class.java | ||
| } | ||
| srcDir.invoke(assets, sentryOptionsGeneratedDir.get().asFile) | ||
| tasks | ||
| .matching { it.name.startsWith("merge") && it.name.endsWith("Assets") } | ||
| .configureEach { dependsOn(generateSentryOptionsTask) } | ||
| project.logger.info("[sentry] Wired sentry.options.json into assets via sourceSets fallback") | ||
| } catch (e: Exception) { | ||
| project.logger.warn( | ||
| "[sentry] Failed to wire sentry.options.json into assets: ${e.message}. " + | ||
| "sentry.options.json may not be packaged. Please report this issue at " + | ||
| "https://github.com/getsentry/sentry-react-native/issues", | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| // Wires the generated dir into a variant's assets via `addGeneratedSourceDirectory` (AGP 7.3+), | ||
| // reflectively since a script plugin can't depend on AGP types. Falls back to the source set otherwise. | ||
| fun wireSentryOptionsAssets(variant: Any) { | ||
| try { | ||
| val sources = variant.javaClass.getMethod("getSources").invoke(variant) | ||
| val assets = sources.javaClass.getMethod("getAssets").invoke(sources) | ||
| val addMethod = | ||
| assets?.javaClass?.methods?.firstOrNull { it.name == "addGeneratedSourceDirectory" } | ||
| if (assets == null || addMethod == null) { | ||
| applySentryOptionsSourceSetFallback() | ||
| return | ||
| } | ||
| val wiredWith: (GenerateSentryOptionsTask) -> DirectoryProperty = { it.outputDir } | ||
| addMethod.invoke(assets, generateSentryOptionsTask, wiredWith) | ||
| } catch (e: Exception) { | ||
| project.logger.info("[sentry] variant assets wiring failed: ${e.message}. Falling back to sourceSets.") | ||
| applySentryOptionsSourceSetFallback() | ||
| } | ||
| } | ||
|
|
||
| plugins.withId("com.android.application") { | ||
| try { | ||
| val androidComponents = extensions.getByName("androidComponents") | ||
| val selector = androidComponents.javaClass.getMethod("selector").invoke(androidComponents) | ||
| val allSelector = selector.javaClass.getMethod("all").invoke(selector) | ||
| val onVariantsMethod = | ||
| androidComponents.javaClass.methods.find { | ||
| it.name == "onVariants" && it.parameterCount == 2 && it.parameterTypes[1].isInterface | ||
| } ?: throw NoSuchMethodException("onVariants with 2 parameters (Action interface) not found") | ||
| val actionType = onVariantsMethod.parameterTypes[1] | ||
|
|
||
| // Runs for every variant (including debug), so sentry.options.json is packaged in all builds. | ||
| onVariantsMethod.invoke( | ||
| androidComponents, | ||
| allSelector, | ||
| java.lang.reflect.Proxy.newProxyInstance( | ||
| actionType.classLoader, | ||
| arrayOf(actionType), | ||
| ) { _, _, args -> | ||
| val variant = args?.getOrNull(0) | ||
| if (variant != null) { | ||
| wireSentryOptionsAssets(variant) | ||
| } | ||
| null | ||
| }, | ||
| ) | ||
| } catch (e: Exception) { | ||
| project.logger.info( | ||
| "[sentry] Variant assets API unavailable (${e.message}); using sourceSets fallback for sentry.options.json.", | ||
| ) | ||
| applySentryOptionsSourceSetFallback() | ||
| } | ||
|
|
||
| // AGP wires `merge*Assets` to `generateSentryOptions` via the generated-source API, but the lint | ||
| // model/analysis tasks also read the generated assets dir without a declared dependency, which | ||
| // Gradle 9 fails on. Declare it explicitly so the file is always produced before they run. | ||
| tasks | ||
| .matching { it.name != "generateSentryOptions" && it.name.contains("lint", ignoreCase = true) } | ||
| .configureEach { dependsOn(generateSentryOptionsTask) } | ||
| } | ||
|
|
||
| data class BundleTaskArgs( | ||
|
|
@@ -802,19 +947,10 @@ | |
| } | ||
|
|
||
| project.afterEvaluate { | ||
| // Resolve the overridable closure now (after the app build.gradle evaluated) so an override placed | ||
| // after `apply from` is honored, and set it on the task for its onlyIf to read. | ||
| val optionsCopyEnabled = shouldCopySentryOptionsFile() | ||
| generateSentryOptionsTask.configure { copyEnabled.set(optionsCopyEnabled) } | ||
|
|
||
| val flavorAware = config["flavorAware"] == true | ||
| val sentryProperties = config["sentryProperties"] | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.