perf(instrumentation): Inject manifest metadata at build time #1401
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,72 @@ | ||
| package io.sentry.android.gradle | ||
|
|
||
| import java.io.File | ||
| import javax.xml.parsers.DocumentBuilderFactory | ||
| import org.w3c.dom.Element | ||
|
|
||
| internal object ManifestMetadataParser { | ||
| fun parse(manifest: File): Map<String, Any>? = | ||
| runCatching { | ||
| val document = | ||
| manifest.inputStream().buffered().use { | ||
| DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(it) | ||
| } | ||
| val application = | ||
| document.getElementsByTagName(TAG_APPLICATION).item(0) ?: return emptyMap() | ||
| val metadata = linkedMapOf<String, Any>() | ||
|
|
||
| for (index in 0 until application.childNodes.length) { | ||
| val element = application.childNodes.item(index) as? Element ?: continue | ||
| if (element.tagName != TAG_META_DATA) continue | ||
|
|
||
| val name = element.getAttribute(ATTR_NAME) | ||
| if (!name.startsWith(SENTRY_PREFIX)) continue | ||
| val value = element.getAttribute(ATTR_VALUE) | ||
| if ( | ||
| element.hasAttribute(ATTR_RESOURCE) || | ||
| !element.hasAttribute(ATTR_VALUE) || | ||
| value.startsWith("@") || | ||
| value.contains("${'$'}{") | ||
| ) { | ||
| SentryPlugin.logger.info( | ||
| "Sentry manifest metadata was not optimized because $name could not be resolved at build time." | ||
| ) | ||
| return null | ||
| } | ||
| metadata[name] = inferType(value) | ||
| } | ||
| metadata | ||
| } | ||
| .onFailure { | ||
| SentryPlugin.logger.info( | ||
| "Sentry manifest metadata could not be parsed for optimization.", | ||
| it, | ||
| ) | ||
| } | ||
| .getOrNull() | ||
|
|
||
| internal fun inferType(value: String): Any = | ||
| when (value) { | ||
| "true" -> true | ||
| "false" -> false | ||
| else -> parseInteger(value) ?: value.toFloatOrNull() ?: value | ||
| } | ||
|
|
||
| private fun parseInteger(value: String): Int? = | ||
| if (value.matches(DECIMAL_INTEGER)) { | ||
| value.toIntOrNull() | ||
| } else if (value.matches(HEX_INTEGER)) { | ||
| value.removePrefix("+").let { Integer.decode(it) } | ||
| } else { | ||
| null | ||
| } | ||
|
|
||
| private const val TAG_APPLICATION = "application" | ||
| private const val TAG_META_DATA = "meta-data" | ||
| private const val ATTR_NAME = "android:name" | ||
| private const val ATTR_VALUE = "android:value" | ||
| private const val ATTR_RESOURCE = "android:resource" | ||
| private const val SENTRY_PREFIX = "io.sentry." | ||
| private val DECIMAL_INTEGER = Regex("[+-]?\\d+") | ||
| private val HEX_INTEGER = Regex("[+-]?0[xX][0-9a-fA-F]+") | ||
| } |
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,142 @@ | ||
| package io.sentry.android.gradle.instrumentation | ||
|
|
||
| import io.sentry.android.gradle.SentryPlugin | ||
| import org.objectweb.asm.ClassVisitor | ||
| import org.objectweb.asm.FieldVisitor | ||
| import org.objectweb.asm.MethodVisitor | ||
| import org.objectweb.asm.Opcodes | ||
|
|
||
| /** Injects fully resolved build-time manifest metadata into `ManifestMetadataReader`. */ | ||
| internal class ManifestMetadataClassVisitor( | ||
| apiVersion: Int, | ||
| nextClassVisitor: ClassVisitor, | ||
| private val metadata: Map<String, Any>, | ||
| ) : ClassVisitor(apiVersion, nextClassVisitor) { | ||
| private var hasMetadataField = false | ||
| private var hasStaticInitializer = false | ||
|
|
||
| override fun visitField( | ||
| access: Int, | ||
| name: String?, | ||
| descriptor: String?, | ||
| signature: String?, | ||
| value: Any?, | ||
| ): FieldVisitor? { | ||
| if (name == METADATA_FIELD && descriptor == MAP_DESCRIPTOR) hasMetadataField = 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 && hasMetadataField) injectMetadata(this) | ||
| super.visitInsn(opcode) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun visitEnd() { | ||
| if (!hasMetadataField) { | ||
| SentryPlugin.logger.info( | ||
| "Sentry manifest metadata was not optimized because the current SDK version does not support this optimization." | ||
| ) | ||
| } | ||
| if (hasMetadataField && !hasStaticInitializer) { | ||
| val visitor = | ||
| super.visitMethod( | ||
| Opcodes.ACC_STATIC, | ||
| STATIC_INITIALIZER, | ||
| VOID_METHOD_DESCRIPTOR, | ||
| null, | ||
| null, | ||
| ) | ||
| visitor.visitCode() | ||
| injectMetadata(visitor) | ||
| visitor.visitInsn(Opcodes.RETURN) | ||
| visitor.visitMaxs(0, 0) | ||
| visitor.visitEnd() | ||
| } | ||
| super.visitEnd() | ||
| } | ||
|
|
||
| private fun injectMetadata(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, READER_INTERNAL_NAME, METADATA_FIELD, MAP_DESCRIPTOR) | ||
|
|
||
| metadata.forEach { (key, value) -> | ||
| visitor.visitFieldInsn( | ||
| Opcodes.GETSTATIC, | ||
| READER_INTERNAL_NAME, | ||
| METADATA_FIELD, | ||
| MAP_DESCRIPTOR, | ||
| ) | ||
| visitor.visitLdcInsn(key) | ||
| visitor.emitValue(value) | ||
| visitor.visitMethodInsn( | ||
| Opcodes.INVOKEINTERFACE, | ||
| "java/util/Map", | ||
| "put", | ||
| "(Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;", | ||
| true, | ||
| ) | ||
| visitor.visitInsn(Opcodes.POP) | ||
| } | ||
| } | ||
|
|
||
| private fun MethodVisitor.emitValue(value: Any) { | ||
| when (value) { | ||
| is Boolean -> { | ||
| visitInsn(if (value) Opcodes.ICONST_1 else Opcodes.ICONST_0) | ||
| visitMethodInsn( | ||
| Opcodes.INVOKESTATIC, | ||
| "java/lang/Boolean", | ||
| "valueOf", | ||
| "(Z)Ljava/lang/Boolean;", | ||
| false, | ||
| ) | ||
| } | ||
| is Int -> { | ||
| visitLdcInsn(value) | ||
| visitMethodInsn( | ||
| Opcodes.INVOKESTATIC, | ||
| "java/lang/Integer", | ||
| "valueOf", | ||
| "(I)Ljava/lang/Integer;", | ||
| false, | ||
| ) | ||
| } | ||
| is Float -> { | ||
| visitLdcInsn(value) | ||
| visitMethodInsn( | ||
| Opcodes.INVOKESTATIC, | ||
| "java/lang/Float", | ||
| "valueOf", | ||
| "(F)Ljava/lang/Float;", | ||
| false, | ||
| ) | ||
| } | ||
| is String -> visitLdcInsn(value) | ||
| } | ||
| } | ||
|
|
||
| private companion object { | ||
| const val READER_INTERNAL_NAME = "io/sentry/android/core/ManifestMetadataReader" | ||
| const val METADATA_FIELD = "buildTimeMetadata" | ||
| 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
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.
Shared cache key reuses injected metadata
High Severity
buildTimeMetadataCacheKeynow comes fromSentryModulesService, a singleregisterIfAbsentbuild service shared by every project and variant. The isolation key is therefore identical across apps and flavors, so AGP can reuseManifestMetadataReaderbytecode injected for a different variant. Product flavors and debug/release often have differentio.sentry.*metadata, including DSNs.Additional Locations (1)
plugin-build/src/main/kotlin/io/sentry/android/gradle/services/SentryModulesService.kt#L25-L26Reviewed by Cursor Bugbot for commit 0d32407. Configure here.