-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create SnapshotsPreviewRuntimeRetentionTransform to change Previews to runtime retention #139
Merged
rbro112
merged 1 commit into
main
from
ryan/create_snapshotspreviewruntimeretentiontransform_to_change_previews_to_runtime_retention
May 17, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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
102 changes: 102 additions & 0 deletions
102
...ols/android/gradle/instrumentation/snapshots/SnapshotsPreviewRuntimeRetentionTransform.kt
This file contains 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,102 @@ | ||
| package com.emergetools.android.gradle.instrumentation.snapshots | ||
|
|
||
| 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 org.gradle.api.provider.Property | ||
| import org.gradle.api.tasks.Input | ||
| import org.objectweb.asm.AnnotationVisitor | ||
| import org.objectweb.asm.ClassVisitor | ||
| import org.objectweb.asm.MethodVisitor | ||
| import org.slf4j.Logger | ||
| import org.slf4j.LoggerFactory | ||
|
|
||
| abstract class SnapshotsPreviewRuntimeRetentionTransformFactory : AsmClassVisitorFactory<SnapshotsPreviewRuntimeRetentionTransformFactory.Params> { | ||
|
|
||
| interface Params : InstrumentationParameters { | ||
| @get:Input | ||
| val invalidate: Property<Long> | ||
| } | ||
|
|
||
| companion object { | ||
| private val logger by lazy { | ||
| LoggerFactory.getLogger(SnapshotsPreviewRuntimeRetentionTransformFactory::class.java) | ||
| } | ||
| } | ||
|
|
||
| override fun createClassVisitor( | ||
| classContext: ClassContext, | ||
| nextClassVisitor: ClassVisitor, | ||
| ): ClassVisitor { | ||
| return SnapshotsPreviewRuntimeRetentionTransform( | ||
| instrumentationContext.apiVersion.get(), | ||
| nextClassVisitor, | ||
| logger, | ||
| ) | ||
| } | ||
|
|
||
| override fun isInstrumentable(classData: ClassData): Boolean { | ||
| // Need to instrument all classes to ensure that the annotations are visible at runtime | ||
| return true | ||
| } | ||
| } | ||
|
|
||
| class SnapshotsPreviewRuntimeRetentionTransform( | ||
| api: Int, | ||
| classVisitor: ClassVisitor?, | ||
| private val logger: Logger, | ||
| ) : ClassVisitor(api, classVisitor) { | ||
|
|
||
| companion object { | ||
| const val TAG = "SnapshotRuntimePreviewClassVisitor" | ||
|
|
||
| const val PREVIEW_ANNOTATION_DESC = "Landroidx/compose/ui/tooling/preview/Preview;" | ||
| const val PREVIEW_CONTAINER_ANNOTATION_DESC = | ||
| "Landroidx/compose/ui/tooling/preview/Preview\$Container;" | ||
| } | ||
|
|
||
| override fun visitMethod( | ||
| access: Int, | ||
| name: String, | ||
| descriptor: String, | ||
| signature: String?, | ||
| exceptions: Array<String>?, | ||
| ): MethodVisitor { | ||
| val mv = super.visitMethod(access, name, descriptor, signature, exceptions) | ||
|
|
||
| return object : MethodVisitor(api, mv) { | ||
| override fun visitAnnotation( | ||
| desc: String, | ||
| visible: Boolean, | ||
| ): AnnotationVisitor? { | ||
| if (desc == PREVIEW_ANNOTATION_DESC || desc == PREVIEW_CONTAINER_ANNOTATION_DESC) { | ||
| logger.info( | ||
| "$TAG: Modifying method annotation visible at runtime to true for annotation $desc $visible" | ||
| ) | ||
|
|
||
| // Force the annotation to be visible at runtime | ||
| return super.visitAnnotation(desc, true) | ||
| } | ||
|
|
||
| return super.visitAnnotation(desc, visible) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override fun visitAnnotation( | ||
| desc: String, | ||
| visible: Boolean, | ||
| ): AnnotationVisitor? { | ||
| if (desc == PREVIEW_ANNOTATION_DESC || desc == PREVIEW_CONTAINER_ANNOTATION_DESC) { | ||
| logger.info( | ||
| "$TAG: Modifying class annotation visible at runtime to true for annotation $desc $visible" | ||
| ) | ||
|
|
||
| // Force the annotation to be visible at runtime | ||
| return super.visitAnnotation(desc, true) | ||
| } | ||
|
|
||
| return super.visitAnnotation(desc, visible) | ||
| } | ||
| } | ||
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.
What's the need for this? Does the other
override fun visitAnnotation()not cover all cases?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.
Nope, that will only cover the annotations on the class-level. We need a separate method visitor to visit the annotations on each method, which is what this is doing.
Without this, we'd just be marking class-level Preview annotations as runtime, instead of class and method level which is what we want.
The class annotation visitor handles multipreview annotation classes that have the preview annotation, and the method annotation visitor handles actual preview methods annotated with Preview.