perf(instrumentation): Resolve SDK class availability at build time #1375
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
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 | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,10 @@ | ||||||
| package io.sentry.android.gradle.extensions | ||||||
|
|
||||||
| import javax.inject.Inject | ||||||
| import org.gradle.api.model.ObjectFactory | ||||||
| import org.gradle.api.provider.Property | ||||||
|
|
||||||
|
Contributor
There was a problem hiding this comment. Should we name this |
||||||
| open class SdkOptimizationExtension @Inject constructor(objects: ObjectFactory) { | ||||||
| /** Enables build-time optimizations of the Sentry SDK. Defaults to true. */ | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||
| val enabled: Property<Boolean> = objects.property(Boolean::class.java).convention(true) | ||||||
|
Contributor
There was a problem hiding this comment. aren't we going to have different optimizations? like properties, manifest and this one? Will they all be gated behind the same flag? |
||||||
| } | ||||||
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 |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| package io.sentry.android.gradle.instrumentation | ||
|
|
||
| import org.objectweb.asm.ClassVisitor | ||
| import org.objectweb.asm.FieldVisitor | ||
| import org.objectweb.asm.MethodVisitor | ||
| import org.objectweb.asm.Opcodes | ||
|
|
||
| internal class LoadClassClassVisitor( | ||
|
Contributor
There was a problem hiding this comment. I think a small javadoc on this one would be helpful |
||
| apiVersion: Int, | ||
| nextClassVisitor: ClassVisitor, | ||
| private val classAvailability: Map<String, Boolean>, | ||
| ) : ClassVisitor(apiVersion, nextClassVisitor) { | ||
| private var hasAvailabilityField = false | ||
| private var hasStaticInitializer = false | ||
|
|
||
| override fun visitField( | ||
| access: Int, | ||
| name: String?, | ||
| descriptor: String?, | ||
| signature: String?, | ||
| value: Any?, | ||
| ): FieldVisitor? { | ||
| if (name == AVAILABILITY_FIELD && descriptor == MAP_DESCRIPTOR) { | ||
| hasAvailabilityField = true | ||
| } | ||
| return super.visitField(access, name, descriptor, signature, value) | ||
| } | ||
|
|
||
| override fun visitMethod( | ||
| access: Int, | ||
| name: String?, | ||
| descriptor: String?, | ||
| signature: String?, | ||
| exceptions: Array<out String>?, | ||
| ): MethodVisitor { | ||
| val visitor = super.visitMethod(access, name, descriptor, signature, exceptions) | ||
| if (name != STATIC_INITIALIZER || descriptor != VOID_METHOD_DESCRIPTOR) { | ||
| return visitor | ||
| } | ||
|
|
||
| hasStaticInitializer = true | ||
| return object : MethodVisitor(api, visitor) { | ||
| override fun visitInsn(opcode: Int) { | ||
| if (opcode == Opcodes.RETURN && hasAvailabilityField) { | ||
| injectClassAvailability(this) | ||
| } | ||
| super.visitInsn(opcode) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun visitEnd() { | ||
| if (hasAvailabilityField && !hasStaticInitializer) { | ||
| val visitor = | ||
| super.visitMethod( | ||
| Opcodes.ACC_STATIC, | ||
| STATIC_INITIALIZER, | ||
| VOID_METHOD_DESCRIPTOR, | ||
| null, | ||
| null, | ||
| ) | ||
| visitor.visitCode() | ||
| injectClassAvailability(visitor) | ||
| visitor.visitInsn(Opcodes.RETURN) | ||
| // Triggers ASM frame/max computation; arguments are ignored in compute mode. | ||
| visitor.visitMaxs(0, 0) | ||
| visitor.visitEnd() | ||
| } | ||
| super.visitEnd() | ||
| } | ||
|
|
||
| private fun injectClassAvailability(visitor: MethodVisitor) { | ||
| visitor.visitTypeInsn(Opcodes.NEW, HASH_MAP_NAME) | ||
| visitor.visitInsn(Opcodes.DUP) | ||
| visitor.visitMethodInsn(Opcodes.INVOKESPECIAL, HASH_MAP_NAME, "<init>", "()V", false) | ||
| visitor.visitFieldInsn( | ||
| Opcodes.PUTSTATIC, | ||
| LOAD_CLASS_INTERNAL_NAME, | ||
| AVAILABILITY_FIELD, | ||
| MAP_DESCRIPTOR, | ||
| ) | ||
|
|
||
| classAvailability.forEach { (className, available) -> | ||
| visitor.visitFieldInsn( | ||
| Opcodes.GETSTATIC, | ||
| LOAD_CLASS_INTERNAL_NAME, | ||
| AVAILABILITY_FIELD, | ||
| MAP_DESCRIPTOR, | ||
| ) | ||
| visitor.visitLdcInsn(className) | ||
| visitor.visitInsn(if (available) Opcodes.ICONST_1 else Opcodes.ICONST_0) | ||
| visitor.visitMethodInsn( | ||
| Opcodes.INVOKESTATIC, | ||
| "java/lang/Boolean", | ||
| "valueOf", | ||
| "(Z)Ljava/lang/Boolean;", | ||
| false, | ||
| ) | ||
| visitor.visitMethodInsn( | ||
| Opcodes.INVOKEINTERFACE, | ||
| "java/util/Map", | ||
| "put", | ||
| "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;", | ||
| true, | ||
| ) | ||
| visitor.visitInsn(Opcodes.POP) | ||
| } | ||
| } | ||
|
|
||
| private companion object { | ||
| const val LOAD_CLASS_INTERNAL_NAME = "io/sentry/util/LoadClass" | ||
| const val AVAILABILITY_FIELD = "classAvailability" | ||
| const val MAP_DESCRIPTOR = "Ljava/util/Map;" | ||
| const val HASH_MAP_NAME = "java/util/HashMap" | ||
| const val STATIC_INITIALIZER = "<clinit>" | ||
| const val VOID_METHOD_DESCRIPTOR = "()V" | ||
| } | ||
| } | ||
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 |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| package io.sentry.android.gradle.instrumentation | ||
|
|
||
| import com.android.build.api.instrumentation.AsmClassVisitorFactory | ||
| import com.android.build.api.instrumentation.ClassContext | ||
| import com.android.build.api.instrumentation.ClassData | ||
| import com.android.build.api.instrumentation.InstrumentationParameters | ||
| import io.sentry.android.gradle.services.SentryModulesService | ||
| import io.sentry.android.gradle.util.SentryModules | ||
| import org.gradle.api.artifacts.ModuleIdentifier | ||
| import org.gradle.api.internal.artifacts.DefaultModuleIdentifier | ||
| import org.gradle.api.provider.Property | ||
| import org.gradle.api.tasks.Internal | ||
| import org.objectweb.asm.ClassVisitor | ||
|
|
||
| abstract class SentrySdkOptimizationClassVisitorFactory : | ||
| AsmClassVisitorFactory<SentrySdkOptimizationClassVisitorFactory.SdkOptimizationParameters> { | ||
|
|
||
| interface SdkOptimizationParameters : InstrumentationParameters { | ||
| @get:Internal val sentryModulesService: Property<SentryModulesService> | ||
| } | ||
|
|
||
| override fun createClassVisitor( | ||
| classContext: ClassContext, | ||
| nextClassVisitor: ClassVisitor, | ||
| ): ClassVisitor { | ||
| val service = parameters.get().sentryModulesService.get() | ||
| val modules = service.sentryModules.keys + service.externalModules.keys | ||
| return LoadClassClassVisitor( | ||
| instrumentationContext.apiVersion.get(), | ||
| nextClassVisitor, | ||
| resolveClassAvailability(modules), | ||
|
There was a problem hiding this comment. Variants share mutable module stateMedium Severity All variants register and write into one Additional Locations (1)  Reviewed by Cursor Bugbot for commit 94d96e4. Configure here. |
||
| ) | ||
|
There was a problem hiding this comment. Stale availability after dependency changesHigh Severity
Additional Locations (1)Reviewed by Cursor Bugbot for commit 94d96e4. Configure here. |
||
| } | ||
|
|
||
| override fun isInstrumentable(classData: ClassData): Boolean = | ||
| classData.className == LOAD_CLASS_NAME | ||
|
|
||
| internal companion object { | ||
| const val LOAD_CLASS_NAME = "io.sentry.util.LoadClass" | ||
|
|
||
| val CLASS_MODULES: Map<String, Set<ModuleIdentifier>> = | ||
| sortedMapOf( | ||
| "androidx.compose.ui.node.Owner" to | ||
| setOf(module("androidx.compose.ui", "ui"), module("androidx.compose.ui", "ui-android")), | ||
| "androidx.core.view.ScrollingView" to setOf(module("androidx.core", "core")), | ||
| "androidx.fragment.app.FragmentManager\$FragmentLifecycleCallbacks" to | ||
| setOf(module("androidx.fragment", "fragment")), | ||
| "androidx.lifecycle.Lifecycle" to | ||
| setOf( | ||
| module("androidx.lifecycle", "lifecycle-common"), | ||
| module("androidx.lifecycle", "lifecycle-common-jvm"), | ||
| ), | ||
| "io.sentry.android.distribution.DistributionIntegration" to | ||
| setOf(SentryModules.SENTRY_ANDROID_DISTRIBUTION), | ||
| "io.sentry.android.fragment.FragmentLifecycleIntegration" to | ||
| setOf(SentryModules.SENTRY_ANDROID_FRAGMENT), | ||
| "io.sentry.android.replay.ReplayIntegration" to setOf(SentryModules.SENTRY_ANDROID_REPLAY), | ||
| "io.sentry.android.timber.SentryTimberIntegration" to | ||
| setOf(SentryModules.SENTRY_ANDROID_TIMBER), | ||
| "io.sentry.compose.gestures.ComposeGestureTargetLocator" to | ||
| setOf(SentryModules.SENTRY_ANDROID_COMPOSE, module("io.sentry", "sentry-compose")), | ||
| "io.sentry.compose.viewhierarchy.ComposeViewHierarchyExporter" to | ||
| setOf(SentryModules.SENTRY_ANDROID_COMPOSE, module("io.sentry", "sentry-compose")), | ||
| "timber.log.Timber" to setOf(module("com.jakewharton.timber", "timber")), | ||
| ) | ||
|
|
||
| private fun module(group: String, name: String): ModuleIdentifier = | ||
| DefaultModuleIdentifier.newId(group, name) | ||
| } | ||
| } | ||
|
|
||
| internal fun resolveClassAvailability(modules: Set<ModuleIdentifier>): Map<String, Boolean> = | ||
| SentrySdkOptimizationClassVisitorFactory.CLASS_MODULES.mapValues { (_, owners) -> | ||
| owners.any { it in modules } | ||
| } | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good to delete this. this is false, build services are not kept across builds.