-
-
Notifications
You must be signed in to change notification settings - Fork 32
/
SentryPlugin.kt
232 lines (209 loc) · 11 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
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.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.instrumentation.SpanAddingClassVisitorFactory
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.util.SentryPluginUtils.capitalizeUS
import io.sentry.android.gradle.util.SentryPluginUtils.withLogging
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.TaskProvider
@Suppress("UnstableApiUsage")
class SentryPlugin : Plugin<Project> {
private val sep = File.separator
override fun apply(project: Project) {
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()
) {
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.tmpDir.set(tmpDir)
}
variant.setAsmFramesComputationMode(
FramesComputationMode.COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS
)
}
}
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 isMinifyEnabled = variant.buildType.isMinifyEnabled
val isDebuggable = variant.buildType.isDebuggable
var preBundleTaskProvider: TaskProvider<Task>? = null
var transformerTaskProvider: TaskProvider<Task>? = null
var packageBundleTaskProvider: TaskProvider<Task>? = null
if (isMinifyEnabled) {
preBundleTaskProvider = withLogging(project.logger, "preBundleTask") {
getPreBundleTask(project, variant.name)
}
transformerTaskProvider = withLogging(project.logger, "transformerTask") {
getTransformerTask(project, variant.name)
}
packageBundleTaskProvider = withLogging(project.logger, "packageBundleTask") {
getPackageBundleTask(project, variant.name)
}
} else {
project.logger.info(
"[sentry] isMinifyEnabled is false for variant ${variant.name}."
)
}
val taskSuffix = variant.name.capitalizeUS()
if (isMinifyEnabled) {
// Setup the task to generate a UUID asset file
val uuidOutputDirectory = project.file(
File(
project.buildDir,
"generated${sep}assets${sep}sentry${sep}${variant.name}"
)
)
val generateUuidTask = project.tasks.register(
"generateSentryProguardUuid$taskSuffix",
SentryGenerateProguardUuidTask::class.java
) {
it.outputDirectory.set(uuidOutputDirectory)
}
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
) {
it.dependsOn(generateUuidTask)
it.workingDir(project.rootDir)
it.cliExecutable.set(cliExecutable)
it.sentryProperties.set(
sentryProperties?.let { file -> project.file(file) }
)
it.uuidDirectory.set(uuidOutputDirectory)
it.mappingsFiles = getMappingFileProvider(variant)
it.autoUpload.set(extension.autoUpload)
it.sentryOrganization.set(sentryOrgParameter)
it.sentryProject.set(sentryProjectParameter)
}
androidExtension.sourceSets.getByName(variant.name).assets.srcDir(
uuidOutputDirectory
)
// we just hack ourselves into the proguard task's doLast.
transformerTaskProvider?.configure {
it.finalizedBy(uploadSentryProguardMappingsTask)
}
// To include proguard uuid file into aab, run before bundle task.
preBundleTaskProvider?.configure { task ->
task.dependsOn(uploadSentryProguardMappingsTask)
}
// The package task will only be executed if the uploadSentryProguardMappingsTask has already been executed.
getPackageProvider(variant)?.configure { task ->
task.dependsOn(uploadSentryProguardMappingsTask)
}
// App bundle has different package task
packageBundleTaskProvider?.configure { task ->
task.dependsOn(uploadSentryProguardMappingsTask)
}
}
// 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("[sentry] uploadSentryNativeSymbols won't be executed")
}
}
}
}
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"
}
}