[kotlin][debugger] Introduce Kotin class metadata helper #2951
Conversation
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
Kotlin compiler stores meta information about every class in the `kotlin.Metadata` annotation. Unfortunately, there is no way to fetch this annotation using plain JDI interface, because unlike method information, class annotations are not exposed to the debugger. This commit adds a helper class that allows fetching `kotlin.Metadata` of a specific class as a JSON string.
nikita-nazarov
commented
Feb 20, 2025
|
|
||
| @ApiStatus.Internal | ||
| @Service(Service.Level.PROJECT) | ||
| class KotlinMetadataDebuggerCacheService private constructor(project: Project) { |
There was a problem hiding this comment.
Is it an ok implementation of a cache? Or should I use like something like this instead:
val cache = vmProxy.getOrCreateUserData(METADATA_CACHE_KEY) {
KotlinMetadataCache(debugProcess)
}
There was a problem hiding this comment.
Caching in vmProxy is better
…etadata Previously, evaluatable getters in the variables view of the Kotlin debugger relied on a filtering heuristic that inspected bytecode of each getter. Unfortunately, such filtering was incorrect in some cases. Moreover the filtering was disabled completely in the Android Studio debugger, because method bytecode is not available there. This commit reimplements filtering of evaluatable getters by using Kotlin class metadata, fetched by `MetadataDebugHelper`.
nikita-nazarov
force-pushed
the
nazarov/kotlin-class-metadata
branch
from
6845674 to
681d8bd
Compare
zuevmaxim
reviewed
Feb 21, 2025
| return sb.append(toJson(name)).append(':').append(value); | ||
| } | ||
|
|
||
| private static String toJson(String str) { |
There was a problem hiding this comment.
Is it similar to com.intellij.rt.debugger.coroutines.JsonUtils#escapeJsonString?
There was a problem hiding this comment.
Make sure you load JsonUtils if you rely on it
zuevmaxim
reviewed
Feb 21, 2025
| .distinctBy { it.name() } | ||
| } | ||
|
|
||
| private fun calculateGettersToShow(methods: List<Method>, context: EvaluationContext): Set<String>? { |
There was a problem hiding this comment.
Could you please use UsingMetadata suffix here also?
zuevmaxim
reviewed
Feb 21, 2025
| } | ||
| } | ||
|
|
||
| private fun <T> wrapJsonSyntaxException(block: () -> T): T? { |
There was a problem hiding this comment.
inline? Just because we can
zuevmaxim
requested changes
Feb 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull requests introduces
MetadataDebugHelper- a helper class that allows fetching Kotlin class metadata in the debugger.Also, "evaluatable getters" filtering is reimplemented using the mentioned helper class. Unfortunately the new implementation of filtering is slower than the previous one that relied on bytecode inspections:
However, at the same time the new implementation allows the debugger to filter out getters like:
Which were previously shown. And show getters like:
Which were previously filtered out.