-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
SentryPlugin.kt
336 lines (309 loc) · 16.9 KB
/
SentryPlugin.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
package io.sentry.android.gradle
import com.android.build.api.instrumentation.FramesComputationMode
import com.android.build.api.instrumentation.InstrumentationScope
import com.android.build.api.variant.AndroidComponentsExtension
import com.android.build.gradle.AppExtension
import com.android.build.gradle.internal.utils.setDisallowChanges
import io.sentry.android.gradle.SentryCliProvider.getSentryCliPath
import io.sentry.android.gradle.SentryPropertiesFileProvider.getPropertiesFilePath
import io.sentry.android.gradle.SentryTasksProvider.capitalized
import io.sentry.android.gradle.SentryTasksProvider.getAssembleTaskProvider
import io.sentry.android.gradle.SentryTasksProvider.getBundleTask
import io.sentry.android.gradle.SentryTasksProvider.getMappingFileProvider
import io.sentry.android.gradle.SentryTasksProvider.getMergeAssetsProvider
import io.sentry.android.gradle.SentryTasksProvider.getPackageBundleTask
import io.sentry.android.gradle.SentryTasksProvider.getPackageProvider
import io.sentry.android.gradle.SentryTasksProvider.getPreBundleTask
import io.sentry.android.gradle.SentryTasksProvider.getTransformerTask
import io.sentry.android.gradle.autoinstall.installDependencies
import io.sentry.android.gradle.extensions.SentryPluginExtension
import io.sentry.android.gradle.instrumentation.SpanAddingClassVisitorFactory
import io.sentry.android.gradle.services.SentryModulesService
import io.sentry.android.gradle.tasks.SentryGenerateProguardUuidTask
import io.sentry.android.gradle.tasks.SentryUploadNativeSymbolsTask
import io.sentry.android.gradle.tasks.SentryUploadProguardMappingsTask
import io.sentry.android.gradle.transforms.MetaInfStripTransform
import io.sentry.android.gradle.transforms.MetaInfStripTransform.Companion.metaInfStripped
import io.sentry.android.gradle.util.AgpVersions
import io.sentry.android.gradle.util.GroovyCompat
import io.sentry.android.gradle.util.SentryPluginUtils.capitalizeUS
import io.sentry.android.gradle.util.SentryPluginUtils.isMinificationEnabled
import io.sentry.android.gradle.util.SentryPluginUtils.withLogging
import io.sentry.android.gradle.util.detectSentryAndroidSdk
import io.sentry.android.gradle.util.info
import java.io.File
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.Task
import org.gradle.api.plugins.ExtraPropertiesExtension
import org.gradle.api.tasks.StopExecutionException
import org.gradle.api.tasks.TaskProvider
import org.slf4j.LoggerFactory
@Suppress("UnstableApiUsage")
class SentryPlugin : Plugin<Project> {
override fun apply(project: Project) {
if (AgpVersions.CURRENT < AgpVersions.VERSION_7_0_0) {
throw StopExecutionException(
"""
Using io.sentry.android.gradle:3+ with Android Gradle Plugin < 7 is not supported.
Either upgrade the AGP version to 7+, or use an earlier version of the Sentry
Android Gradle Plugin. For more information check our migration guide
https://docs.sentry.io/platforms/android/migration/#migrating-from-iosentrysentry-android-gradle-plugin-2x-to-iosentrysentry-android-gradle-plugin-300
""".trimIndent()
)
}
val extension = project.extensions.create(
"sentry",
SentryPluginExtension::class.java,
project
)
project.pluginManager.withPlugin("com.android.application") {
val androidExtension = project.extensions.getByType(AppExtension::class.java)
val androidComponentsExtension =
project.extensions.getByType(AndroidComponentsExtension::class.java)
val cliExecutable = getSentryCliPath(project)
val extraProperties = project.extensions.getByName("ext")
as ExtraPropertiesExtension
val sentryOrgParameter = runCatching {
extraProperties.get(SENTRY_ORG_PARAMETER).toString()
}.getOrNull()
val sentryProjectParameter = runCatching {
extraProperties.get(SENTRY_PROJECT_PARAMETER).toString()
}.getOrNull()
// temp folder for sentry-related stuff
val tmpDir = File("${project.buildDir}${sep}tmp${sep}sentry")
tmpDir.mkdirs()
androidComponentsExtension.onVariants { variant ->
if (isVariantAllowed(
extension,
variant.name,
variant.flavorName,
variant.buildType
) && extension.tracingInstrumentation.enabled.get()
) {
/**
* We detect sentry-android SDK version using configurations.incoming.afterResolve.
* This is guaranteed to be executed BEFORE any of the build tasks/transforms are started.
*
* After detecting the sdk state, we use Gradle's shared build service to persist
* the state between builds and also during a single build, because transforms
* are run in parallel.
*/
val sentryModulesService = SentryModulesService.register(project)
project.detectSentryAndroidSdk(
"${variant.name}RuntimeClasspath",
variant.name,
sentryModulesService
)
variant.transformClassesWith(
SpanAddingClassVisitorFactory::class.java,
InstrumentationScope.ALL
) { params ->
if (extension.tracingInstrumentation.forceInstrumentDependencies.get()) {
params.invalidate.setDisallowChanges(System.currentTimeMillis())
}
params.debug.setDisallowChanges(
extension.tracingInstrumentation.debug.get()
)
params.features.setDisallowChanges(
extension.tracingInstrumentation.features.get()
)
params.sentryModulesService.setDisallowChanges(sentryModulesService)
params.tmpDir.set(tmpDir)
}
variant.setAsmFramesComputationMode(
FramesComputationMode.COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS
)
/**
* This necessary to address the issue when target app uses a multi-release jar
* (MR-JAR) as a dependency. https://github.com/getsentry/sentry-android-gradle-plugin/issues/256
*
* We register a transform (https://docs.gradle.org/current/userguide/artifact_transforms.html)
* that will strip-out unnecessary files from the MR-JAR, so the AGP transforms
* will consume corrected artifacts. We only do this when auto-instrumentation is
* enabled (otherwise there's no need in this fix) AND when AGP version
* is below 7.1.2, where this issue has been fixed.
* (https://androidstudio.googleblog.com/2022/02/android-studio-bumblebee-202111-patch-2.html)
*/
if (extension.tracingInstrumentation.enabled.get() &&
AgpVersions.CURRENT < AgpVersions.VERSION_7_1_2
) {
// we are only interested in runtime configuration (as ASM transform is
// also run just for the runtime configuration)
project.configurations.named("${variant.name}RuntimeClasspath")
.configure {
it.attributes.attribute(metaInfStripped, true)
}
MetaInfStripTransform.register(
project.dependencies,
extension.tracingInstrumentation.forceInstrumentDependencies.get()
)
}
}
}
androidExtension.applicationVariants.matching {
isVariantAllowed(extension, it.name, it.flavorName, it.buildType.name)
}.configureEach { variant ->
val bundleTask = withLogging(project.logger, "bundleTask") {
getBundleTask(project, variant.name)
}
val sentryProperties = getPropertiesFilePath(project, variant)
val isMinificationEnabled = isMinificationEnabled(
project,
variant,
extension.experimentalGuardsquareSupport.get()
)
val isDebuggable = variant.buildType.isDebuggable
var preBundleTaskProvider: TaskProvider<Task>? = null
var transformerTaskProvider: TaskProvider<Task>? = null
var packageBundleTaskProvider: TaskProvider<Task>? = null
if (isMinificationEnabled) {
preBundleTaskProvider = withLogging(project.logger, "preBundleTask") {
getPreBundleTask(project, variant.name)
}
transformerTaskProvider = withLogging(project.logger, "transformerTask") {
getTransformerTask(
project,
variant.name,
extension.experimentalGuardsquareSupport.get()
)
}
packageBundleTaskProvider = withLogging(project.logger, "packageBundleTask") {
getPackageBundleTask(project, variant.name)
}
} else {
project.logger.info {
"Minification is not enabled for variant ${variant.name}."
}
}
val taskSuffix = variant.name.capitalizeUS()
if (isMinificationEnabled && extension.includeProguardMapping.get()) {
// Setup the task to generate a UUID asset file
val generateUuidTask = project.tasks.register(
"generateSentryProguardUuid$taskSuffix",
SentryGenerateProguardUuidTask::class.java
) {
it.outputDirectory.set(
project.file(
File(
project.buildDir,
"generated${sep}assets${sep}sentry${sep}${variant.name}"
)
)
)
}
getMergeAssetsProvider(variant)?.configure {
it.dependsOn(generateUuidTask)
}
// Setup the task that uploads the proguard mapping and UUIDs
val uploadSentryProguardMappingsTask = project.tasks.register(
"uploadSentryProguardMappings$taskSuffix",
SentryUploadProguardMappingsTask::class.java
) { task ->
task.dependsOn(generateUuidTask)
task.workingDir(project.rootDir)
task.cliExecutable.set(cliExecutable)
task.sentryProperties.set(
sentryProperties?.let { file -> project.file(file) }
)
task.uuidDirectory.set(generateUuidTask.flatMap { it.outputDirectory })
task.mappingsFiles = getMappingFileProvider(
project,
variant,
extension.experimentalGuardsquareSupport.get()
)
task.autoUploadProguardMapping.set(extension.autoUploadProguardMapping)
task.sentryOrganization.set(sentryOrgParameter)
task.sentryProject.set(sentryProjectParameter)
}
androidExtension.sourceSets.getByName(variant.name).assets.srcDir(
generateUuidTask.flatMap { it.outputDirectory }
)
if (extension.experimentalGuardsquareSupport.get() &&
GroovyCompat.isDexguardEnabledForVariant(project, variant.name)
) {
// If Dexguard is enabled, we will have to wait for the project to be evaluated
// to be able to let the uploadSentryProguardMappings run after them.
project.afterEvaluate {
project.tasks.named(
"dexguardApk${variant.name.capitalized}"
).configure { it.finalizedBy(uploadSentryProguardMappingsTask) }
project.tasks.named(
"dexguardAab${variant.name.capitalized}"
).configure { it.finalizedBy(uploadSentryProguardMappingsTask) }
}
} else {
// we just hack ourselves into the Proguard/R8 task's doLast.
transformerTaskProvider?.configure {
it.finalizedBy(uploadSentryProguardMappingsTask)
}
}
// To include proguard uuid file into aab, run before bundle task.
preBundleTaskProvider?.configure { task ->
task.dependsOn(generateUuidTask)
}
// The package task will only be executed if the generateUuidTask has already been executed.
getPackageProvider(variant)?.configure { task ->
task.dependsOn(generateUuidTask)
}
// App bundle has different package task
packageBundleTaskProvider?.configure { task ->
task.dependsOn(generateUuidTask)
}
}
// only debug symbols of non debuggable code should be uploaded (aka release builds).
// uploadSentryNativeSymbols task will only be executed after the assemble task
// and also only if `uploadNativeSymbols` is enabled, as this is an opt-in feature.
if (!isDebuggable && extension.uploadNativeSymbols.get()) {
// Setup the task to upload native symbols task after the assembling task
val uploadSentryNativeSymbolsTask = project.tasks.register(
"uploadSentryNativeSymbolsFor$taskSuffix",
SentryUploadNativeSymbolsTask::class.java
) {
it.workingDir(project.rootDir)
it.buildDir.set(project.buildDir)
it.autoUploadNativeSymbol.set(extension.autoUploadNativeSymbols)
it.cliExecutable.set(cliExecutable)
it.sentryProperties.set(
sentryProperties?.let { file -> project.file(file) }
)
it.includeNativeSources.set(extension.includeNativeSources)
it.variantName.set(variant.name)
it.sentryOrganization.set(sentryOrgParameter)
it.sentryProject.set(sentryProjectParameter)
}
getAssembleTaskProvider(variant)?.configure {
it.finalizedBy(
uploadSentryNativeSymbolsTask
)
}
// if its a bundle aab, assemble might not be executed, so we hook into bundle task
bundleTask?.configure { it.finalizedBy(uploadSentryNativeSymbolsTask) }
} else {
project.logger.info { "uploadSentryNativeSymbols won't be executed" }
}
}
project.installDependencies(extension)
}
}
private fun isVariantAllowed(
extension: SentryPluginExtension,
variantName: String,
flavorName: String?,
buildType: String?
): Boolean {
return variantName !in extension.ignoredVariants.get() &&
flavorName !in extension.ignoredFlavors.get() &&
buildType !in extension.ignoredBuildTypes.get()
}
companion object {
const val SENTRY_ORG_PARAMETER = "sentryOrg"
const val SENTRY_PROJECT_PARAMETER = "sentryProject"
internal const val SENTRY_SDK_VERSION = "6.4.1"
internal val sep = File.separator
// a single unified logger used by instrumentation
internal val logger by lazy {
LoggerFactory.getLogger(SentryPlugin::class.java)
}
}
}